gtkmm 4.21.3
Gtk::AccessibleHypertext Class Reference

An interface for accessible objects containing links. More...

#include <gtkmm/accessiblehypertext.h>

Inheritance diagram for Gtk::AccessibleHypertext:

Public Member Functions

 AccessibleHypertext (AccessibleHypertext && src) noexcept
AccessibleHypertextoperator= (AccessibleHypertext && src) noexcept
 ~AccessibleHypertext () noexcept override
GtkAccessibleHypertext * gobj ()
 Provides access to the underlying C GObject.
const GtkAccessibleHypertext * gobj () const
 Provides access to the underlying C GObject.
Public Member Functions inherited from Glib::Interface
 Interface ()
 Interface (Interface &&src) noexcept
Interfaceoperator= (Interface &&src) noexcept
 Interface (const Glib::Interface_Class &interface_class)
 Interface (GObject *castitem)
 ~Interface () noexcept override
 Interface (const Interface &)=delete
Interfaceoperator= (const Interface &)=delete
GObject * gobj ()
const GObject * gobj () const
Public Member Functions inherited from Glib::ObjectBase
 ObjectBase (const ObjectBase &)=delete
ObjectBaseoperator= (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

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.

Protected Member Functions

 AccessibleHypertext ()
 You should derive from this class to use it.
virtual unsigned int get_n_links_vfunc () const
 Retrieve the number of links in the accessible object.
virtual Glib::RefPtr< AccessibleHyperlinkget_link_vfunc (unsigned int index)
 Retrieve the n-th link in the accessible object.
virtual unsigned int get_link_at_vfunc (unsigned int offset) const
 Retrieves the index of the link at the given character offset.
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
ObjectBaseoperator= (ObjectBase &&src) noexcept
virtual ~ObjectBase () noexcept=0
void initialize (GObject *castitem)
void initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper)

(Note that these are not member symbols.)

Glib::RefPtr< Gtk::AccessibleHypertextwrap (GtkAccessibleHypertext * object, bool take_copy=false)
 A Glib::wrap() method for this object.

Detailed Description

An interface for accessible objects containing links.

The Gtk::AccessibleHypertext interface is meant to be implemented by accessible objects that contain links. Those links don't necessarily have to be part of text, they can be associated with images and other things.

Since gtkmm 4.22

Constructor & Destructor Documentation

◆ AccessibleHypertext() [1/2]

Gtk::AccessibleHypertext::AccessibleHypertext ( )
protected

You should derive from this class to use it.

◆ AccessibleHypertext() [2/2]

Gtk::AccessibleHypertext::AccessibleHypertext ( AccessibleHypertext && src)
noexcept

◆ ~AccessibleHypertext()

Gtk::AccessibleHypertext::~AccessibleHypertext ( )
overridenoexcept

Member Function Documentation

◆ add_interface()

void Gtk::AccessibleHypertext::add_interface ( GType gtype_implementer)
static

◆ get_link_at_vfunc()

virtual unsigned int Gtk::AccessibleHypertext::get_link_at_vfunc ( unsigned int offset) const
protectedvirtual

Retrieves the index of the link at the given character offset.

Note that this method will return G_MAXUINT if the object does not contain text.

Parameters
offsetThe character offset.
Returns
Index of the link at the given character offset, or G_MAXUINT if there is no link.
Since gtkmm 4.22

◆ get_link_vfunc()

virtual Glib::RefPtr< AccessibleHyperlink > Gtk::AccessibleHypertext::get_link_vfunc ( unsigned int index)
protectedvirtual

Retrieve the n-th link in the accessible object.

Parameters
indexMust be less than the number of links.
Returns
The link.
Since gtkmm 4.22

◆ get_n_links_vfunc()

virtual unsigned int Gtk::AccessibleHypertext::get_n_links_vfunc ( ) const
protectedvirtual

Retrieve the number of links in the accessible object.

Returns
The number of links.
Since gtkmm 4.22

◆ get_type()

GType Gtk::AccessibleHypertext::get_type ( )
static

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

◆ gobj() [1/2]

GtkAccessibleHypertext * Gtk::AccessibleHypertext::gobj ( )
inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkAccessibleHypertext * Gtk::AccessibleHypertext::gobj ( ) const
inline

Provides access to the underlying C GObject.

◆ operator=()

AccessibleHypertext & Gtk::AccessibleHypertext::operator= ( AccessibleHypertext && src)
noexcept

◆ wrap()

Glib::RefPtr< Gtk::AccessibleHypertext > wrap ( GtkAccessibleHypertext * 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.