Ardour  9.0-pre0-582-g084a23a80d
Gtk::ActionGroup Class Reference

#include <actiongroup.h>

Inheritance diagram for Gtk::ActionGroup:
[legend]

Public Member Functions

virtual ~ActionGroup ()
 
GtkActionGroupgobj ()
 Provides access to the underlying C GObject. More...
 
const GtkActionGroupgobj () const
 Provides access to the underlying C GObject. More...
 
GtkActionGroupgobj_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
 
bool get_sensitive () const
 
void set_sensitive (bool sensitive=true)
 
bool get_visible () const
 
void set_visible (bool visible=true)
 
Glib::RefPtr< Actionget_action (const Glib::ustring &action_name)
 
Glib::RefPtr< const Actionget_action (const Glib::ustring &action_name) const
 
Glib::ListHandle< Glib::RefPtr< Action > > get_actions ()
 
Glib::ListHandle< Glib::RefPtr< const Action > > get_actions () const
 
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)
 
Glib::ustring translate_string (const Glib::ustring &str) const
 
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
 
Glib::PropertyProxy< bool > property_sensitive ()
 
Glib::PropertyProxy_ReadOnly< bool > property_sensitive () const
 
Glib::PropertyProxy< bool > property_visible ()
 
Glib::PropertyProxy_ReadOnly< bool > property_visible () const
 

Static Public Member Functions

static GType get_type () G_GNUC_CONST
 
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)
 

Detailed Description

Definition at line 49 of file actiongroup.h.

Constructor & Destructor Documentation

◆ ~ActionGroup()

virtual Gtk::ActionGroup::~ActionGroup ( )
virtual

◆ ActionGroup()

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

Member Function Documentation

◆ add() [1/4]

void Gtk::ActionGroup::add ( const Glib::RefPtr< Action > &  action)

◆ add() [2/4]

void Gtk::ActionGroup::add ( const Glib::RefPtr< Action > &  action,
const AccelKey accel_key 
)

◆ add() [3/4]

void Gtk::ActionGroup::add ( const Glib::RefPtr< Action > &  action,
const AccelKey accel_key,
const Action::SlotActivate slot 
)

◆ add() [4/4]

void Gtk::ActionGroup::add ( const Glib::RefPtr< Action > &  action,
const Action::SlotActivate slot 
)

◆ create()

static Glib::RefPtr<ActionGroup> Gtk::ActionGroup::create ( const Glib::ustring &  name = Glib::ustring())
static

◆ get_action() [1/2]

Glib::RefPtr<Action> Gtk::ActionGroup::get_action ( const Glib::ustring &  action_name)

Looks up an action in the action group by name.

Parameters
action_nameThe name of the action.
Returns
The action, or 0 if no action by that name exists.

◆ get_action() [2/2]

Glib::RefPtr<const Action> Gtk::ActionGroup::get_action ( const Glib::ustring &  action_name) const

Looks up an action in the action group by name.

Parameters
action_nameThe name of the action.
Returns
The action, or 0 if no action by that name exists.

◆ get_actions() [1/2]

Glib::ListHandle< Glib::RefPtr<Action> > Gtk::ActionGroup::get_actions ( )

Lists the actions in the action group.

Returns
An allocated list of the action objects in the action group.

◆ get_actions() [2/2]

Glib::ListHandle< Glib::RefPtr<const Action> > Gtk::ActionGroup::get_actions ( ) const

Lists the actions in the action group.

Returns
An allocated list of the action objects in the action group.

◆ get_name()

Glib::ustring Gtk::ActionGroup::get_name ( ) const

Gets the name of the action group.

Returns
The name of the action group.

◆ get_sensitive()

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.

Returns
true if the group is sensitive.

◆ get_type()

static GType Gtk::ActionGroup::get_type ( )
static

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

◆ get_visible()

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.

Returns
true if the group is visible.

◆ gobj() [1/2]

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

Provides access to the underlying C GObject.

Definition at line 88 of file actiongroup.h.

◆ gobj() [2/2]

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

Provides access to the underlying C GObject.

Definition at line 91 of file actiongroup.h.

◆ gobj_copy()

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.

◆ property_name()

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.

◆ property_sensitive() [1/2]

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.

◆ property_sensitive() [2/2]

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.

◆ property_visible() [1/2]

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.

◆ property_visible() [2/2]

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.

◆ remove()

void Gtk::ActionGroup::remove ( const Glib::RefPtr< Action > &  action)

Removes an action object from the action group.

Parameters
actionAn action.

◆ set_sensitive()

void Gtk::ActionGroup::set_sensitive ( bool  sensitive = true)

Changes the sensitivity of action_group

Parameters
sensitiveNew sensitivity.

◆ set_visible()

void Gtk::ActionGroup::set_visible ( bool  visible = true)

Changes the visible of action_group.

Parameters
visibleNew visiblity.

◆ signal_connect_proxy()

Glib::SignalProxy2< 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)

◆ signal_disconnect_proxy()

Glib::SignalProxy2< 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)

◆ signal_post_activate()

Glib::SignalProxy1< void,const Glib::RefPtr<Action>& > Gtk::ActionGroup::signal_post_activate ( )

The post_activate signal is emitted just after the action in the action_group 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)

◆ signal_pre_activate()

Glib::SignalProxy1< void,const Glib::RefPtr<Action>& > Gtk::ActionGroup::signal_pre_activate ( )

The pre_activate signal is emitted just before the action 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.

Parameters
actionthe action
Slot Prototype:
void on_my_pre_activate(const Glib::RefPtr<Action>& action)

◆ translate_string()

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.

Parameters
strA string.
Returns
The translation of string.

Friends And Related Function Documentation

◆ wrap()

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: