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

Abstract base class for events. More...

#include <canvas-event.h>

Inheritance diagram for Inkscape::CanvasEvent:
Inkscape::ButtonEvent Inkscape::EnterEvent Inkscape::KeyEvent Inkscape::LeaveEvent Inkscape::MotionEvent Inkscape::ScrollEvent Inkscape::ButtonPressEvent Inkscape::ButtonReleaseEvent Inkscape::KeyPressEvent Inkscape::KeyReleaseEvent

Public Member Functions

virtual ~CanvasEvent ()
 
virtual EventType type () const =0
 Return the dynamic type of the CanvasEvent.
 
virtual unsigned modifiersChange () const
 Get the change in the modifiers due to this event.
 
unsigned modifiersAfter () const
 Get the modifiers mask immediately after the event. (Convenience function.)
 

Public Attributes

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 base class for events.

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

Constructor & Destructor Documentation

◆ ~CanvasEvent()

virtual Inkscape::CanvasEvent::~CanvasEvent ( )
inlinevirtual

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

Member Function Documentation

◆ modifiersAfter()

unsigned Inkscape::CanvasEvent::modifiersAfter ( ) const
inline

Get the modifiers mask immediately after the event. (Convenience function.)

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

References modifiers, and modifiersChange().

Referenced by Inkscape::UI::Tools::NodeTool::_updateSelectionColor(), and Inkscape::UI::Tools::InteractiveBooleansTool::root_handler().

◆ modifiersChange()

virtual unsigned Inkscape::CanvasEvent::modifiersChange ( ) const
inlinevirtual

Get the change in the modifiers due to this event.

Reimplemented in Inkscape::ButtonEvent, and Inkscape::KeyEvent.

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

Referenced by Inkscape::UI::ControlPoint::_eventHandler(), and modifiersAfter().

◆ type()

virtual EventType Inkscape::CanvasEvent::type ( ) const
pure virtual

Return the dynamic type of the CanvasEvent.

Implemented in Inkscape::ButtonPressEvent, Inkscape::ButtonReleaseEvent, Inkscape::KeyPressEvent, Inkscape::KeyReleaseEvent, Inkscape::MotionEvent, Inkscape::EnterEvent, Inkscape::LeaveEvent, and Inkscape::ScrollEvent.

Referenced by SPDesktop::drawing_handler(), Inkscape::dump_event(), Inkscape::UI::Tools::ToolBase::item_handler(), Inkscape::UI::Tools::Box3dTool::item_handler(), Inkscape::UI::Tools::ToolBase::menu_popup(), Inkscape::UI::Tools::set_event_location(), snoop_extended(), and Inkscape::UI::Tools::NodeTool::update_tip().

Member Data Documentation

◆ device

std::shared_ptr<Gdk::Device const> Inkscape::CanvasEvent::device

The device that sourced the event. May be null.

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

Referenced by Inkscape::UI::Tools::TextTool::root_handler().

◆ modifiers

unsigned Inkscape::CanvasEvent::modifiers = 0

The modifiers mask immediately before the event.

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

Referenced by Inkscape::UI::ControlPoint::_eventHandler(), Inkscape::UI::Node::_eventHandler(), Inkscape::UI::Tools::PenTool::_handleButtonPress(), Inkscape::UI::Tools::PencilTool::_handleButtonPress(), Inkscape::UI::Tools::PenTool::_handleButtonRelease(), Inkscape::UI::Tools::PencilTool::_handleButtonRelease(), Inkscape::UI::Tools::PencilTool::_handleKeyPress(), Inkscape::UI::Tools::PenTool::_handleMotionNotify(), Inkscape::UI::Tools::PencilTool::_handleMotionNotify(), Inkscape::UI::Tools::ConnectorTool::_handleMotionNotify(), Inkscape::UI::CurveDragPoint::dragged(), Inkscape::UI::Tools::InteractiveBooleansTool::event_button_press_handler(), Inkscape::UI::Tools::InteractiveBooleansTool::event_motion_handler(), SPKnot::eventHandler(), Inkscape::Shortcuts::get_from_event(), Inkscape::UI::Tools::get_latin_keyval(), Inkscape::CanvasItemDrawing::handle_event(), SPKnot::handler_request_position(), Inkscape::UI::Tools::ConnectorTool::item_handler(), Inkscape::UI::Tools::FloodTool::item_handler(), Inkscape::UI::Tools::TextTool::item_handler(), Inkscape::mod_alt(), Inkscape::mod_alt_only(), Inkscape::mod_any(), Inkscape::mod_button(), Inkscape::mod_ctrl(), Inkscape::mod_ctrl_only(), Inkscape::mod_none(), Inkscape::mod_shift(), Inkscape::mod_shift_only(), modifiersAfter(), Inkscape::UI::Tools::ArcTool::root_handler(), Inkscape::UI::Tools::Box3dTool::root_handler(), Inkscape::UI::Tools::DropperTool::root_handler(), Inkscape::UI::Tools::FloodTool::root_handler(), Inkscape::UI::Tools::MeasureTool::root_handler(), Inkscape::UI::Tools::MeshTool::root_handler(), Inkscape::UI::Tools::NodeTool::root_handler(), Inkscape::UI::Tools::PagesTool::root_handler(), Inkscape::UI::Tools::RectTool::root_handler(), Inkscape::UI::Tools::SelectTool::root_handler(), Inkscape::UI::Tools::SpiralTool::root_handler(), Inkscape::UI::Tools::SprayTool::root_handler(), Inkscape::UI::Tools::StarTool::root_handler(), Inkscape::UI::Tools::TextTool::root_handler(), Inkscape::UI::Tools::TweakTool::root_handler(), Inkscape::UI::Tools::ZoomTool::root_handler(), Inkscape::UI::Widget::CanvasGrid::rulerMotion(), Inkscape::UI::Tools::NodeTool::select_point(), Inkscape::UI::Tools::ToolBase::set_on_buttons(), Inkscape::UI::Tools::ToolBase::setup_for_drag_start(), and Inkscape::UI::ControlPoint::transferGrab().

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