Class
AtkStateSet
Description [src]
class Atk.StateSet : GObject.Object {
parent: GObject
}An AtkStateSet is a read-only representation of the full set of AtkStates
that apply to an object at a given time. This set is not meant to be
modified, but rather created when #atk_object_ref_state_set() is called.
Constructors
atk_state_set_new
Creates a new empty state set.
Instance methods
atk_state_set_add_state
Adds the state of the specified type to the state set if it is not already present.
atk_state_set_add_states
Adds the states of the specified types to the state set.
atk_state_set_and_sets
Constructs the intersection of the two sets, returning NULL if the
intersection is empty.
atk_state_set_clear_states
Removes all states from the state set.
atk_state_set_contains_state
Checks whether the state for the specified type is in the specified set.
atk_state_set_contains_states
Checks whether the states for all the specified types are in the specified set.
atk_state_set_is_empty
Checks whether the state set is empty, i.e. has no states set.
atk_state_set_or_sets
Constructs the union of the two sets.
atk_state_set_remove_state
Removes the state for the specified type from the state set.
atk_state_set_xor_sets
Constructs the exclusive-or of the two sets, returning NULL is empty.
The set returned by this operation contains the states in exactly
one of the two sets.
Methods inherited from AtkObject (26)
atk_object_add_relationship
Adds a relationship of the specified type with the specified target.
atk_object_connect_property_change_handler
Calls handler on property changes.
Deprecated since: 2.12
atk_object_get_accessible_id
Gets the accessible id of the accessible.
Available since: 2.34
atk_object_get_attributes
Get a list of properties applied to this object as a whole, as an AtkAttributeSet consisting of
name-value pairs. As such these attributes may be considered weakly-typed properties or annotations,
as distinct from strongly-typed object data available via other get/set methods.
Not all objects have explicit “name-value pair” AtkAttributeSet properties.
Available since: 1.12
atk_object_get_description
Gets the accessible description of the accessible.
atk_object_get_index_in_parent
Gets the 0-based index of this accessible in its parent; returns -1 if the accessible does not have an accessible parent.
atk_object_get_layer
Gets the layer of the accessible.
atk_object_get_mdi_zorder
Gets the zorder of the accessible. The value G_MININT will be returned if the layer of the accessible is not ATK_LAYER_MDI.
atk_object_get_n_accessible_children
Gets the number of accessible children of the accessible.
atk_object_get_name
Gets the accessible name of the accessible.
atk_object_get_object_locale
Gets a UTF-8 string indicating the POSIX-style LC_MESSAGES locale
of accessible.
Available since: 2.8
atk_object_get_parent
Gets the accessible parent of the accessible. By default this is
the one assigned with atk_object_set_parent(), but it is assumed
that ATK implementors have ways to get the parent of the object
without the need of assigning it manually with
atk_object_set_parent(), and will return it with this method.
atk_object_get_role
Gets the role of the accessible.
atk_object_initialize
This function is called when implementing subclasses of AtkObject.
It does initialization required for the new object. It is intended
that this function should called only in the …_new() functions used
to create an instance of a subclass of AtkObject.
atk_object_notify_state_change
Emits a state-change signal for the specified state.
atk_object_peek_parent
Gets the accessible parent of the accessible, if it has been
manually assigned with atk_object_set_parent. Otherwise, this
function returns NULL.
atk_object_ref_accessible_child
Gets a reference to the specified accessible child of the object. The accessible children are 0-based so the first accessible child is at index 0, the second at index 1 and so on.
atk_object_ref_relation_set
Gets the AtkRelationSet associated with the object.
atk_object_ref_state_set
Gets a reference to the state set of the accessible; the caller must unreference it when it is no longer needed.
atk_object_remove_property_change_handler
Removes a property change handler.
Deprecated since: 2.12
atk_object_remove_relationship
Removes a relationship of the specified type with the specified target.
atk_object_set_accessible_id
Sets the accessible ID of the accessible. This is not meant to be presented to the user, but to be an ID which is stable over application development. Typically, this is the gtkbuilder ID. Such an ID will be available for instance to identify a given well-known accessible object for tailored screen reading, or for automatic regression testing.
Available since: 2.34
atk_object_set_description
Sets the accessible description of the accessible. You can’t set the description to NULL. This is reserved for the initial value. In this aspect NULL is similar to ATK_ROLE_UNKNOWN. If you want to set the name to a empty value you can use “”.
Properties
Properties inherited from AtkObject (15)
Atk.Object:accessible-component-layer
Atk.Object:accessible-component-mdi-zorder
Atk.Object:accessible-description
Atk.Object:accessible-hypertext-nlinks
Atk.Object:accessible-name
Atk.Object:accessible-parent
Atk.Object:accessible-role
Atk.Object:accessible-table-caption
Table caption.
Atk.Object:accessible-table-caption-object
Atk.Object:accessible-table-column-description
Accessible table column description.
Atk.Object:accessible-table-column-header
Accessible table column header.
Atk.Object:accessible-table-row-description
Accessible table row description.
Atk.Object:accessible-table-row-header
Accessible table row header.
Atk.Object:accessible-table-summary
Atk.Object:accessible-value
Numeric value of this object, in case being and AtkValue.
Signals
Signals inherited from AtkObject (6)
Atk.Object::active-descendant-changed
The “active-descendant-changed” signal is emitted by an object which has the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the object changes. For instance, a table will emit the signal when the cell in the table which has focus changes.
Atk.Object::children-changed
The signal “children-changed” is emitted when a child is added or removed form an object. It supports two details: “add” and “remove”
Atk.Object::focus-event
The signal “focus-event” is emitted when an object gained or lost focus.
Deprecated since: 2.9.4
Atk.Object::property-change
The signal “property-change” is emitted when an object’s property
value changes. arg1 contains an AtkPropertyValues with the name
and the new value of the property whose value has changed. Note
that, as with GObject notify, getting this signal does not
guarantee that the value of the property has actually changed; it
may also be emitted when the setter of the property is called to
reinstate the previous value.
Atk.Object::state-change
The “state-change” signal is emitted when an object’s state changes. The detail value identifies the state type which has changed.
Atk.Object::visible-data-changed
The “visible-data-changed” signal is emitted when the visual appearance of the object changed.