luciad::EditActionBinder Class Reference

This class allows you to specify more options or requirements for actions that can be executed by handles, such as the mouse buttons that users need to click for the action to be executed, or the mouse cursor that is displayed when interacting with the handle. More...

#include <luciad/edit/handles/EditActionBinder.h>

Public Member Functions
virtual	~EditActionBinder ()=default
virtual EditActionBinder &	cursor (MouseCursor cursor)=0
	Sets the mouse cursor to display when this handle is highlighted and this action's requirements, such as modifier keys or mouse button clicks, are met. More...
virtual EditActionBinder &	modifierKeys (ModifierKeys modifierKeys)=0
	Sets the modifier keys that must be pressed while the click occurs for the action to be performed. More...
virtual EditActionBinder &	mouseButton (MouseButton mouseButton)=0
	Sets the mouse button that must be clicked for the action to be performed. More...
virtual EditActionBinder &	performOnIntermediateEvents (bool enable)=0
	Sets whether the action is also performed for intermediate events, such as drag updates or mouse moves, and not only at the end of a gesture event sequence. More...

Detailed Description

This class allows you to specify more options or requirements for actions that can be executed by handles, such as the mouse buttons that users need to click for the action to be executed, or the mouse cursor that is displayed when interacting with the handle.

It is used by the following handle implementations, for example:

• PointEditHandle
• TranslateEditHandle

Since

2020.1

Constructor & Destructor Documentation

~EditActionBinder()

virtual luciad::EditActionBinder::~EditActionBinder ( )

virtualdefault

Member Function Documentation

cursor()

virtual EditActionBinder & luciad::EditActionBinder::cursor ( MouseCursor  cursor )

pure virtual

Sets the mouse cursor to display when this handle is highlighted and this action's requirements, such as modifier keys or mouse button clicks, are met.

By default, no custom cursor is defined.

Parameters

cursor

the mouse cursor to display

Returns

this

modifierKeys()

virtual EditActionBinder & luciad::EditActionBinder::modifierKeys ( ModifierKeys  modifierKeys )

pure virtual

Sets the modifier keys that must be pressed while the click occurs for the action to be performed.

By default this is set to ModifierKeys::none.

Parameters

modifierKeys

the modifier keys that must be pressed.

Returns

this

mouseButton()

virtual EditActionBinder & luciad::EditActionBinder::mouseButton ( MouseButton  mouseButton )

pure virtual

Sets the mouse button that must be clicked for the action to be performed.

By default, this is the left mouse button.

Parameters

mouseButton

the mouse button that must be clicked.

Returns

this

performOnIntermediateEvents()

virtual EditActionBinder & luciad::EditActionBinder::performOnIntermediateEvents ( bool  enable )

pure virtual

Sets whether the action is also performed for intermediate events, such as drag updates or mouse moves, and not only at the end of a gesture event sequence.

The default is true.

Parameters

enable

whether IPointEditAction::execute is also called for intermediate events

Returns

this