gtkmm: Gtk::ActionGroup Class Reference
A deprecated action group. More...
#include <gtkmm/actiongroup.h>
Public Member Functions | |
ActionGroup (ActionGroup&& src) noexcept | |
ActionGroup& | operator= (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< AccelGroup > | get_accel_group () |
Gets the accelerator group. More... | |
Glib::RefPtr< const AccelGroup > | get_accel_group () const |
Gets the accelerator group. More... | |
void | set_accel_group (const Glib::RefPtr< AccelGroup >& accel_group) |
Sets the accelerator group to be used by every action in this group. More... | |
Glib::RefPtr< Action > | get_action (const Glib::ustring& action_name) |
Looks up an action in the action group by name. More... | |
Glib::RefPtr< const Action > | get_action (const Glib::ustring& action_name) const |
Looks up an action in the action group by name. More... | |
std::vector< Glib::RefPtr< Action > > | get_actions () |
Lists the actions in the action group. More... | |
std::vector< 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&string) const |
Translates a string using the function set with set_translate_func(). More... | |
Glib::SignalProxy< void, const Glib::RefPtr< Action >&, Widget* > | signal_connect_proxy () |
Glib::SignalProxy< void, const Glib::RefPtr< Action >&, Widget* > | signal_disconnect_proxy () |
Glib::SignalProxy< void, const Glib::RefPtr< Action >& > | signal_pre_activate () |
Glib::SignalProxy< void, const Glib::RefPtr< Action >& > | signal_post_activate () |
Glib::PropertyProxy_ReadOnly< Glib::ustring > | property_name () const |
A name for the action. 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... | |
Glib::PropertyProxy< Glib::RefPtr< AccelGroup > > | property_accel_group () |
The accelerator group the actions of this group should use. More... | |
Glib::PropertyProxy_ReadOnly< Glib::RefPtr< AccelGroup > > | property_accel_group () const |
The accelerator group the actions of this group should use. More... | |
Public Member Functions inherited from Glib::Object | |
Object (const Object &)=delete | |
Object & | operator= (const Object &)=delete |
Object (Object &&src) noexcept | |
Object & | operator= (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::Object > | wrap (GObject *object, bool take_copy=false) |
Public Member Functions inherited from Glib::ObjectBase | |
ObjectBase (const ObjectBase &)=delete | |
ObjectBase & | operator= (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 () |
trackable & | operator= (const trackable &src) |
trackable & | operator= (trackable &&src) |
void | remove_destroy_notify_callback (void *data) const |
Public Member Functions inherited from Gtk::Buildable | |
Buildable (Buildable&& src) noexcept | |
Buildable& | operator= (Buildable&& src) noexcept |
~Buildable () noexceptoverride | |
GtkBuildable* | gobj () |
Provides access to the underlying C GObject. More... | |
const GtkBuildable* | gobj () const |
Provides access to the underlying C GObject. More... | |
void | set_name (const Glib::ustring& name) |
Sets the name of the buildable object. More... | |
Glib::ustring | get_name () const |
Gets the name of the buildable object. More... | |
Public Member Functions inherited from Glib::Interface | |
Interface () | |
Interface (Interface &&src) noexcept | |
Interface & | operator= (Interface &&src) noexcept |
Interface (const Glib::Interface_Class &interface_class) | |
Interface (GObject *castitem) | |
~Interface () noexceptoverride | |
Interface (const Interface &)=delete | |
Interface & | operator= (const Interface &)=delete |
GObject * | gobj () |
const GObject * | gobj () 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< ActionGroup > | create (const Glib::ustring& name=Glib::ustring()) |
Static Public Member Functions inherited from Gtk::Buildable | |
static void | add_interface (GType gtype_implementer) |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
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 | |
ObjectBase & | operator= (ObjectBase &&src) noexcept |
virtual | ~ObjectBase () noexcept=0 |
void | initialize (GObject *castitem) |
void | initialize_move (GObject *castitem, Glib::ObjectBase *previous_wrapper) |
Protected Member Functions inherited from Gtk::Buildable | |
Buildable () | |
You should derive from this class to use it. More... | |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gtk::ActionGroup > | wrap (GtkActionGroup* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Related Functions inherited from Gtk::Buildable | |
Glib::RefPtr< Gtk::Buildable > | wrap (GtkBuildable* 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 |
Detailed Description
A deprecated action group.
It is essentially a map from names to Gtk::Action objects.
- Deprecated:
- Use Gio::ActionGroup and Gio::Action instead.
Constructor & Destructor Documentation
|
noexcept |
|
overridenoexcept |
|
explicitprotected |
- Deprecated:
- Use Gio::ActionGroup and give it a name with Gtk::Widget::insert_action_group().
Member Function Documentation
void Gtk::ActionGroup::add | ( | const Glib::RefPtr< Action >& | action | ) |
- Deprecated:
- Use Gio::ActionMap::add_action() on a Gio::SimpleActionGroup instead.
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 | ||
) |
- Deprecated:
- Use Gio::ActionMap::add_action() on a Gio::SimpleActionGroup instead.
void Gtk::ActionGroup::add | ( | const Glib::RefPtr< Action >& | action, |
const AccelKey& | accel_key, | ||
const Action::SlotActivate& | slot | ||
) |
|
static |
- Deprecated:
- Use Gio::ActionGroup and give it a name with Gtk::Widget::insert_action_group().
Glib::RefPtr<AccelGroup> Gtk::ActionGroup::get_accel_group | ( | ) |
Gets the accelerator group.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup and the accelerator group on an associated Gtk::Menu instead.
- Returns
- The accelerator group associated with this action group or
nullptr
if there is none.
Glib::RefPtr<const AccelGroup> Gtk::ActionGroup::get_accel_group | ( | ) | const |
Gets the accelerator group.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup and the accelerator group on an associated Gtk::Menu instead.
- Returns
- The accelerator group associated with this action group or
nullptr
if there is none.
Glib::RefPtr<Action> Gtk::ActionGroup::get_action | ( | const Glib::ustring & | action_name | ) |
Looks up an action in the action group by name.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionMap::lookup_action() on a Gio::SimpleActionGroup instead.
- Parameters
-
action_name The 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.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionMap::lookup_action() on a Gio::SimpleActionGroup instead.
- Parameters
-
action_name The name of the action.
- Returns
- The action, or
nullptr
if no action by that name exists.
std::vector< Glib::RefPtr<Action> > Gtk::ActionGroup::get_actions | ( | ) |
Lists the actions in the action group.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup::list_actions() and Gio::ActionMap::lookup_action() on a Gio::SimpleActionGroup instead.
- 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.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup::list_actions() and Gio::ActionMap::lookup_action() on a Gio::SimpleActionGroup instead.
- 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- 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.
Deprecated: 3.10
- Returns
true
if the group is sensitive.
|
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.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup instead, and control and monitor the state of Gtk::Actionable widgets directly.
- Returns
true
if the group is visible.
|
inline |
Provides access to the underlying C GObject.
|
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.
|
noexcept |
Glib::PropertyProxy< Glib::RefPtr<AccelGroup> > Gtk::ActionGroup::property_accel_group | ( | ) |
The accelerator group the actions of this group should use.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup and the accelerator group on an associated Gtk::Menu instead.
- 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< Glib::RefPtr<AccelGroup> > Gtk::ActionGroup::property_accel_group | ( | ) | const |
The accelerator group the actions of this group should use.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup and the accelerator group on an associated Gtk::Menu instead.
- 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_ReadOnly< Glib::ustring > Gtk::ActionGroup::property_name | ( | ) | const |
A name for the action.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- 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.
Deprecated: 3.10
- 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.
Deprecated: 3.10
- 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- 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.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionMap::remove_action() on a Gio::SimpleActionGroup instead.
- Parameters
-
action An action.
void Gtk::ActionGroup::set_accel_group | ( | const Glib::RefPtr< AccelGroup >& | accel_group | ) |
Sets the accelerator group to be used by every action in this group.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup and the accelerator group on an associated Gtk::Menu instead.
- Parameters
-
accel_group A Gtk::AccelGroup to set or nullptr
.
void Gtk::ActionGroup::set_sensitive | ( | bool | sensitive = true | ) |
Changes the sensitivity of action_group.
Deprecated: 3.10
- Deprecated:
- Use Gio::SimpleAction::set_enabled() instead.
- Parameters
-
sensitive New sensitivity.
void Gtk::ActionGroup::set_visible | ( | bool | visible = true | ) |
Changes the visible of action_group.
Deprecated: 3.10
- Deprecated:
- Use Gio::ActionGroup instead, and control and monitor the state of Gtk::Actionable widgets directly.
- Parameters
-
visible New visiblity.
Glib::SignalProxy< 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- Parameters
-
action The action. proxy The proxy.
Glib::SignalProxy< 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- Parameters
-
action The action. proxy The proxy.
Glib::SignalProxy< 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- Parameters
-
action The action.
Glib::SignalProxy< 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.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- Parameters
-
action The action.
Glib::ustring Gtk::ActionGroup::translate_string | ( | const Glib::ustring & | string | ) | const |
Translates a string using the function set with set_translate_func().
This is mainly intended for language bindings.
Deprecated: 3.10
- Deprecated:
- There is no corresponding replacement when using Gio::ActionGroup.
- Parameters
-
string A string.
- Returns
- The translation of string.
Friends And Related Function Documentation
|
related |
A Glib::wrap() method for this object.
- Parameters
-
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.
- Returns
- A C++ instance that wraps this C instance.