atkmm 2.28.3
|
An AtkStateSet determines a component's state set. More...
#include <atkmm/stateset.h>
Public Member Functions | |
StateSet (StateSet && src) noexcept | |
StateSet & | operator= (StateSet && src) noexcept |
~StateSet () noexcept override | |
AtkStateSet * | gobj () |
Provides access to the underlying C GObject. More... | |
const AtkStateSet * | gobj () const |
Provides access to the underlying C GObject. More... | |
AtkStateSet * | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More... | |
bool | is_empty () const |
Checks whether the state set is empty, i.e. has no states set. More... | |
bool | add_state (Atk::StateType type) |
Adds the state of the specified type to the state set if it is not already present. More... | |
void | add_states (const Glib::ArrayHandle< Atk::StateType > & types) |
void | clear_states () |
Removes all states from the state set. More... | |
bool | contains_state (Atk::StateType type) |
Checks whether the state for the specified type is in the specified set. More... | |
bool | contains_states (const Glib::ArrayHandle< Atk::StateType > & types) const |
bool | remove_state (Atk::StateType type) |
Removes the state for the specified type from the state set. More... | |
Glib::RefPtr< StateSet > | and_sets (const Glib::RefPtr< StateSet > & compare_set) |
Constructs the intersection of the two sets, returning nullptr if the intersection is empty. More... | |
Glib::RefPtr< StateSet > | or_sets (const Glib::RefPtr< StateSet > & compare_set) |
Constructs the union of the two sets. More... | |
Glib::RefPtr< StateSet > | xor_sets (const Glib::RefPtr< StateSet > & compare_set) |
Constructs the exclusive-or of the two sets, returning nullptr is empty. 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< StateSet > | create () |
Protected Member Functions | |
StateSet () | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Atk::StateSet > | wrap (AtkStateSet * object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
An AtkStateSet determines a component's state set.
It is composed of a set of Atk::States.
|
noexcept |
|
overridenoexcept |
|
protected |
bool Atk::StateSet::add_state | ( | Atk::StateType | type | ) |
Adds the state of the specified type to the state set if it is not already present.
Note that because an Atk::StateSet is a read-only object, this method should be used to add a state to a newly-created set which will then be returned by #atk_object_ref_state_set. It should not be used to modify the existing state of an object. See also #atk_object_notify_state_change.
type | An Atk::StateType. |
true
if the state for type is not already in set. void Atk::StateSet::add_states | ( | const Glib::ArrayHandle< Atk::StateType > & | types | ) |
Constructs the intersection of the two sets, returning nullptr
if the intersection is empty.
compare_set | Another Atk::StateSet. |
void Atk::StateSet::clear_states | ( | ) |
Removes all states from the state set.
bool Atk::StateSet::contains_state | ( | Atk::StateType | type | ) |
Checks whether the state for the specified type is in the specified set.
type | An Atk::StateType. |
true
if type is the state type is in set. bool Atk::StateSet::contains_states | ( | const Glib::ArrayHandle< Atk::StateType > & | types | ) | const |
|
static |
|
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.
AtkStateSet * Atk::StateSet::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
bool Atk::StateSet::is_empty | ( | ) | const |
Checks whether the state set is empty, i.e. has no states set.
true
if set has no states set, otherwise false
. Constructs the union of the two sets.
compare_set | Another Atk::StateSet. |
nullptr
is empty. bool Atk::StateSet::remove_state | ( | Atk::StateType | type | ) |
Removes the state for the specified type from the state set.
Note that because an Atk::StateSet is a read-only object, this method should be used to remove a state to a newly-created set which will then be returned by #atk_object_ref_state_set. It should not be used to modify the existing state of an object. See also #atk_object_notify_state_change.
type | An Atk::Type. |
true
if type was the state type is in set. Constructs the exclusive-or of the two sets, returning nullptr
is empty.
The set returned by this operation contains the states in exactly one of the two sets.
compare_set | Another Atk::StateSet. |
|
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. |