gtkmm  3.91.0
Public Member Functions | Related Functions | List of all members
Gdk::EventScroll Class Reference

Generated when the mouse is scrolled. More...

#include <gdkmm/event.h>

Inheritance diagram for Gdk::EventScroll:
Inheritance graph
[legend]

Public Member Functions

 EventScroll ()
 Creates an invalid event object. More...
 
 EventScroll (GdkEventScroll* gobject, bool make_a_copy=false)
 Wraps a C event instance. More...
 
void swap (EventScroll& other) noexcept
 
GdkEventScroll* gobj ()
 Provides access to the underlying C instance. More...
 
const GdkEventScroll* gobj () const
 Provides access to the underlying C instance. More...
 
GdkEventScroll* gobj_copy () const
 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...
 
double get_x () const
 Returns the X coordinate of the pointer relative to the window. More...
 
double get_y () const
 Returns the Y coordinate of the pointer relative to the window. More...
 
double get_root_x () const
 Returns the X coordinate of the pointer relative to the root screen. More...
 
double get_root_y () const
 Returns the Y coordinate of the pointer relative to the root screen. More...
 
double get_delta_x () const
 Returns the scroll delta in the X axis. More...
 
double get_delta_y () const
 Returns the scroll delta in the Y axis. More...
 
ScrollDirection get_direction () const
 Returns the direction of the scroll. More...
 
bool is_scroll_stop_event () const
 Check whether a scroll event is a stop scroll event. More...
 
Glib::RefPtr< Gdk::Deviceget_device ()
 Returns the device where the event originated from. More...
 
Glib::RefPtr< const Gdk::Deviceget_device () const
 
- Public Member Functions inherited from Gdk::Event
 Event ()
 Creates an invalid event object. More...
 
 Event (GdkEvent* gobject, bool make_a_copy=false)
 Wraps a C event instance. More...
 
 Event (const Event& other)
 
Eventoperator= (const Event& other)
 
 Event (Event&& other) noexcept
 
Eventoperator= (Event&& other) noexcept
 
 ~Event () noexcept
 
void swap (Event& other) noexcept
 
GdkEvent* gobj ()
 Provides access to the underlying C instance. More...
 
const GdkEvent* gobj () const
 Provides access to the underlying C instance. More...
 
GdkEvent* gobj_copy () const
 Provides access to the underlying C instance. More...
 
Event::Type get_event_type () const
 Retrieves the type of the event. More...
 
Glib::RefPtr< Gdk::Windowget_window ()
 Returns the window which received the event. More...
 
Glib::RefPtr< const Gdk::Windowget_window () const
 
bool is_send_event () const
 Returns true if the event was sent explicitly (e.g. More...
 
Glib::RefPtr< Screenget_screen ()
 Returns the screen for the event. More...
 
Glib::RefPtr< const Screenget_screen () const
 Returns the screen for the event. More...
 
Glib::RefPtr< Seatget_seat ()
 Returns the Gdk::Seat this event was generated for. More...
 
Glib::RefPtr< const Seatget_seat () const
 Returns the Gdk::Seat this event was generated for. More...
 
void put ()
 Appends a copy of the given event onto the front of the event queue for event->any.window’s display, or the default event queue if event->any.window is nullptr. More...
 

Related Functions

(Note that these are not member functions.)

void swap (EventScroll& lhs, EventScroll& rhs) noexcept
 
const EventScrollwrap_event (const GdkEventScroll*& event)
 Wraps a C event instance without making unnecessary copy when the ownership can not be acquired. More...
 
EventScrollwrap_event (GdkEventScroll*& event)
 See wrap_event(const GdkEventScroll*& event). More...
 
Gdk::EventScroll wrap (GdkEventScroll* object, bool take_copy=false)
 A Glib::wrap() method for this object. More...
 

Additional Inherited Members

- Public Types inherited from Gdk::Event
enum  Type {
  Type::NOTHING = -1,
  Type::DELETE = 0,
  Type::DESTROY = 1,
  Type::EXPOSE = 2,
  Type::MOTION_NOTIFY = 3,
  Type::BUTTON_PRESS = 4,
  Type::DOUBLE_BUTTON_PRESS = 5,
  Type::TRIPLE_BUTTON_PRESS = 6,
  Type::BUTTON_RELEASE = 7,
  Type::KEY_PRESS = 8,
  Type::KEY_RELEASE = 9,
  Type::ENTER_NOTIFY = 10,
  Type::LEAVE_NOTIFY = 11,
  Type::FOCUS_CHANGE = 12,
  Type::CONFIGURE = 13,
  Type::MAP = 14,
  Type::UNMAP = 15,
  Type::PROPERTY_NOTIFY = 16,
  Type::SELECTION_CLEAR = 17,
  Type::SELECTION_REQUEST = 18,
  Type::SELECTION_NOTIFY = 19,
  Type::PROXIMITY_IN = 20,
  Type::PROXIMITY_OUT = 21,
  Type::DRAG_ENTER = 22,
  Type::DRAG_LEAVE = 23,
  Type::DRAG_MOTION = 24,
  Type::DRAG_STATUS = 25,
  Type::DROP_START = 26,
  Type::DROP_FINISHED = 27,
  Type::CLIENT_EVENT = 28,
  Type::VISIBILITY_NOTIFY = 29,
  Type::SCROLL = 31,
  Type::WINDOW_STATE = 32,
  Type::SETTING = 33,
  Type::OWNER_CHANGE = 34,
  Type::GRAB_BROKEN = 35,
  Type::DAMAGE = 36,
  Type::TOUCH_BEGIN = 37,
  Type::TOUCH_UPDATE = 38,
  Type::TOUCH_END = 39,
  Type::TOUCH_CANCEL = 40,
  Type::TOUCHPAD_SWIPE = 41,
  Type::TOUCHPAD_PINCH = 42,
  Type::PAD_BUTTON_PRESS = 43,
  Type::PAD_BUTTON_RELEASE = 44,
  Type::PAD_RING = 45,
  Type::PAD_STRIP = 46,
  Type::PAD_GROUP_MODE = 47,
  Type::EVENT_LAST = 48
}
 Specifies the type of the event. More...
 
- Static Public Member Functions inherited from Gdk::Event
static void set_show_events (bool show_events)
 Sets whether a trace of received events is output. More...
 
static bool get_show_events ()
 Gets whether event debugging output is enabled. More...
 
static Event get ()
 Checks all open displays for a Gdk::Event to process,to be processed on, fetching events from the windowing system if necessary. More...
 
static Event peek ()
 If there is an event waiting in the event queue of some open display, returns a copy of it. More...
 
static bool events_pending ()
 Checks if any events are ready to be processed for any display. More...
 

Detailed Description

Generated when the mouse is scrolled.

These events are from button presses for the buttons 4 to 7. Wheel mice are usually configured to generate button press events for buttons 4 and 5 when the wheel is turned.

get_event_type() will return Gdk::Event::Type::SCROLL.

Some GDK backends can also generate 'smooth' scroll events, which can be recognized by the Gdk::ScrollDirection::SMOOTH scroll direction. For these, scroll deltas can be obtained with get_delta_x() and get_delta_y().

Since gtkmm 3.90:

Constructor & Destructor Documentation

Gdk::EventScroll::EventScroll ( )

Creates an invalid event object.

Calling any member functions is undefined behavior.

Gdk::EventScroll::EventScroll ( GdkEventScroll *  gobject,
bool  make_a_copy = false 
)
explicit

Wraps a C event instance.

This constructor either acquires ownership of gobject, or copies it.

Parameters
gobjectEvent to wrap.
make_a_copyIf false, the ownership of gobject is acquired, otherwise, a copy is made.

Member Function Documentation

double Gdk::EventScroll::get_delta_x ( ) const

Returns the scroll delta in the X axis.

Meaningful only if get_direction() returns Gdk::ScrollDirection::SMOOTH

double Gdk::EventScroll::get_delta_y ( ) const

Returns the scroll delta in the Y axis.

Meaningful only if get_direction() returns Gdk::ScrollDirection::SMOOTH

Glib::RefPtr<Gdk::Device> Gdk::EventScroll::get_device ( )

Returns the device where the event originated from.

Glib::RefPtr<const Gdk::Device> Gdk::EventScroll::get_device ( ) const
ScrollDirection Gdk::EventScroll::get_direction ( ) const

Returns the direction of the scroll.

double Gdk::EventScroll::get_root_x ( ) const

Returns the X coordinate of the pointer relative to the root screen.

double Gdk::EventScroll::get_root_y ( ) const

Returns the Y coordinate of the pointer relative to the root screen.

ModifierType Gdk::EventScroll::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::EventScroll::get_time ( ) const

Returns the timestamp of the event in milliseconds.

double Gdk::EventScroll::get_x ( ) const

Returns the X coordinate of the pointer relative to the window.

double Gdk::EventScroll::get_y ( ) const

Returns the Y coordinate of the pointer relative to the window.

GdkEventScroll* Gdk::EventScroll::gobj ( )
inline

Provides access to the underlying C instance.

const GdkEventScroll* Gdk::EventScroll::gobj ( ) const
inline

Provides access to the underlying C instance.

GdkEventScroll* Gdk::EventScroll::gobj_copy ( ) const

Provides access to the underlying C instance.

The caller is responsible for freeing it with gdk_event_free(). Use when directly setting fields in structs.

bool Gdk::EventScroll::is_scroll_stop_event ( ) const

Check whether a scroll event is a stop scroll event.

Scroll sequences with smooth scroll information may provide a stop scroll event once the interaction with the device finishes, e.g. by lifting a finger. This stop scroll event is the signal that a widget may trigger kinetic scrolling based on the current velocity.

Stop scroll events always have a a delta of 0/0.

Since gtkmm 3.20:
Returns
true if the event is a scroll stop event.
void Gdk::EventScroll::swap ( EventScroll other)
noexcept

Friends And Related Function Documentation

void swap ( EventScroll lhs,
EventScroll rhs 
)
related
Parameters
lhsThe left-hand side
rhsThe right-hand side
Gdk::EventScroll wrap ( GdkEventScroll *  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.
Returns
A C++ instance that wraps this C instance.
const EventScroll& wrap_event ( const GdkEventScroll *&  event)
related

Wraps a C event instance without making unnecessary copy when the ownership can not be acquired.

The event pointer must not be deleted until last usage of the returned instance. Note, that this requirement applies to the pointer itself, in addition to the object it is pointing to.

EventScroll& wrap_event ( GdkEventScroll *&  event)
related