KDDockWidgets::Core::EventFilterInterface Class Reference

#include <EventFilterInterface.h>

Inheritance diagram for KDDockWidgets::Core::EventFilterInterface:

Public Member Functions
	EventFilterInterface ()=default
virtual	~EventFilterInterface ()
bool	enabled () const
	Returns whether mouse filtering is enabled. Default true.
virtual bool	onDnDEvent (View *, Event *)
	Override to handle drag enter, drag leave, drag move and drop events.
virtual bool	onExposeEvent (std::shared_ptr< Window >)
	Override to handle expose events for a certain window.
virtual bool	onMouseButtonMove (View *, MouseEvent *)
	Override to handle when a view receives a mouse press event.
virtual bool	onMouseButtonPress (View *, MouseEvent *)
	Override to handle when a view receives a mouse press event.
virtual bool	onMouseButtonRelease (View *, MouseEvent *)
	Override to handle when a view receives a mouse press event.
virtual bool	onMouseDoubleClick (View *, MouseEvent *)
	Override to handle when a view receives a mouse double click event.
virtual bool	onMouseEvent (View *, MouseEvent *)
	Provided for convenience, aggregates all other overloads receives all mouse event types, if you return true here then the specialized counterparts won't be called Example, if true is returned here for a mouse press, then onMouseButtonPress() won't be called.
virtual bool	onMoveEvent (View *)
	Override to handle a move event.
void	setEnabled (bool)

Detailed Description

Definition at line 25 of file EventFilterInterface.h.

Constructor & Destructor Documentation

EventFilterInterface()

KDDockWidgets::Core::EventFilterInterface::EventFilterInterface ( )

default

~EventFilterInterface()

EventFilterInterface::~EventFilterInterface ( )

virtualdefault

Member Function Documentation

enabled()

bool EventFilterInterface::enabled

(

)

const

Returns whether mouse filtering is enabled. Default true.

Definition at line 305 of file core/Platform.cpp.

Referenced by setEnabled().

onDnDEvent()

virtual bool KDDockWidgets::Core::EventFilterInterface::onDnDEvent ( View *  , Event *    )

inlinevirtual

Override to handle drag enter, drag leave, drag move and drop events.

Definition at line 71 of file EventFilterInterface.h.

onExposeEvent()

virtual bool KDDockWidgets::Core::EventFilterInterface::onExposeEvent ( std::shared_ptr< Window >  )

inlinevirtual

Override to handle expose events for a certain window.

Definition at line 32 of file EventFilterInterface.h.

onMouseButtonMove()

virtual bool KDDockWidgets::Core::EventFilterInterface::onMouseButtonMove ( View *  , MouseEvent *    )

inlinevirtual

Override to handle when a view receives a mouse press event.

Definition at line 50 of file EventFilterInterface.h.

onMouseButtonPress()

virtual bool KDDockWidgets::Core::EventFilterInterface::onMouseButtonPress ( View *  , MouseEvent *    )

inlinevirtual

Override to handle when a view receives a mouse press event.

Definition at line 38 of file EventFilterInterface.h.

onMouseButtonRelease()

virtual bool KDDockWidgets::Core::EventFilterInterface::onMouseButtonRelease ( View *  , MouseEvent *    )

inlinevirtual

Override to handle when a view receives a mouse press event.

Definition at line 44 of file EventFilterInterface.h.

onMouseDoubleClick()

virtual bool KDDockWidgets::Core::EventFilterInterface::onMouseDoubleClick ( View *  , MouseEvent *    )

inlinevirtual

Override to handle when a view receives a mouse double click event.

Definition at line 56 of file EventFilterInterface.h.

onMouseEvent()

virtual bool KDDockWidgets::Core::EventFilterInterface::onMouseEvent ( View *  , MouseEvent *    )

inlinevirtual

Provided for convenience, aggregates all other overloads receives all mouse event types, if you return true here then the specialized counterparts won't be called Example, if true is returned here for a mouse press, then onMouseButtonPress() won't be called.

Definition at line 65 of file EventFilterInterface.h.

onMoveEvent()

virtual bool KDDockWidgets::Core::EventFilterInterface::onMoveEvent ( View *  )

inlinevirtual

Override to handle a move event.

Definition at line 77 of file EventFilterInterface.h.

setEnabled()

void EventFilterInterface::setEnabled

(

bool

enabled

)

Definition at line 310 of file core/Platform.cpp.

References enabled().

---

The documentation for this class was generated from the following files:

• EventFilterInterface.h
• core/Platform.cpp