mouseAction Parameter

mouseAction parameter

Use the mouseAction parameter to set or query an editor action assignment for a specified mouse event.

Availability

query command
set command

Scope

The current view.

Syntax
query mouseAction.[modifier-][...]{dragged |
                                  entered |
                                  exited |
                                  hover |
                                  moved |
                                  pressed.count |
                                  released.count
                                 }[.context][...]
set mouseAction.[modifier-][...]{dragged |
                                entered |
                                exited |
                                hover |
                                moved |
                                pressed.count |
                                released.count
                               }[.context][...] [action] 
Parameters

modifier The modifier parameter can be any of 1, 2, 3, c, s, or a. 1 is used to indicate mouse button 1. 2 is used to indicate mouse button 2. 3 is used to indicate mouse button 3. c is used to indicate the primary keyboard modifier for the platform (for example, the Ctrl key on Windows). s is used to indicate the secondary keyboard modifier for the platform (for example, the Shift key on Windows). a is used to indicate the tertiary keyboard modifier for the platform (for example, the Alt key on Windows). For example if you want to specify an action for double clicking mouse button 1 with the Ctrl and Alt keys pressed, you can specify c-a-1-pressed.2.
dragged Use the dragged parameter to assign an action to the mouse dragged event.
entered Use the entered parameter to assign an action to the mouse entered event.
exited Use the exited parameter to assign an action to the mouse exited event.
hover Use the hover parameter to assign an action to the mouse hover event.
moved Use the moved parameter to assign an action to the mouse moved event.
pressed.count Use the pressed parameter to assign an action to a mouse pressed event. The count parameter indicates the number of button clicks that are associated with the event.
released.count Use the released parameter to assign an action to a mouse released event. The count parameter indicates the number of button clicks that are associated with the event.
context The context parameter can be any of t, p, or e. t is used to indicate that the mouse action should be available when the mouse cursor is in the text area. p is used to indicate that the mouse action should be available when the mouse cursor is in the prefix area. e is used to indicate that the mouse action should be available when the mouse cursor is in the expand/hide area. If you do not specify a context, the context is assumed to be t.
action Use the action parameter to specify the action that you want assigned to the specified mouse event. If you do not specify an action, the event will have no editor action assigned to it.

Description

The actual mouse events received by the editor depend on the environment (workstation configuration, operating system, Java support, enclosing editor application, etc.) in which the editor is running. Certain mouse actions may not be activated in some environments.

Examples
query mouseAction.popup
set mouseAction.1-pressed.1.t.p cursorToMouse 
query command
set command
mouseEvents parameter
updateProfile.userMouseActions parameter

modifier	The modifier parameter can be any of 1, 2, 3, c, s, or a. 1 is used to indicate mouse button 1. 2 is used to indicate mouse button 2. 3 is used to indicate mouse button 3. c is used to indicate the primary keyboard modifier for the platform (for example, the Ctrl key on Windows). s is used to indicate the secondary keyboard modifier for the platform (for example, the Shift key on Windows). a is used to indicate the tertiary keyboard modifier for the platform (for example, the Alt key on Windows). For example if you want to specify an action for double clicking mouse button 1 with the Ctrl and Alt keys pressed, you can specify c-a-1-pressed.2.
dragged	Use the dragged parameter to assign an action to the mouse dragged event.
entered	Use the entered parameter to assign an action to the mouse entered event.
exited	Use the exited parameter to assign an action to the mouse exited event.
hover	Use the hover parameter to assign an action to the mouse hover event.
moved	Use the moved parameter to assign an action to the mouse moved event.
pressed.count	Use the pressed parameter to assign an action to a mouse pressed event. The count parameter indicates the number of button clicks that are associated with the event.
released.count	Use the released parameter to assign an action to a mouse released event. The count parameter indicates the number of button clicks that are associated with the event.
context	The context parameter can be any of t, p, or e. t is used to indicate that the mouse action should be available when the mouse cursor is in the text area. p is used to indicate that the mouse action should be available when the mouse cursor is in the prefix area. e is used to indicate that the mouse action should be available when the mouse cursor is in the expand/hide area. If you do not specify a context, the context is assumed to be t.
action	Use the action parameter to specify the action that you want assigned to the specified mouse event. If you do not specify an action, the event will have no editor action assigned to it.