gtkmm
3.97.1
|
Generated when a key is pressed or released. More...
#include <gdkmm/events.h>
Public Member Functions | |
GdkEventKey* | gobj () noexcept |
Provides access to the underlying C instance. More... | |
const GdkEventKey* | gobj () const noexcept |
Provides access to the underlying C instance. More... | |
GdkEventKey* | gobj_copy () |
Provides access to the underlying C instance. More... | |
guint32 | get_time () const |
Returns the timestamp of the event in milliseconds. More... | |
ModifierType | get_state () const |
Returns a bit mask representing the state of the modifier keys (e.g. More... | |
guint | get_keyval () const |
Returns the key that was pressed or released. More... | |
guint16 | get_keycode () const |
Returns the raw code of the key that was pressed or released. More... | |
int | get_scancode () const |
Gets the keyboard low-level scancode of a key event. More... | |
guint | get_key_group () const |
Returns the keyboard group. More... | |
bool | get_key_is_modifier () const |
Returns true if the hardware keycode is mapped to a modifier key. More... | |
![]() | |
Event (Event&& src) noexcept | |
Event& | operator= (Event&& src) noexcept |
~Event () noexcept override | |
GdkEvent* | gobj () |
Provides access to the underlying C GObject. More... | |
const GdkEvent* | gobj () const |
Provides access to the underlying C GObject. More... | |
GdkEvent* | 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::RefPtr< Event > | copy () const |
Copies a Gdk::Event, copying or incrementing the reference count of the resources associated with it (e.g. Gdk::Surface’s and strings). More... | |
Type | get_event_type () const |
Retrieves the type of the event. More... | |
Glib::RefPtr< Gdk::Surface > | get_surface () |
Extracts the Gdk::Surface associated with an event. More... | |
Glib::RefPtr< const Gdk::Surface > | get_surface () const |
Extracts the Gdk::Surface associated with an event. More... | |
bool | is_sent () const |
Returns true if the event was sent explicitly (e.g. More... | |
void | set_device (const Glib::RefPtr< Device >& device) |
Sets the device for event to device. More... | |
Glib::RefPtr< Device > | get_device () |
If the event contains a “device” field, this function will return it, else it will return nullptr . More... | |
Glib::RefPtr< const Device > | get_device () const |
If the event contains a “device” field, this function will return it, else it will return nullptr . More... | |
void | set_source_device (const Glib::RefPtr< Device >& device) |
Sets the slave device for event to device. More... | |
Glib::RefPtr< Device > | get_source_device () |
This function returns the hardware (slave) Gdk::Device that has triggered the event, falling back to the virtual (master) device (as in get_device()) if the event wasn’t caused by interaction with a hardware device. More... | |
Glib::RefPtr< const Device > | get_source_device () const |
This function returns the hardware (slave) Gdk::Device that has triggered the event, falling back to the virtual (master) device (as in get_device()) if the event wasn’t caused by interaction with a hardware device. More... | |
void | set_display (const Glib::RefPtr< Display >& display) |
Sets the display that an event is associated with. More... | |
Glib::RefPtr< Display > | get_display () |
Retrieves the Gdk::Display associated to the event. More... | |
Glib::RefPtr< const Display > | get_display () const |
Retrieves the Gdk::Display associated to the event. More... | |
Glib::RefPtr< Seat > | get_seat () |
Returns the Gdk::Seat this event was generated for. More... | |
Glib::RefPtr< const Seat > | get_seat () const |
Returns the Gdk::Seat this event was generated for. More... | |
Glib::PropertyProxy_ReadOnly< Type > | property_event_type () const |
Event type. More... | |
![]() | |
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) |
![]() | |
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 |
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 |
Related Functions | |
(Note that these are not member functions.) | |
Glib::RefPtr< Gdk::EventKey > | wrap (GdkEventKey* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
![]() | |
Glib::RefPtr< Gdk::Event > | wrap (GdkEvent* object, bool take_copy=false) |
A Glib::wrap() method for this object. More... | |
Additional Inherited Members | |
![]() | |
enum | Type { Type::NOTHING, Type::DELETE, Type::DESTROY, Type::MOTION_NOTIFY, Type::BUTTON_PRESS, Type::BUTTON_RELEASE, Type::KEY_PRESS, Type::KEY_RELEASE, Type::ENTER_NOTIFY, Type::LEAVE_NOTIFY, Type::FOCUS_CHANGE, Type::CONFIGURE, Type::PROXIMITY_IN, Type::PROXIMITY_OUT, Type::DRAG_ENTER, Type::DRAG_LEAVE, Type::DRAG_MOTION, Type::DROP_START, Type::SCROLL, Type::GRAB_BROKEN, Type::TOUCH_BEGIN, Type::TOUCH_UPDATE, Type::TOUCH_END, Type::TOUCH_CANCEL, Type::TOUCHPAD_SWIPE, Type::TOUCHPAD_PINCH, Type::PAD_BUTTON_PRESS, Type::PAD_BUTTON_RELEASE, Type::PAD_RING, Type::PAD_STRIP, Type::PAD_GROUP_MODE, Type::EVENT_LAST } |
![]() | |
typedef void(*)(gpointer data | DestroyNotify) |
![]() | |
static GType | get_type () |
Get the GType for this class, for use with the underlying GObject type system. More... | |
static Glib::RefPtr< Event > | create (Type event_type) |
Creates a new event of the given type. More... | |
static void | set_show_events (bool show_events=true) |
Sets whether a trace of received events is output. More... | |
static bool | get_show_events () |
Gets whether event debugging output is enabled. More... | |
![]() | |
Event (Type event_type) | |
![]() | |
Object () | |
Object (const Glib::ConstructParams &construct_params) | |
Object (GObject *castitem) | |
~Object () noexcept override | |
![]() | |
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) |
Generated when a key is pressed or released.
get_event_type() will return Gdk::Event::Type::KEY_PRESS or Gdk::Event::Type::KEY_RELEASE.
guint Gdk::EventKey::get_key_group | ( | ) | const |
Returns the keyboard group.
bool Gdk::EventKey::get_key_is_modifier | ( | ) | const |
Returns true
if the hardware keycode is mapped to a modifier key.
guint16 Gdk::EventKey::get_keycode | ( | ) | const |
Returns the raw code of the key that was pressed or released.
guint Gdk::EventKey::get_keyval | ( | ) | const |
Returns the key that was pressed or released.
See the <gdk/gdkkeysyms.h> header file for a complete list of GDK key codes.
int Gdk::EventKey::get_scancode | ( | ) | const |
Gets the keyboard low-level scancode of a key event.
This is usually hardware_keycode. On Windows this is the high word of WM_KEY{DOWN,UP} lParam which contains the scancode and some extended flags.
ModifierType Gdk::EventKey::get_state | ( | ) | const |
Returns a bit mask representing the state of the modifier keys (e.g.
Control, Shift and Alt) and the pointer buttons.
guint32 Gdk::EventKey::get_time | ( | ) | const |
Returns the timestamp of the event in milliseconds.
|
inlinenoexcept |
Provides access to the underlying C instance.
|
inlinenoexcept |
Provides access to the underlying C instance.
GdkEventKey* Gdk::EventKey::gobj_copy | ( | ) |
Provides access to the underlying C instance.
The caller is responsible for unrefing it with g_object_unref(). Use when directly setting fields in structs.
|
related |
A Glib::wrap() method for this object.
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. |