LuciadCPillar C# 2023.1.04
Luciad.Edit.Handles.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...

Inheritance diagram for Luciad.Edit.Handles.EditActionBinder:

Public Member Functions

Luciad.Edit.Handles.EditActionBinder Cursor (Luciad.Maps.MouseCursor cursor)
 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...
 
void Dispose ()
 
Luciad.Edit.Handles.EditActionBinder ModifierKeys (Luciad.Input.ModifierKeys modifierKeys)
 Sets the modifier keys that must be pressed while the click occurs for the action to be performed. More...
 
Luciad.Edit.Handles.EditActionBinder MouseButton (Luciad.Input.Mouse.MouseButton mouseButton)
 Sets the mouse button that must be clicked for the action to be performed. More...
 
Luciad.Edit.Handles.EditActionBinder PerformOnIntermediateEvents (bool enable)
 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

2020.1

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::EditActionBinder.

Member Function Documentation

◆ Cursor()

Luciad.Edit.Handles.EditActionBinder Luciad.Edit.Handles.EditActionBinder.Cursor ( Luciad.Maps.MouseCursor  cursor)
inline

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.

cursor

the mouse cursor to display

this

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::EditActionBinder::cursor.

◆ Dispose()

void Luciad.Edit.Handles.EditActionBinder.Dispose ( )
inline

◆ ModifierKeys()

Luciad.Edit.Handles.EditActionBinder Luciad.Edit.Handles.EditActionBinder.ModifierKeys ( Luciad.Input.ModifierKeys  modifierKeys)
inline

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.

modifierKeys

the modifier keys that must be pressed.

this

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::EditActionBinder::modifierKeys.

◆ MouseButton()

Luciad.Edit.Handles.EditActionBinder Luciad.Edit.Handles.EditActionBinder.MouseButton ( Luciad.Input.Mouse.MouseButton  mouseButton)
inline

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

By default, this is the left mouse button.

mouseButton

the mouse button that must be clicked.

this

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::EditActionBinder::mouseButton.

◆ PerformOnIntermediateEvents()

Luciad.Edit.Handles.EditActionBinder Luciad.Edit.Handles.EditActionBinder.PerformOnIntermediateEvents ( bool  enable)
inline

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.

enable

whether IPointEditAction::execute is also called for intermediate events

this

Warning
C# documentation translation is incomplete. You can find more information in the C++ documentation for luciad::EditActionBinder::performOnIntermediateEvents.