atkmm
2.36.1
|
An Atk::Relation describes a relation between an object and one or more other objects. More...
#include <atkmm/relation.h>
Public Types | |
enum class | Type { NONE , CONTROLLED_BY , CONTROLLER_FOR , LABEL_FOR , LABELLED_BY , MEMBER_OF , NODE_CHILD_OF , FLOWS_TO , FLOWS_FROM , SUBWINDOW_OF , EMBEDS , EMBEDDED_BY , POPUP_FOR , PARENT_WINDOW_OF , DESCRIBED_BY , DESCRIPTION_FOR , NODE_PARENT_OF , DETAILS , DETAILS_FOR , ERROR_MESSAGE , ERROR_FOR , LAST_DEFINED } |
Describes the type of the relation. More... | |
Public Member Functions | |
Relation (Relation&& src) noexcept | |
Relation& | operator= (Relation&& src) noexcept |
~Relation () noexcept override | |
AtkRelation* | gobj () |
Provides access to the underlying C GObject. More... | |
const AtkRelation* | gobj () const |
Provides access to the underlying C GObject. More... | |
AtkRelation* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
Type | get_relation_type () const |
Gets the type of relation. More... | |
std::vector< Glib::RefPtr< Atk::Object > > | get_target () |
std::vector< Glib::RefPtr< const Atk::Object > > | get_target () const |
void | add_target (const Glib::RefPtr< Atk::Object >& target) |
Adds the specified AtkObject to the target for the relation, if it is not already present. More... | |
Static Public Member Functions | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Glib::RefPtr< Relation > | create (const std::vector< Glib::RefPtr< Atk::Object >>& targets, Type relationship=Type::NONE) |
Protected Member Functions | |
Relation (const std::vector< Glib::RefPtr< Atk::Object >>& targets, Relation::Type relationship) | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Atk::Relation > | wrap (AtkRelation* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
An Atk::Relation describes a relation between an object and one or more other objects.
The actual relations that an object has with other objects are defined as an Atk::RelationSet, which is a set of Atk::Relations.
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
void Atk::Relation::add_target | ( | const Glib::RefPtr< Atk::Object >& | target | ) |
Adds the specified AtkObject to the target for the relation, if it is not already present.
See also Atk::Object::add_relationship().
target | An Atk::Object. |
|
static |
Type Atk::Relation::get_relation_type | ( | ) | const |
Gets the type of relation.
std::vector<Glib::RefPtr<Atk::Object> > Atk::Relation::get_target | ( | ) |
std::vector<Glib::RefPtr<const Atk::Object> > Atk::Relation::get_target | ( | ) | const |
|
static |
Get the GType for this class, for use with the underlying GObject type system.
|
inline |
Provides access to the underlying C GObject.
|
inline |
Provides access to the underlying C GObject.
AtkRelation* Atk::Relation::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
|
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. |