#include <wx/event.h>

Inheritance diagram for wxStylusEvent:

Detailed Description

A wxStylusEvent is generated from wxWindow when the graphical pen (stylus) is used.

Application can handle this event to process stylus actions based on the current position of the pen, pressure and other parameters.

Events using this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxStylusEvent& event)

Event macros:

EVT_STYLUS_DOWN(func):
Process a wxEVT_STYLUS_DOWN event, which is generated when a pen makes contact with the tablet.
EVT_STYLUS_UP(func):
Process a wxEVT_STYLUS_UP event, which is generated when a pen breaks contact with the tablet.
EVT_STYLUS_UPDATE(func):
Process a wxEVT_STYLUS_UPDATE event, which is generated each time an update (like movement) comes from a pen that is near or touches surface of the tablet.

Library: wxCore

Category: Events

Since: 3.3.3

Public Member Functions
	wxStylusEvent (wxWindowID winid=0, wxEventType type=wxEVT_NULL)
	Constructor.
wxDouble	GetPressure () const
	Get the pressure value.
void	SetPressure (wxDouble p)
	Set the pressure value.
wxDouble	GetTiltX () const
	Get the x tilt value.
void	SetTiltX (wxDouble t)
	Set the x tilt value.
wxDouble	GetTiltY () const
	Get the y tilt value.
void	SetTiltY (wxDouble t)
	Set the y tilt value.
wxDouble	GetRotation () const
	Get the rotation value.
void	SetRotation (wxDouble r)
	Set the rotation.
const wxPoint &	GetPosition () const
	Returns the position where the event happened relative to the window generating the event.
void	SetPosition (const wxPoint &pos)
	Set the position.
bool	IsUsingEraser () const
	Tells if the pen used is an eraser.
void	SetUsingEraser (bool eraser)
	Update the eraser flag, true if eraser used, false otherwise.
Public Member Functions inherited from wxEvent
	wxEvent (int id=0, wxEventType eventType=wxEVT_NULL)
	Constructor.
virtual wxEvent *	Clone () const =0
	Returns a copy of the event.
wxObject *	GetEventObject () const
	Returns the object (usually a window) associated with the event, if any.
wxEventType	GetEventType () const
	Returns the identifier of the given event type, such as `wxEVT_BUTTON`.
virtual wxEventCategory	GetEventCategory () const
	Returns a generic category for this event.
int	GetId () const
	Returns the identifier associated with this event, such as a button command id.
wxObject *	GetEventUserData () const
	Return the user data associated with a dynamically connected event handler.
bool	GetSkipped () const
	Returns true if the event handler should be skipped, false otherwise.
long	GetTimestamp () const
	Gets the timestamp for the event.
bool	IsCommandEvent () const
	Returns true if the event is or is derived from wxCommandEvent else it returns false.
void	ResumePropagation (int propagationLevel)
	Sets the propagation level to the given value (for example returned from an earlier call to wxEvent::StopPropagation).
void	SetEventObject (wxObject *object)
	Sets the originating object.
void	SetEventType (wxEventType type)
	Sets the event type.
void	SetId (int id)
	Sets the identifier associated with this event, such as a button command id.
void	SetTimestamp (long timeStamp=0)
	Sets the timestamp for the event.
bool	ShouldPropagate () const
	Test if this event should be propagated or not, i.e. if the propagation level is currently greater than 0.
void	Skip (bool skip=true)
	This method can be used inside an event handler to control whether further event handlers bound to this event will be called after the current one returns.
int	StopPropagation ()
	Stop the event from propagating to its parent window.
Public Member Functions inherited from wxObject
	wxObject ()
	Default ctor; initializes to nullptr the internal reference data.
	wxObject (const wxObject &other)
	Copy ctor.
virtual	~wxObject ()
	Destructor.
virtual wxClassInfo *	GetClassInfo () const
	This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar).
wxObjectRefData *	GetRefData () const
	Returns the wxObject::m_refData pointer, i.e. the data referenced by this object.
bool	IsKindOf (const wxClassInfo *info) const
	Determines whether this class is a subclass of (or the same class as) the given class.
bool	IsSameAs (const wxObject &obj) const
	Returns true if this object has the same data pointer as obj.
void	Ref (const wxObject &clone)
	Makes this object refer to the data in clone.
void	SetRefData (wxObjectRefData *data)
	Sets the wxObject::m_refData pointer.
void	UnRef ()
	Decrements the reference count in the associated data, and if it is zero, deletes the data.
void	UnShare ()
	This is the same of AllocExclusive() but this method is public.
void	operator delete (void *buf)
	The delete operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined.
void *	operator new (size_t size, const wxString &filename=nullptr, int lineNum=0)
	The new operator is defined for debugging versions of the library only, when the identifier `__WXDEBUG__` is defined.

Additional Inherited Members
Protected Member Functions inherited from wxObject
void	AllocExclusive ()
	Ensure that this object's data is not shared with any other object.
virtual wxObjectRefData *	CreateRefData () const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it.
virtual wxObjectRefData *	CloneRefData (const wxObjectRefData *data) const
	Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data.
Protected Attributes inherited from wxEvent
int	m_propagationLevel
	Indicates how many levels the event can propagate.
Protected Attributes inherited from wxObject
wxObjectRefData *	m_refData
	Pointer to an object which is the object's reference-counted data.

Constructor & Destructor Documentation

◆ wxStylusEvent()

wxStylusEvent::wxStylusEvent	(	wxWindowID	winid = 0,
		wxEventType	type = wxEVT_NULL )

Constructor.

Member Function Documentation

◆ GetPosition()

const wxPoint & wxStylusEvent::GetPosition ( ) const

Returns the position where the event happened relative to the window generating the event.

◆ GetPressure()

wxDouble wxStylusEvent::GetPressure ( ) const

Get the pressure value.

Range is from 0 to 1.

◆ GetRotation()

wxDouble wxStylusEvent::GetRotation ( ) const

Get the rotation value.

Range is between 0 and 360.

◆ GetTiltX()

wxDouble wxStylusEvent::GetTiltX ( ) const

Get the x tilt value.

Range is between -90 and +90.

◆ GetTiltY()

wxDouble wxStylusEvent::GetTiltY ( ) const

Get the y tilt value.

Range is between -90 and +90.

◆ IsUsingEraser()

bool wxStylusEvent::IsUsingEraser ( ) const

Tells if the pen used is an eraser.

◆ SetPosition()

void wxStylusEvent::SetPosition ( const wxPoint & pos )

Set the position.

◆ SetPressure()

void wxStylusEvent::SetPressure ( wxDouble p )

Set the pressure value.

◆ SetRotation()

void wxStylusEvent::SetRotation ( wxDouble r )

Set the rotation.

◆ SetTiltX()

void wxStylusEvent::SetTiltX ( wxDouble t )

Set the x tilt value.

◆ SetTiltY()

void wxStylusEvent::SetTiltY ( wxDouble t )

Set the y tilt value.

◆ SetUsingEraser()

void wxStylusEvent::SetUsingEraser ( bool eraser )

Update the eraser flag, true if eraser used, false otherwise.