gtkmm  3.4.0
Public Member Functions | Static Public Member Functions | Protected Member Functions | Related Functions
Gtk::ActionGroup Class Reference
Inheritance diagram for Gtk::ActionGroup:
Inheritance graph
[legend]

List of all members.

Public Member Functions

virtual ~ActionGroup ()
GtkActionGroup* gobj ()
 Provides access to the underlying C GObject.
const GtkActionGroup* gobj () const
 Provides access to the underlying C GObject.
GtkActionGroup* gobj_copy ()
 Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
Glib::ustring get_name () const
 Gets the name of the action group.
bool get_sensitive () const
 Returns true if the group is sensitive.
void set_sensitive (bool sensitive=true)
 Changes the sensitivity of action_group.
bool get_visible () const
 Returns true if the group is visible.
void set_visible (bool visible=true)
 Changes the visible of action_group.
Glib::RefPtr< Actionget_action (const Glib::ustring& action_name)
 Looks up an action in the action group by name.
Glib::RefPtr< const Actionget_action (const Glib::ustring& action_name) const
 Looks up an action in the action group by name.
std::vector< Glib::RefPtr
< Action > > 
get_actions ()
 Lists the actions in the action group.
std::vector< Glib::RefPtr
< const Action > > 
get_actions () const
 Lists the actions in the action group.
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.
Glib::ustring translate_string (const Glib::ustring& str) const
 Translates a string using the specified translate_func().
Glib::SignalProxy2< void,
const Glib::RefPtr< Action >
&, Widget* > 
signal_connect_proxy ()
Glib::SignalProxy2< void,
const Glib::RefPtr< Action >
&, Widget* > 
signal_disconnect_proxy ()
Glib::SignalProxy1< void,
const Glib::RefPtr< Action >& > 
signal_pre_activate ()
Glib::SignalProxy1< void,
const Glib::RefPtr< Action >& > 
signal_post_activate ()
Glib::PropertyProxy_ReadOnly
< Glib::ustring > 
property_name () const
 A name for the action group.
Glib::PropertyProxy< bool > property_sensitive ()
 Whether the action group is enabled.
Glib::PropertyProxy_ReadOnly
< bool > 
property_sensitive () const
 Whether the action group is enabled.
Glib::PropertyProxy< bool > property_visible ()
 Whether the action group is visible.
Glib::PropertyProxy_ReadOnly
< bool > 
property_visible () const
 Whether the action group is visible.

Static Public Member Functions

static Glib::RefPtr< ActionGroupcreate (const Glib::ustring& name=Glib::ustring())

Protected Member Functions

 ActionGroup (const Glib::ustring& name=Glib::ustring())

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.

Constructor & Destructor Documentation

virtual Gtk::ActionGroup::~ActionGroup ( ) [virtual]
Gtk::ActionGroup::ActionGroup ( const Glib::ustring &  name = Glib::ustring()) [explicit, protected]

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 0 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 0 if no action by that name exists.

Lists the actions in the action group.

Since gtkmm 2.4:
Returns:
An allocated list of the action objects in the action group.
std::vector< 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.

Reimplemented from Gtk::Buildable.

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.

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.

Reimplemented from Gtk::Buildable.

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

Provides access to the underlying C GObject.

Reimplemented from Gtk::Buildable.

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.

Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::ActionGroup::property_name ( ) const

A name for the action group.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

Whether the action group is enabled.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

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

Whether the action group is visible.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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.

You rarely need to use properties because there are get_ and set_ methods for almost all of them.

Returns:
A PropertyProxy that allows you to get or set the property of the value, 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::SignalProxy2< void,const Glib::RefPtr<Action>&,Widget* > Gtk::ActionGroup::signal_connect_proxy ( )
Slot Prototype:
void on_my_connect_proxy(const Glib::RefPtr<Action>& action, Widget* proxy)

The signal_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.

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

Since gtkmm 2.4:
Parameters:
actionThe action.
proxyThe proxy.
Glib::SignalProxy2< void,const Glib::RefPtr<Action>&,Widget* > Gtk::ActionGroup::signal_disconnect_proxy ( )
Slot Prototype:
void on_my_disconnect_proxy(const Glib::RefPtr<Action>& action, Widget* proxy)

The signal_disconnect_proxy() signal is emitted after disconnecting a proxy from an action in the group.

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

Since gtkmm 2.4:
Parameters:
actionThe action.
proxyThe proxy.
Glib::SignalProxy1< void,const Glib::RefPtr<Action>& > Gtk::ActionGroup::signal_post_activate ( )
Slot Prototype:
void on_my_post_activate(const Glib::RefPtr<Action>& action)

The signal_post_activate() signal is emitted just after the action in the action_group is activated

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

Since gtkmm 2.4:
Parameters:
actionThe action.
Glib::SignalProxy1< void,const Glib::RefPtr<Action>& > Gtk::ActionGroup::signal_pre_activate ( )
Slot Prototype:
void on_my_pre_activate(const Glib::RefPtr<Action>& action)

The signal_pre_activate() signal is emitted just before the action in the action_group is activated

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

Since gtkmm 2.4:
Parameters:
actionThe 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:
stringA string.
Returns:
The translation of string.

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: