|
atkmm
2.22.7
|
Encapsulates a link or set of links in a hypertext document. More...
#include <atkmm/hyperlink.h>

Public Member Functions | |
| AtkHyperlink* | gobj () |
| Provides access to the underlying C GObject. | |
| const AtkHyperlink* | gobj () const |
| Provides access to the underlying C GObject. | |
| AtkHyperlink* | gobj_copy () |
| Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
| Glib::ustring | get_uri (int i) const |
| Get a the URI associated with the anchor specified by i of link. More... | |
| Glib::RefPtr< Atk::Object > | get_object (int i) |
| Returns the item associated with this hyperlinks nth anchor. More... | |
| Glib::RefPtr< const Atk::Object > | get_object (int i) const |
| Returns the item associated with this hyperlinks nth anchor. More... | |
| int | get_end_index () const |
| Gets the index with the hypertext document at which this link ends. More... | |
| int | get_start_index () const |
| Gets the index with the hypertext document at which this link begins. More... | |
| bool | is_valid () const |
Since the document that a link is associated with may have changed this method returns true if the link is still valid (with respect to the document it references) and false otherwise. More... | |
| bool | is_inline () const |
| Indicates whether the link currently displays some or all of its content inline. More... | |
| int | get_n_anchors () const |
| Gets the number of anchors associated with this hyperlink. More... | |
| Glib::SignalProxy0< void > | signal_link_activated () |
| Glib::PropertyProxy_ReadOnly < bool > | property_selected_link () const |
| Specifies whether the AtkHyperlink object is selected. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_number_of_anchors () const |
| The number of anchors associated with the AtkHyperlink object. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_end_index () const |
| The end index of the AtkHyperlink object. More... | |
| Glib::PropertyProxy_ReadOnly< int > | property_start_index () const |
| The start index of the AtkHyperlink object. More... | |
Public Member Functions inherited from Atk::Action | |
| AtkAction* | gobj () |
| Provides access to the underlying C GObject. | |
| const AtkAction* | gobj () const |
| Provides access to the underlying C GObject. | |
| bool | do_action (int i) |
| Perform the specified action on the object. More... | |
| int | get_n_actions () const |
| Gets the number of accessible actions available on the object. More... | |
| Glib::ustring | get_description (int i) const |
| Returns a description of the specified action of the object. More... | |
| Glib::ustring | get_name (int i) const |
| Returns the name of the specified action of the object. More... | |
| Glib::ustring | get_keybinding (int i) |
| Returns a keybinding associated with this action, if one exists. More... | |
| bool | set_description (int i, const Glib::ustring& desc) |
| Sets a description of the specified action of the object. More... | |
| Glib::ustring | get_localized_name (int i) |
| Returns the localized name of the specified action of the object. More... | |
Static Public Member Functions | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. | |
Static Public Member Functions inherited from Atk::Action | |
| static GType | get_type () |
| Get the GType for this class, for use with the underlying GObject type system. | |
Protected Member Functions | |
| virtual void | on_link_activated () |
| This is a default handler for the signal signal_link_activated(). | |
Protected Member Functions inherited from Atk::Action | |
| Action () | |
| You should derive from this class to use it. | |
Related Functions | |
(Note that these are not member functions.) | |
| Glib::RefPtr< Atk::Hyperlink > | wrap (AtkHyperlink* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Related Functions inherited from Atk::Action | |
| Glib::RefPtr< Atk::Action > | wrap (AtkAction* object, bool take_copy=false) |
| A Glib::wrap() method for this object. More... | |
Encapsulates a link or set of links in a hypertext document.
| int Atk::Hyperlink::get_end_index | ( | ) | const |
Gets the index with the hypertext document at which this link ends.
| int Atk::Hyperlink::get_n_anchors | ( | ) | const |
Gets the number of anchors associated with this hyperlink.
| Glib::RefPtr<Atk::Object> Atk::Hyperlink::get_object | ( | int | i | ) |
Returns the item associated with this hyperlinks nth anchor.
For instance, the returned Atk::Object will implement Atk::Text if link is a text hyperlink, Atk::Image if link is an image hyperlink etc.
Multiple anchors are primarily used by client-side image maps.
| i | A (zero-index) integer specifying the desired anchor. |
| Glib::RefPtr<const Atk::Object> Atk::Hyperlink::get_object | ( | int | i | ) | const |
Returns the item associated with this hyperlinks nth anchor.
For instance, the returned Atk::Object will implement Atk::Text if link is a text hyperlink, Atk::Image if link is an image hyperlink etc.
Multiple anchors are primarily used by client-side image maps.
| i | A (zero-index) integer specifying the desired anchor. |
| int Atk::Hyperlink::get_start_index | ( | ) | const |
Gets the index with the hypertext document at which this link begins.
| Glib::ustring Atk::Hyperlink::get_uri | ( | int | i | ) | const |
Get a the URI associated with the anchor specified by i of link.
Multiple anchors are primarily used by client-side image maps.
| i | A (zero-index) integer specifying the desired anchor. |
| bool Atk::Hyperlink::is_inline | ( | ) | const |
Indicates whether the link currently displays some or all of its content inline.
Ordinary HTML links will usually return false, but an inline <src> HTML element will return true. a *
| bool Atk::Hyperlink::is_valid | ( | ) | const |
Since the document that a link is associated with may have changed this method returns true if the link is still valid (with respect to the document it references) and false otherwise.
| Glib::PropertyProxy_ReadOnly< int > Atk::Hyperlink::property_end_index | ( | ) | const |
The end index of the AtkHyperlink object.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< int > Atk::Hyperlink::property_number_of_anchors | ( | ) | const |
The number of anchors associated with the AtkHyperlink object.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< bool > Atk::Hyperlink::property_selected_link | ( | ) | const |
Specifies whether the AtkHyperlink object is selected.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::PropertyProxy_ReadOnly< int > Atk::Hyperlink::property_start_index | ( | ) | const |
The start index of the AtkHyperlink object.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
| Glib::SignalProxy0< void > Atk::Hyperlink::signal_link_activated | ( | ) |
void on_my_link_activated()
|
related |
A Glib::wrap() method for this object.
| 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. |
1.8.3.1