gtkmm: Gtk::SignalAction Class Reference

A Gtk::ShortcutAction that emits a signal. More...

#include <gtkmm/shortcutaction.h>

Inheritance diagram for Gtk::SignalAction:

Public Member Functions

 SignalAction (SignalAction&& src) noexcept
 
SignalActionoperator= (SignalAction&& src) noexcept
 
 ~SignalAction () noexcept override
 
GtkSignalAction* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkSignalAction* gobj () const
 Provides access to the underlying C GObject. More...

 
GtkSignalAction* 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_signal_name () const
 Returns the name of the signal that will be emitted. More...

 
Glib::PropertyProxy_ReadOnly< Glib::ustringproperty_signal_name () const
 The name of the signal to emit. More...

 
- Public Member Functions inherited from Gtk::ShortcutAction
 ShortcutAction (ShortcutAction&& src) noexcept
 
ShortcutActionoperator= (ShortcutAction&& src) noexcept
 
 ~ShortcutAction () noexcept override
 
GtkShortcutAction* gobj ()
 Provides access to the underlying C GObject. More...

 
const GtkShortcutAction* gobj () const
 Provides access to the underlying C GObject. More...

 
GtkShortcutAction* 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 to_string () const
 Prints the given action into a human-readable string. More...

 
bool activate (Widget& widget, Flags flags=static_cast< Flags >(0), const Glib::VariantBase& args={})
 Activates the action on the widget with the given args. 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
 
PropertyType get_property (const Glib::ustring &property_name) const
 
sigc::connection connect_property_changed (const Glib::ustring &property_name, const sigc::slot< void()> &slot)
 
sigc::connection connect_property_changed (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) noexcept
 
 ~trackable ()
 
void add_destroy_notify_callback (notifiable *data, func_destroy_notify func) const
 
void notify_callbacks ()
 
trackableoperator= (const trackable &src)
 
trackableoperator= (trackable &&src) noexcept
 
void remove_destroy_notify_callback (notifiable *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< SignalActioncreate (const Glib::ustring& signal_name)
 
- Static Public Member Functions inherited from Gtk::ShortcutAction
static GType get_type ()
 Get the GType for this class, for use with the underlying GObject type system. More...

 
static Glib::RefPtr< ShortcutActionparse_string (const Glib::ustring&string)
 Tries to parse the given string into an action. More...

 

Protected Member Functions

 SignalAction (const Glib::ustring& signal_name)
 
- Protected Member Functions inherited from Gtk::ShortcutAction
 ShortcutAction ()
 
- Protected Member Functions inherited from Glib::Object
 Object ()
 
 Object (const Glib::ConstructParams &construct_params)
 
 Object (GObject *castitem)
 
 ~Object () noexcept override
 
- 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::SignalActionwrap (GtkSignalAction* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...

 

Additional Inherited Members

- Public Types inherited from Gtk::ShortcutAction
enum  Flags { Flags::EXCLUSIVE = 1 << 0 }
 List of flags that can be passed to action activation. More...

 
- 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
 
- Public Types inherited from sigc::notifiable
typedef internal::func_destroy_notify func_destroy_notify
 

Detailed Description

A Gtk::ShortcutAction that emits a signal.

Constructor & Destructor Documentation

Gtk::SignalAction::SignalAction ( SignalAction&&  src)
noexcept
Gtk::SignalAction::~SignalAction ( )
overridenoexcept
Gtk::SignalAction::SignalAction ( const Glib::ustring signal_name)
explicitprotected

Member Function Documentation

static Glib::RefPtr<SignalAction> Gtk::SignalAction::create ( const Glib::ustring signal_name)
static
Glib::ustring Gtk::SignalAction::get_signal_name ( ) const

Returns the name of the signal that will be emitted.

Returns
The name of the signal to emit.
static GType Gtk::SignalAction::get_type ( )
static

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

GtkSignalAction* Gtk::SignalAction::gobj ( )
inline

Provides access to the underlying C GObject.

const GtkSignalAction* Gtk::SignalAction::gobj ( ) const
inline

Provides access to the underlying C GObject.

GtkSignalAction* Gtk::SignalAction::gobj_copy ( )

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

SignalAction& Gtk::SignalAction::operator= ( SignalAction&&  src)
noexcept
Glib::PropertyProxy_ReadOnly< Glib::ustring > Gtk::SignalAction::property_signal_name ( ) const

The name of the signal to emit.

Default value: ""

Returns
A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes.

Friends And Related Function Documentation

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