atkmm 2.28.3
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Atk::Hypertext Class Reference

#include <atkmm/hypertext.h>

Inheritance diagram for Atk::Hypertext:
Inheritance graph
[legend]

Public Member Functions

 Hypertext (Hypertext && src) noexcept
 
Hypertextoperator= (Hypertext && src) noexcept
 
 ~Hypertext () noexcept override
 
AtkHypertext * gobj ()
 Provides access to the underlying C GObject. More...
 
const AtkHypertext * gobj () const
 Provides access to the underlying C GObject. More...
 
Glib::RefPtr< Hyperlinkget_link (int link_index)
 Gets the link in this hypertext document at index link_index. More...
 
Glib::RefPtr< const Hyperlinkget_link (int link_index) const
 Gets the link in this hypertext document at index link_index. More...
 
int get_n_links () const
 Gets the number of links within this hypertext document. More...
 
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. More...
 
Glib::SignalProxy< void, int > signal_link_selected ()
 
virtual Glib::RefPtr< Hyperlinkget_link_vfunc (int link_index)
 
virtual int get_n_links_vfunc () const
 
virtual int get_link_index_vfunc (int char_index) const
 

Static Public Member Functions

static void add_interface (GType gtype_implementer)
 
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...
 

Protected Member Functions

 Hypertext ()
 You should derive from this class to use it. More...
 
virtual void on_link_selected (int link_index)
 This is a default handler for the signal signal_link_selected(). More...
 

Related Functions

(Note that these are not member functions.)

Glib::RefPtr< Atk::Hypertextwrap (AtkHypertext * object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Constructor & Destructor Documentation

◆ Hypertext() [1/2]

Atk::Hypertext::Hypertext ( )
protected

You should derive from this class to use it.

◆ Hypertext() [2/2]

Atk::Hypertext::Hypertext ( Hypertext &&  src)
noexcept

◆ ~Hypertext()

Atk::Hypertext::~Hypertext ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

static void Atk::Hypertext::add_interface ( GType  gtype_implementer)
static

◆ get_link() [1/2]

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

Gets the link in this hypertext document at index link_index.

Parameters
link_indexAn integer specifying the desired link.
Returns
The link in this hypertext document at index link_index.

◆ get_link() [2/2]

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_indexAn integer specifying the desired link.
Returns
The link in this hypertext document at index link_index.

◆ get_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.

Parameters
char_indexA character index.
Returns
An index into the array of hyperlinks in hypertext, or -1 if there is no hyperlink associated with this character.

◆ get_link_index_vfunc()

virtual int Atk::Hypertext::get_link_index_vfunc ( int  char_index) const
virtual

◆ get_link_vfunc()

virtual Glib::RefPtr< Hyperlink > Atk::Hypertext::get_link_vfunc ( int  link_index)
virtual

◆ get_n_links()

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.

◆ get_n_links_vfunc()

virtual int Atk::Hypertext::get_n_links_vfunc ( ) const
virtual

◆ get_type()

static GType Atk::Hypertext::get_type ( )
static

Get the GType for this class, for use with the underlying GObject type system.

◆ gobj() [1/2]

AtkHypertext * Atk::Hypertext::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const AtkHypertext * Atk::Hypertext::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ on_link_selected()

virtual void Atk::Hypertext::on_link_selected ( int  link_index)
protectedvirtual

This is a default handler for the signal signal_link_selected().

◆ operator=()

Hypertext & Atk::Hypertext::operator= ( Hypertext &&  src)
noexcept

◆ signal_link_selected()

Glib::SignalProxy< void, int > Atk::Hypertext::signal_link_selected ( )
Slot Prototype:
void on_my_link_selected(int link_index)

Flags: Run Last

The "link-selected" signal is emitted by an AtkHyperText object when one of the hyperlinks associated with the object is selected.

Parameters
link_indexThe index of the hyperlink which is selected.

Friends And Related Function Documentation

◆ wrap()

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

A Glib::wrap() method for this object.

Parameters
objectThe C instance.
take_copyFalse 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.