Inkscape
Vector Graphics Editor
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
Inkscape::ButtonPressEvent Struct Referencefinal

A mouse button (left/right/middle) is pressed. More...

#include <canvas-event.h>

Inheritance diagram for Inkscape::ButtonPressEvent:
Inkscape::ButtonEvent Inkscape::CanvasEvent

Public Member Functions

EventType type () const override
 Return the dynamic type of the CanvasEvent.
 
- Public Member Functions inherited from Inkscape::ButtonEvent
unsigned modifiersChange () const override
 Get the change in the modifiers due to this event.
 
- Public Member Functions inherited from Inkscape::CanvasEvent
virtual ~CanvasEvent ()
 
unsigned modifiersAfter () const
 Get the modifiers mask immediately after the event. (Convenience function.)
 

Public Attributes

int num_press = 1
 Counter for repeated clicks (e.g. double clicks). Starts at 1 and increments by 1 each time.
 
ExtendedInput extinput
 Extended input data for graphics tablet input. Fields may be empty.
 
- Public Attributes inherited from Inkscape::ButtonEvent
Geom::Point pos
 Location of the cursor, in world coordinates.
 
Geom::Point orig_pos
 Location of the cursor, in GDK event / canvas widget coordinates.
 
unsigned button = 0
 The button that was pressed/released. (Matches GDK_BUTTON_*.)
 
uint32_t time = 0
 Timestamp of the event in milliseconds.
 
- Public Attributes inherited from Inkscape::CanvasEvent
unsigned modifiers = 0
 The modifiers mask immediately before the event.
 
std::shared_ptr< Gdk::Device const > device
 The device that sourced the event. May be null.
 

Detailed Description

A mouse button (left/right/middle) is pressed.

May also be used for touch interactions.

Definition at line 118 of file canvas-event.h.

Member Function Documentation

◆ type()

EventType Inkscape::ButtonPressEvent::type ( ) const
inlineoverridevirtual

Return the dynamic type of the CanvasEvent.

Implements Inkscape::CanvasEvent.

Definition at line 120 of file canvas-event.h.

References Inkscape::BUTTON_PRESS.

Member Data Documentation

◆ extinput

ExtendedInput Inkscape::ButtonPressEvent::extinput

Extended input data for graphics tablet input. Fields may be empty.

Definition at line 126 of file canvas-event.h.

◆ num_press

int Inkscape::ButtonPressEvent::num_press = 1

Counter for repeated clicks (e.g. double clicks). Starts at 1 and increments by 1 each time.

Definition at line 123 of file canvas-event.h.

Referenced by Inkscape::UI::Tools::PencilTool::_handleButtonPress(), and Inkscape::UI::Tools::InteractiveBooleansTool::event_button_press_handler().

The documentation for this struct was generated from the following file: