Main Page Widgets Namespaces Book

# Atk::Hypertext Class Reference

Inheritance diagram for Atk::Hypertext:

[legend]
List of all members.

## Public Member Functions
Glib::RefPtr<const Hyperlink> | get_link (int link_index) const
| Gets the link in this hypertext document at index link_index.
Glib::RefPtr<Hyperlink> | get_link (int link_index)
| Gets the link in this hypertext document at index link_index.
int | get_link_index (int char_index) const
| Gets the index into the array of hyperlinks that is associated with the character specified by char_index , or -1 if there is no hyperlink associated with this character.
int | get_n_links () const
| Gets the number of links within this hypertext document.
const AtkHypertext* | gobj () const
| Provides access to the underlying C GObject.
AtkHypertext* | gobj ()
| Provides access to the underlying C GObject.
Glib::SignalProxy1< void, int > | signal_link_selected ()
virtual | ~Hypertext ()
## Static Public Member Functions
static void | add_interface (GType gtype_implementer)
## Related Functions
(Note that these are not member functions.)
Glib::RefPtr<Atk::Hypertext> | wrap (AtkHypertext* object, bool take_copy=false)

## Constructor & Destructor Documentation

virtual Atk::Hypertext::~Hypertext | ( |  | ) | `[virtual]`

## Member Function Documentation

static void Atk::Hypertext::add_interface | ( | GType | gtype_implementer | ) | `[static]`

Glib::RefPtr<const Hyperlink> Atk::Hypertext::get_link | ( | int | link_index | ) | const

  | Gets the link in this hypertext document at index link_index. Parameters:
  | link_index | An integer specifying the desired link.
Returns: The link in this hypertext document at index link_index .

Glib::RefPtr<Hyperlink> Atk::Hypertext::get_link | ( | int | link_index | ) |

  | Gets the link in this hypertext document at index link_index. Parameters:
  | link_index | An integer specifying the desired link.
Returns: The link in this hypertext document at index link_index .

int Atk::Hypertext::get_link_index | ( | int | char_index | ) | const

  | Gets the index into the array of hyperlinks that is associated with the character specified by char_index , or -1 if there is no hyperlink associated with this character. Parameters:
  | char_index | A character index.
Returns: An index into the array of hyperlinks in hypertext .

int Atk::Hypertext::get_n_links | ( |  | ) | const

| Gets the number of links within this hypertext document. Returns: The number of links within this hypertext document.

const AtkHypertext* Atk::Hypertext::gobj | ( |  | ) | const`[inline]`

| Provides access to the underlying C GObject. Reimplemented from Glib::Interface. Reimplemented in Atk::NoOpObject.

AtkHypertext* Atk::Hypertext::gobj | ( |  | ) | `[inline]`

| Provides access to the underlying C GObject. Reimplemented from Glib::Interface. Reimplemented in Atk::NoOpObject.

Glib::SignalProxy1<void,int> Atk::Hypertext::signal_link_selected | ( |  | ) |

| Prototype: `void link_selected(int link_index)`

## Friends And Related Function Documentation

Glib::RefPtr<Atk::Hypertext> wrap | ( | AtkHypertext* | object,
|  | bool | take_copy = `false`
| ) | `[related]`

  | Parameters:
  | object | The C instance
  | take_copy | False if the result should take ownership of the C instance. True if it should take a new copy or ref.
Returns: A C++ instance that wraps this C instance.

The documentation for this class was generated from the following file:

- hypertext.h