glibmm
2.31.22
|
SimpleAction - A simple Action implementation. More...
#include <giomm/simpleaction.h>
Public Member Functions | |
virtual | ~SimpleAction () |
GSimpleAction* | gobj () |
Provides access to the underlying C GObject. | |
const GSimpleAction* | gobj () const |
Provides access to the underlying C GObject. | |
GSimpleAction* | gobj_copy () |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. | |
void | set_enabled (bool enabled) |
Sets the action as enabled or not. | |
void | set_state (const Glib::VariantBase&value) |
Sets the state of the action. | |
Glib::PropertyProxy< bool > | property_enabled () |
If the action can be activated. | |
Glib::PropertyProxy_ReadOnly < bool > | property_enabled () const |
If the action can be activated. | |
Glib::PropertyProxy_ReadOnly < Glib::ustring > | property_name () const |
The name used to invoke the action. | |
Glib::PropertyProxy_ReadOnly < Glib::VariantType > | property_parameter_type () const |
The type of GVariant passed to activate(). | |
Glib::PropertyProxy < Glib::VariantBase > | property_state () |
The state the action is in. | |
Glib::PropertyProxy_ReadOnly < Glib::VariantBase > | property_state () const |
The state the action is in. | |
Glib::PropertyProxy_ReadOnly < Glib::VariantType > | property_state_type () const |
The type of the state kept by the action. | |
Glib::SignalProxy1< void, const Glib::VariantBase& > | signal_activate () |
Glib::SignalProxy1< void, const Glib::VariantBase& > | signal_change_state () |
Static Public Member Functions | |
static Glib::RefPtr< SimpleAction > | create (const Glib::ustring& name) |
static Glib::RefPtr< SimpleAction > | create (const Glib::ustring& name, const Glib::VariantType& parameter_type) |
Creates a new action. | |
static Glib::RefPtr< SimpleAction > | create (const Glib::ustring& name, const Glib::VariantType& parameter_type, const Glib::VariantBase& sate) |
Creates a new stateful action. | |
Protected Member Functions | |
SimpleAction (const Glib::ustring& name) | |
SimpleAction (const Glib::ustring& name, const Glib::VariantType& parameter_type) | |
SimpleAction (const Glib::ustring& name, const Glib::VariantType& parameter_type, const Glib::VariantBase& sate) | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gio::SimpleAction > | wrap (GSimpleAction* object, bool take_copy=false) |
A Glib::wrap() method for this object. |
SimpleAction - A simple Action implementation.
A SimpleAction is the obvious simple implementation of the Action interface. This is the easiest way to create an action for purposes of adding it to a SimpleActionGroup.
See also Gtk::Action.
virtual Gio::SimpleAction::~SimpleAction | ( | ) | [virtual] |
Gio::SimpleAction::SimpleAction | ( | const Glib::ustring& | name | ) | [explicit, protected] |
Gio::SimpleAction::SimpleAction | ( | const Glib::ustring& | name, |
const Glib::VariantType& | parameter_type | ||
) | [explicit, protected] |
Gio::SimpleAction::SimpleAction | ( | const Glib::ustring& | name, |
const Glib::VariantType& | parameter_type, | ||
const Glib::VariantBase& | sate | ||
) | [explicit, protected] |
static Glib::RefPtr<SimpleAction> Gio::SimpleAction::create | ( | const Glib::ustring& | name | ) | [static] |
static Glib::RefPtr<SimpleAction> Gio::SimpleAction::create | ( | const Glib::ustring& | name, |
const Glib::VariantType& | parameter_type | ||
) | [static] |
Creates a new action.
The created action is stateless. See g_simple_action_new_stateful().
name | The name of the action. |
parameter_type | The type of parameter to the activate function. |
static Glib::RefPtr<SimpleAction> Gio::SimpleAction::create | ( | const Glib::ustring& | name, |
const Glib::VariantType& | parameter_type, | ||
const Glib::VariantBase& | sate | ||
) | [static] |
Creates a new stateful action.
state is the initial state of the action. All future state values must have the same VariantType as the initial state.
If the state GVariant is floating, it is consumed.
name | The name of the action. |
parameter_type | The type of the parameter to the activate function. |
state | The initial state of the action. |
GSimpleAction* Gio::SimpleAction::gobj | ( | ) | [inline] |
Provides access to the underlying C GObject.
Reimplemented from Gio::Action.
const GSimpleAction* Gio::SimpleAction::gobj | ( | ) | const [inline] |
Provides access to the underlying C GObject.
Reimplemented from Gio::Action.
GSimpleAction* Gio::SimpleAction::gobj_copy | ( | ) |
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
If the action can be activated.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Glib::PropertyProxy_ReadOnly< bool > Gio::SimpleAction::property_enabled | ( | ) | const |
If the action can be activated.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gio::Action.
The name used to invoke the action.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gio::Action.
Glib::PropertyProxy_ReadOnly< Glib::VariantType > Gio::SimpleAction::property_parameter_type | ( | ) | const |
The type of GVariant passed to activate().
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gio::Action.
The state the action is in.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
The state the action is in.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gio::Action.
The type of the state kept by the action.
You rarely need to use properties because there are get_ and set_ methods for almost all of them.
Reimplemented from Gio::Action.
void Gio::SimpleAction::set_enabled | ( | bool | enabled | ) |
Sets the action as enabled or not.
An action must be enabled in order to be activated or in order to have its state changed from outside callers.
This should only be called by the implementor of the action. Users of the action should not attempt to modify its enabled flag.
enabled | Whether the action is enabled. |
void Gio::SimpleAction::set_state | ( | const Glib::VariantBase& | value | ) |
Sets the state of the action.
This directly updates the 'state' property to the given value.
This should only be called by the implementor of the action. Users of the action should not attempt to directly modify the 'state' property. Instead, they should call g_action_change_state() to request the change.
value | The new Variant for the state. |
Glib::SignalProxy1< void,const Glib::VariantBase& > Gio::SimpleAction::signal_activate | ( | ) |
void on_my_activate(const Glib::VariantBase& parameter)
Indicates that the action was just activated.
will always be of the expected type. In the event that an incorrect type was given, no signal will be emitted.
parameter | The parameter to the activation. |
Glib::SignalProxy1< void,const Glib::VariantBase& > Gio::SimpleAction::signal_change_state | ( | ) |
void on_my_change_state(const Glib::VariantBase& value)
Indicates that the action just received a request to change its state.
value will always be of the correct state type. In the event that an incorrect type was given, no signal will be emitted.
If no handler is connected to this signal then the default behaviour is to call g_simple_action_set_state() to set the state to the requested value. If you connect a signal handler then no default action is taken. If the state should change then you must call g_simple_action_set_state() from the handler.
<title>Example 'change-state' handler</title>
static void change_volume_state (GSimpleAction *action, GVariant *value, gpointer user_data) { int
requested;
requested = g_variant_get_int32 (value);
// Volume only goes from 0 to 10 if (0 <= requested&& requested <= 10) g_simple_action_set_state (action, value); }
The handler need not set the state to the requested value. It could set it to any value at all, or take some other action.
value | The requested value for the state. |
Glib::RefPtr< Gio::SimpleAction > wrap | ( | GSimpleAction * | object, |
bool | take_copy = false |
||
) | [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. |