gtkmm: Gtk::NeverTrigger Class Reference

A Gtk::ShortcutTrigger that never triggers. More...

#include <gtkmm/shortcuttrigger.h>

Inheritance diagram for Gtk::NeverTrigger:

[legend]

Public Member Functions
	NeverTrigger (NeverTrigger &&src) noexcept

NeverTrigger &	operator= (NeverTrigger &&src) noexcept

	~NeverTrigger () noexcept override

GtkNeverTrigger *	gobj ()
	Provides access to the underlying C GObject.

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

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

Public Member Functions inherited from Gtk::ShortcutTrigger
	ShortcutTrigger (ShortcutTrigger &&src) noexcept

ShortcutTrigger &	operator= (ShortcutTrigger &&src) noexcept

	~ShortcutTrigger () noexcept override

GtkShortcutTrigger *	gobj ()
	Provides access to the underlying C GObject.

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

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

Glib::ustring	to_label (const Glib::RefPtr< const Gdk::Display > &display) const
	Gets textual representation for the given trigger.

bool	equal (const Glib::RefPtr< const ShortcutTrigger > &trigger2) const
	Checks if trigger1 and trigger2 trigger under the same conditions.

int	compare (const Glib::RefPtr< const ShortcutTrigger > &trigger2) const
	The types of trigger1 and trigger2 are `gconstpointer` only to allow use of this function as a `CompareFunc`.

Gdk::KeyMatch	trigger (const Glib::RefPtr< const Gdk::Event > & event, bool enable_mnemonics) const
	Checks if the given event triggers self.

Static Public Member Functions
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< NeverTrigger >	get ()
	Gets the never trigger.

Static Public Member Functions inherited from Gtk::ShortcutTrigger
static GType	get_type ()
	Get the GType for this class, for use with the underlying GObject type system.

static Glib::RefPtr< ShortcutTrigger >	parse_string (const Glib::ustring &string)
	Tries to parse the given string into a trigger.

Protected Member Functions
	NeverTrigger ()

Protected Member Functions inherited from Gtk::ShortcutTrigger
	ShortcutTrigger ()

Related Symbols
(Note that these are not member symbols.)
Glib::RefPtr< Gtk::NeverTrigger >	wrap (GtkNeverTrigger *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Related Symbols inherited from Gtk::ShortcutTrigger
Glib::RefPtr< Gtk::ShortcutTrigger >	wrap (GtkShortcutTrigger *object, bool take_copy=false)
	A Glib::wrap() method for this object.

Detailed Description

A Gtk::ShortcutTrigger that never triggers.

Constructor & Destructor Documentation

◆ NeverTrigger() [1/2]

Gtk::NeverTrigger::NeverTrigger ( NeverTrigger && src )

noexcept

◆ ~NeverTrigger()

Gtk::NeverTrigger::~NeverTrigger ( )

overridenoexcept

◆ NeverTrigger() [2/2]

Gtk::NeverTrigger::NeverTrigger ( )

protected

Member Function Documentation

◆ get()

static Glib::RefPtr< NeverTrigger > Gtk::NeverTrigger::get ( )

static

Gets the never trigger.

This is a singleton for a trigger that never triggers. Use this trigger instead of nullptr because it implements all virtual functions.

Returns: The never trigger.

◆ get_type()

static GType Gtk::NeverTrigger::get_type ( )

static

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

◆ gobj() [1/2]

GtkNeverTrigger * Gtk::NeverTrigger::gobj ( )

inline

Provides access to the underlying C GObject.

◆ gobj() [2/2]

const GtkNeverTrigger * Gtk::NeverTrigger::gobj ( ) const

inline

Provides access to the underlying C GObject.

◆ gobj_copy()

GtkNeverTrigger * Gtk::NeverTrigger::gobj_copy ( )

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

◆ operator=()

NeverTrigger & Gtk::NeverTrigger::operator= ( NeverTrigger && src )

noexcept

Friends And Related Symbol Documentation

◆ wrap()

Glib::RefPtr< Gtk::NeverTrigger > wrap	(	GtkNeverTrigger *	object,
		bool	take_copy = `false`
	)

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.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Related Symbols