Introducing the configurable components: Difference between revisions
(Created page with "__TOC__ === Commands === <span class="f_Para">The operations you perform from the Client GUI are available as commands you can assign to different...") |
No edit summary |
||
| Line 2: | Line 2: | ||
=== Commands === | === Commands === | ||
<span class="f_Para">The operations you perform from the Client GUI are available as [[ | <span class="f_Para">The operations you perform from the Client GUI are available as [[Client Command Reference|commands]] you can assign to different buttons and/or keys, as well as use in [[Using Debugger Macros|macros]]. This section describes buttons and keys you can set in a [[Setting up the ui.xml file|mapping file]] or by using a [[Default settings of buttons and hot keys|mapping command]] to reconfigure the user interface. </span> | ||
<span class="f_Para">The act of associating a button or key with a command or macro (multiple commands) is termed "mapping." </span> | <span class="f_Para">The act of associating a button or key with a command or macro (multiple commands) is termed "mapping." </span> | ||
<span class="f_Para">[[ | <span class="f_Para">[[Client Command Reference|The Client command reference]] describes the available commands. The default hot keys and buttons with which some of these commands are associated are summarized [[Default settings of buttons and hot keys|later.]] </span> | ||
=== Named buttons and separators === | === Named buttons and separators === | ||
<span class="f_Para">When mapping a command or macro to a button in the </span>< | <span class="f_Para">When mapping a command or macro to a button in the </span><var>ui.xml</var><span class="f_Para"> file, you refer to the button by name: </span> | ||
*From left to right, the fifteen mappable buttons in the [[review_common_buttons.html|main button bar]] are named<span class=" | *From left to right, the fifteen mappable buttons in the [[review_common_buttons.html|main button bar]] are named <span class="term">button0,</span><span class="f_ListBul1"> </span><span class="term">button1,</span><span class="f_ListBul1"> . . . </span><span class="term">button14.</span><span class="f_ListBul1"> The buttons have initial [[Default settings of buttons and hot keys|default mappings.]] </span> | ||
*The fifteen mappable buttons in the [[review_common_buttons.html#launch_second_bar|extra button bar]] are named </span><span class=" | *The fifteen mappable buttons in the [[review_common_buttons.html#launch_second_bar|extra button bar]] are named </span><span class="term">extrabutton0,</span><span class="f_ListBul1"> </span><span class="term">extrabutton1,</span><span class="f_ListBul1"> . . . </span><span class="term">extrabutton14.</span><span class="f_ListBul1"> These buttons have </span>'''no'''<span class="f_ListBul1"> initial default mappings. </span> | ||
'''''Only button bar buttons are mappable.''''' No other Client buttons are mappable. | |||
<span class="f_Para">An additional option</span><span class="f_ListBul1"> </span><span class="f_Para">is to map a named button to a special command keyword (</span><span class=" | <span class="f_Para">An additional option</span><span class="f_ListBul1"> </span><span class="f_Para">is to map a named button to a special command keyword (</span><span class="term">separator</span><span class="f_Para">) that converts the button to a </span><span class="term">separator</span><span class="f_Para">, a button whose sole function is to provide a visual separation between buttons, say for better visual discrimination or to create button groupings. Such a button is always dimmed and not responsive. </span> | ||
<span class="f_Para">The </span><span class=" | <span class="f_Para">The </span><span class="term">separator</term><span class="f_Para"> keyword is available for the </span><span class="f_Monospace">[[mapButton command|mapButton]]</span><span class="f_Para"> command and the mapping file </span><span class="f_Monospace">[[Default settings of buttons and hot keys|mapping]]</span><span class="f_Para"> element. </span> | ||
<span class="f_Para">The following image shows a newly created separator button: </span> | <span class="f_Para">The following image shows a newly created separator button: </span> | ||
| Line 38: | Line 38: | ||
<span class="f_Para">Often, a keyboard shortcut is the best way to do an important operation. You may map a keyboard shortcut to any alphabetic key (lowercase and uppercase are differentiated), numeric key, or to any of the function keys except F1 (that is, F2, F3, . . . F12). As with mapping buttons, you can specify an Alt or Ctrl modifier key for a keyboard shortcut. </span> | <span class="f_Para">Often, a keyboard shortcut is the best way to do an important operation. You may map a keyboard shortcut to any alphabetic key (lowercase and uppercase are differentiated), numeric key, or to any of the function keys except F1 (that is, F2, F3, . . . F12). As with mapping buttons, you can specify an Alt or Ctrl modifier key for a keyboard shortcut. </span> | ||
<span class="f_Para">To be reminded of the current ([[ | <span class="f_Para">To be reminded of the current ([[Default settings of buttons and hot keys|default]] as well as mapped) keyboard shortcuts, select </span><span class="term">Keyboard Shortcuts</span><span class="f_Para"> from the </span><span class="term">Help</span><span class="f_Para"> menu. </span> | ||
Revision as of 16:06, 22 September 2022
Commands
The operations you perform from the Client GUI are available as commands you can assign to different buttons and/or keys, as well as use in macros. This section describes buttons and keys you can set in a mapping file or by using a mapping command to reconfigure the user interface.
The act of associating a button or key with a command or macro (multiple commands) is termed "mapping."
The Client command reference describes the available commands. The default hot keys and buttons with which some of these commands are associated are summarized later.
Named buttons and separators
When mapping a command or macro to a button in the ui.xml file, you refer to the button by name:
- From left to right, the fifteen mappable buttons in the main button bar are named button0, button1, . . . button14. The buttons have initial default mappings.
- The fifteen mappable buttons in the extra button bar are named extrabutton0, extrabutton1, . . . extrabutton14. These buttons have no initial default mappings.
Only button bar buttons are mappable. No other Client buttons are mappable.
An additional option is to map a named button to a special command keyword (separator) that converts the button to a separator, a button whose sole function is to provide a visual separation between buttons, say for better visual discrimination or to create button groupings. Such a button is always dimmed and not responsive.
The separator</term> keyword is available for the mapButton command and the mapping file mapping element.
The following image shows a newly created separator button:
Button modifiers
Normally, when you map a command or macro to a button, the command or macro is executed when you click the button. However, you can also map a command or macro to a "modified" button: the command or macro executes only when you click a button while you are holding down the ALT or CTRL key on your keyboard.
This mechanism lets you map multiple commands or macros to one button. The usual click of the button executes one command or macro, while pressing Alt and clicking the button executes a second command or macro, and pressing CTRL and clicking the button executes a third command or macro.
A button's label is not affected by specifying a modifier for the button. The label always indicates the primary, unmodified, function of the button.
Keyboard shortcuts
Often, a keyboard shortcut is the best way to do an important operation. You may map a keyboard shortcut to any alphabetic key (lowercase and uppercase are differentiated), numeric key, or to any of the function keys except F1 (that is, F2, F3, . . . F12). As with mapping buttons, you can specify an Alt or Ctrl modifier key for a keyboard shortcut.
To be reminded of the current (default as well as mapped) keyboard shortcuts, select Keyboard Shortcuts from the Help menu.