gtkmm  2.24.4
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions | List of all members
Gtk::ActionGroup Class Reference
Inheritance diagram for Gtk::ActionGroup:
Inheritance graph
[legend]
Collaboration diagram for Gtk::ActionGroup:
Collaboration graph
[legend]

Public Member Functions

 ActionGroup (ActionGroup&& src) noexcept
 
ActionGroupoperator= (ActionGroup&& src) noexcept
 
 ~ActionGroup () noexceptoverride
 
GtkActionGroup* gobj ()
 Provides access to the underlying C GObject. More...
 
const GtkActionGroup* gobj () const
 Provides access to the underlying C GObject. More...
 
GtkActionGroup* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. More...
 
Glib::ustring get_name () const
 Gets the name of the action group. More...
 
bool get_sensitive () const
 Returns true if the group is sensitive. More...
 
void set_sensitive (bool sensitive=true)
 Changes the sensitivity of action_group. More...
 
bool get_visible () const
 Returns true if the group is visible. More...
 
void set_visible (bool visible=true)
 Changes the visible of action_group. More...
 
Glib::RefPtr< Actionget_action (const Glib::ustring& action_name)
 Looks up an action in the action group by name. More...
 
Glib::RefPtr< const Actionget_action (const Glib::ustring& action_name) const
 Looks up an action in the action group by name. More...
 
Glib::ListHandle< Glib::RefPtr< Action > > get_actions ()
 Lists the actions in the action group. More...
 
Glib::ListHandle< Glib::RefPtr< const Action > > get_actions () const
 Lists the actions in the action group. More...
 
void add (const Glib::RefPtr< Action >& action)
 
void add (const Glib::RefPtr< Action >& action, const AccelKey& accel_key)
 
void add (const Glib::RefPtr< Action >& action, const Action::SlotActivate& slot)
 
void add (const Glib::RefPtr< Action >& action, const AccelKey& accel_key, const Action::SlotActivate& slot)
 
void remove (const Glib::RefPtr< Action >& action)
 Removes an action object from the action group. More...
 
Glib::ustring translate_string (const Glib::ustring& str) const
 Translates a string using the specified translate_func(). More...
 
Glib::SignalProxy< void, const Glib::RefPtr< Action >&, Widget* > signal_connect_proxy ()
 The connect_proxy signal is emitted after connecting a proxy to an action in the group. More...
 
Glib::SignalProxy< void, const Glib::RefPtr< Action >&, Widget* > signal_disconnect_proxy ()
 The disconnect_proxy signal is emitted after disconnecting a proxy from an action in the group. More...
 
Glib::SignalProxy< void, const Glib::RefPtr< Action >& > signal_pre_activate ()
 The pre_activate signal is emitted just before the in the action_group is activated. More...
 
Glib::SignalProxy< void, const Glib::RefPtr< Action >& > signal_post_activate ()
 The post_activate signal is emitted just after the in the is activated. More...
 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_name () const
 A name for the action group. More...
 
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the action group is enabled. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 Whether the action group is enabled. More...
 
Glib::PropertyProxy< bool > property_visible ()
 Whether the action group is visible. More...
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 Whether the action group is visible. More...
 
- Public Member Functions inherited from Glib::Object
 Object (const Object &)=delete
 
Objectoperator= (const Object &)=delete
 
 Object (Object &&src) noexcept
 
Objectoperator= (Object &&src) noexcept
 
void * get_data (const QueryQuark &key)
 
void set_data (const Quark &key, void *data)
 
void set_data (const Quark &key, void *data, DestroyNotify notify)
 
void remove_data (const QueryQuark &quark)
 
void * steal_data (const QueryQuark &quark)
 
Glib::RefPtr< Glib::Objectwrap (GObject *object, bool take_copy=false)
 
- 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
 
void connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
void connect_property_changed (const Glib::ustring &property_name, sigc::slot< void > &&slot)
 
sigc::connection connect_property_changed_with_return (const Glib::ustring &property_name, const sigc::slot< void > &slot)
 
sigc::connection connect_property_changed_with_return (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
 
- Public Member Functions inherited from sigc::trackable
 trackable () noexcept
 
 trackable (const trackable &src) noexcept
 
 trackable (trackable &&src)
 
 ~trackable ()
 
void add_destroy_notify_callback (void *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src)
 
void remove_destroy_notify_callback (void *data) const
 

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< ActionGroupcreate (const Glib::ustring& name=Glib::ustring())
 

Protected Member Functions

 ActionGroup (const Glib::ustring& name=Glib::ustring())
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexceptoverride
 
- 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)
 

Related Functions

(Note that these are not member functions.)

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

Additional Inherited Members

- Public Types inherited from Glib::Object
typedef void(*)(gpointer data DestroyNotify)
 
- Public Types inherited from sigc::trackable
typedef internal::func_destroy_notify func_destroy_notify
 

Constructor & Destructor Documentation

Gtk::ActionGroup::ActionGroup ( ActionGroup&&  src)
noexcept
Gtk::ActionGroup::~ActionGroup ( )
overridenoexcept
Gtk::ActionGroup::ActionGroup ( const Glib::ustring name = Glib::ustring())
explicitprotected

Member Function Documentation

void Gtk::ActionGroup::add ( const Glib::RefPtr< Action >&  action)
void Gtk::ActionGroup::add ( const Glib::RefPtr< Action >&  action,
const AccelKey accel_key 
)
void Gtk::ActionGroup::add ( const Glib::RefPtr< Action >&  action,
const Action::SlotActivate slot 
)
void Gtk::ActionGroup::add ( const Glib::RefPtr< Action >&  action,
const AccelKey accel_key,
const Action::SlotActivate slot 
)
static Glib::RefPtr<ActionGroup> Gtk::ActionGroup::create ( const Glib::ustring name = Glib::ustring())
static
Glib::RefPtr<Action> Gtk::ActionGroup::get_action ( const Glib::ustring action_name)

Looks up an action in the action group by name.

Since gtkmm 2.4:
Parameters
action_nameThe name of the action.
Returns
The action, or nullptr if no action by that name exists.
Glib::RefPtr<const Action> Gtk::ActionGroup::get_action ( const Glib::ustring action_name) const

Looks up an action in the action group by name.

Since gtkmm 2.4:
Parameters
action_nameThe name of the action.
Returns
The action, or nullptr if no action by that name exists.
Glib::ListHandle< Glib::RefPtr<Action> > Gtk::ActionGroup::get_actions ( )

Lists the actions in the action group.

Since gtkmm 2.4:
Returns
An allocated list of the action objects in the action group.
Glib::ListHandle< Glib::RefPtr<const Action> > Gtk::ActionGroup::get_actions ( ) const

Lists the actions in the action group.

Since gtkmm 2.4:
Returns
An allocated list of the action objects in the action group.
Glib::ustring Gtk::ActionGroup::get_name ( ) const

Gets the name of the action group.

Since gtkmm 2.4:
Returns
The name of the action group.
bool Gtk::ActionGroup::get_sensitive ( ) const

Returns true if the group is sensitive.

The constituent actions can only be logically sensitive (see is_sensitive()) if they are sensitive (see get_sensitive()) and their group is sensitive.

Since gtkmm 2.4:
Returns
true if the group is sensitive.
static GType Gtk::ActionGroup::get_type ( )
static

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

bool Gtk::ActionGroup::get_visible ( ) const

Returns true if the group is visible.

The constituent actions can only be logically visible (see is_visible()) if they are visible (see get_visible()) and their group is visible.

Since gtkmm 2.4:
Returns
true if the group is visible.
GtkActionGroup* Gtk::ActionGroup::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkActionGroup* Gtk::ActionGroup::gobj ( ) const
inline

Provides access to the underlying C GObject.

GtkActionGroup* Gtk::ActionGroup::gobj_copy ( )

Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.

ActionGroup& Gtk::ActionGroup::operator= ( ActionGroup&&  src)
noexcept
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::ActionGroup::property_name ( ) const

A name for the action group.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ActionGroup::property_sensitive ( )

Whether the action group is enabled.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ActionGroup::property_sensitive ( ) const

Whether the action group is enabled.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy< bool > Gtk::ActionGroup::property_visible ( )

Whether the action group is visible.

Returns
A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes.
Glib::PropertyProxy_ReadOnly< bool > Gtk::ActionGroup::property_visible ( ) const

Whether the action group is visible.

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.
void Gtk::ActionGroup::remove ( const Glib::RefPtr< Action >&  action)

Removes an action object from the action group.

Since gtkmm 2.4:
Parameters
actionAn action.
void Gtk::ActionGroup::set_sensitive ( bool  sensitive = true)

Changes the sensitivity of action_group.

Since gtkmm 2.4:
Parameters
sensitiveNew sensitivity.
void Gtk::ActionGroup::set_visible ( bool  visible = true)

Changes the visible of action_group.

Since gtkmm 2.4:
Parameters
visibleNew visiblity.
Glib::SignalProxy< void,const Glib::RefPtr<Action>&,Widget* > Gtk::ActionGroup::signal_connect_proxy ( )

The connect_proxy signal is emitted after connecting a proxy to an action in the group.

Note that the proxy may have been connected to a different action before.

This is intended for simple customizations for which a custom action class would be too clumsy, e.g. showing tooltips for menuitems in the statusbar.

UIManager proxies the signal and provides global notification just before any action is connected to a proxy, which is probably more convenient to use.

Parameters
actionthe action
proxythe proxy
Slot Prototype:
void on_my_connect_proxy(const Glib::RefPtr<Action>& action, Widget* proxy)
Glib::SignalProxy< void,const Glib::RefPtr<Action>&,Widget* > Gtk::ActionGroup::signal_disconnect_proxy ( )

The disconnect_proxy signal is emitted after disconnecting a proxy from an action in the group.

UIManager proxies the signal and provides global notification just before any action is connected to a proxy, which is probably more convenient to use.

Parameters
actionthe action
proxythe proxy
Slot Prototype:
void on_my_disconnect_proxy(const Glib::RefPtr<Action>& action, Widget* proxy)
Glib::SignalProxy< void,const Glib::RefPtr<Action>& > Gtk::ActionGroup::signal_post_activate ( )

The post_activate signal is emitted just after the in the is activated.

This is intended for UIManager to proxy the signal and provide global notification just after any action is activated.

Parameters
actionthe action
Slot Prototype:
void on_my_post_activate(const Glib::RefPtr<Action>& action)
Glib::SignalProxy< void,const Glib::RefPtr<Action>& > Gtk::ActionGroup::signal_pre_activate ( )

The pre_activate signal is emitted just before the in the action_group is activated.

This is intended for UIManager to proxy the signal and provide global notification just before any action is activated.

the action

Slot Prototype:
void on_my_pre_activate(const Glib::RefPtr<Action>& action)
Glib::ustring Gtk::ActionGroup::translate_string ( const Glib::ustring str) const

Translates a string using the specified translate_func().

This is mainly intended for language bindings.

Since gtkmm 2.6:
Parameters
strA string.
Returns
The translation of str.

Friends And Related Function Documentation

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

The documentation for this class was generated from the following file: