Inkscape::ButtonEvent Struct Reference

Abstract event for mouse button (left/right/middle). More...

#include <canvas-event.h>

Inheritance diagram for Inkscape::ButtonEvent:

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

Public Attributes
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

Abstract event for mouse button (left/right/middle).

May also be used for touch interactions.

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

Member Function Documentation

modifiersChange()

unsigned Inkscape::ButtonEvent::modifiersChange ( ) const

inlineoverridevirtual

Get the change in the modifiers due to this event.

Reimplemented from Inkscape::CanvasEvent.

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

References button.

Member Data Documentation

button

unsigned Inkscape::ButtonEvent::button = 0

The button that was pressed/released. (Matches GDK_BUTTON_*.)

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

Referenced by Inkscape::UI::Tools::PenTool::_handle2ButtonPress(), Inkscape::UI::Tools::ConnectorTool::_handleButtonPress(), Inkscape::UI::Tools::PenTool::_handleButtonPress(), Inkscape::UI::Tools::PencilTool::_handleButtonPress(), Inkscape::UI::Tools::PenTool::_handleButtonRelease(), Inkscape::UI::Tools::PencilTool::_handleButtonRelease(), Inkscape::UI::Tools::ConnectorTool::_handleButtonRelease(), Inkscape::UI::CurveDragPoint::clicked(), Inkscape::UI::SelectableControlPoint::clicked(), Inkscape::UI::CurveDragPoint::doubleclicked(), Inkscape::UI::Tools::InteractiveBooleansTool::event_button_press_handler(), Inkscape::UI::Tools::InteractiveBooleansTool::event_button_release_handler(), modifiersChange(), and Inkscape::UI::Tools::NodeTool::select_point().

orig_pos

Geom::Point Inkscape::ButtonEvent::orig_pos

Location of the cursor, in GDK event / canvas widget coordinates.

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

pos

Geom::Point Inkscape::ButtonEvent::pos

Location of the cursor, in world coordinates.

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

Referenced by Inkscape::UI::Tools::ConnectorTool::_handleButtonPress(), Inkscape::UI::Tools::PenTool::_handleButtonPress(), Inkscape::UI::Tools::PencilTool::_handleButtonPress(), Inkscape::UI::Tools::PenTool::_handleButtonRelease(), Inkscape::UI::Tools::PencilTool::_handleButtonRelease(), Inkscape::UI::Tools::ConnectorTool::_handleButtonRelease(), Inkscape::UI::Tools::InteractiveBooleansTool::event_button_press_handler(), Inkscape::UI::Tools::NodeTool::select_point(), and Inkscape::UI::Tools::ToolBase::setup_for_drag_start().

time

uint32_t Inkscape::ButtonEvent::time = 0

Timestamp of the event in milliseconds.

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

---

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

• /builds/inkscape/inkscape/src/ui/widget/events/canvas-event.h