atkmm: Atk::Hypertext Class Reference

atkmm 2.36.0

#include <atkmm/hypertext.h>

Inheritance diagram for Atk::Hypertext:

[legend]

Public Member Functions
	Hypertext (Hypertext&& src) noexcept

Hypertext&	operator= (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< Hyperlink >	get_link (int link_index)
	Gets the link in this hypertext document at index link_index. More...

Glib::RefPtr< const Hyperlink >	get_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< Hyperlink >	get_link_vfunc (int link_index)

virtual int	get_n_links_vfunc () const

virtual int	get_link_index_vfunc (int char_index) const

Public Member Functions inherited from Glib::Interface
	Interface ()

	Interface (Interface &&src) noexcept

Interface &	operator= (Interface &&src) noexcept

	Interface (const Glib::Interface_Class &interface_class)

	Interface (GObject *castitem)

	~Interface () noexcept override

	Interface (const Interface &)=delete

Interface &	operator= (const Interface &)=delete

GObject *	gobj ()

const GObject *	gobj () const

Public Member Functions inherited from Glib::ObjectBase
	ObjectBase (const ObjectBase &)=delete

ObjectBase &	operator= (const ObjectBase &)=delete

void	set_property_value (const Glib::ustring &property_name, const Glib::ValueBase &value)

void	get_property_value (const Glib::ustring &property_name, Glib::ValueBase &value) const

void	set_property (const Glib::ustring &property_name, const PropertyType &value)

void	get_property (const Glib::ustring &property_name, PropertyType &value) const

PropertyType	get_property (const Glib::ustring &property_name) const

sigc::connection	connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)

sigc::connection	connect_property_changed (const Glib::ustring &property_name, sigc::slot< void()> &&slot)

void	freeze_notify ()

void	thaw_notify ()

virtual void	reference () const

virtual void	unreference () const

GObject *	gobj ()

const GObject *	gobj () const

GObject *	gobj_copy () const

Public Member Functions inherited from sigc::trackable
	trackable () noexcept

	trackable (const trackable &src) noexcept

	trackable (trackable &&src) noexcept

	~trackable ()

void	add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const

void	notify_callbacks ()

trackable &	operator= (const trackable &src)

trackable &	operator= (trackable &&src) noexcept

void	remove_destroy_notify_callback (notifiable *data) 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...

Protected Member Functions inherited from Glib::ObjectBase
	ObjectBase ()

	ObjectBase (const char *custom_type_name)

	ObjectBase (const std::type_info &custom_type_info)

	ObjectBase (ObjectBase &&src) noexcept

ObjectBase &	operator= (ObjectBase &&src) noexcept

virtual	~ObjectBase () noexcept=0

void	initialize (GObject *castitem)

void	initialize_move (GObject castitem, Glib::ObjectBase previous_wrapper)

Related Functions
(Note that these are not member functions.)
Glib::RefPtr< Atk::Hypertext >	wrap (AtkHypertext* object, bool take_copy=false)
	A Glib::wrap() method for this object. More...

Additional Inherited Members
Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify	func_destroy_notify

Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify	func_destroy_notify

Constructor & Destructor Documentation

Atk::Hypertext::Hypertext ( )

protected

You should derive from this class to use it.

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

noexcept

Atk::Hypertext::~Hypertext ( )

overridenoexcept

Member Function Documentation

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

static

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.

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.

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_index A character index.

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

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

virtual

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

virtual

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.

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

virtual

static GType Atk::Hypertext::get_type ( )

static

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

AtkHypertext* Atk::Hypertext::gobj ( )

inline

Provides access to the underlying C GObject.

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

inline

Provides access to the underlying C GObject.

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

protectedvirtual

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

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

noexcept

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_index The index of the hyperlink which is selected.

Friends And Related Function Documentation

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

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

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Functions

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation