ClearButton command: Difference between revisions

From m204wiki
Jump to navigation Jump to search
(Created page with "__TOC__ {| |width="50%"| '''Action:''' |width="50%"| <span class="f_Para">Removes all previously set mappings for a partic...")
 
No edit summary
Line 3: Line 3:
|width="50%"| '''Action:'''
|width="50%"| '''Action:'''
|width="50%"|
|width="50%"|
<span class="f_Para">Removes all previously set [[intro_configurable_components.html#named_buttons|mappings]] for a particular Client button. </span>
<span class="f_Para">Removes all previously set [[Introducing the configurable components#Named buttons and separators|mappings]] for a particular Client button. </span>


'''Syntax:'''
'''Syntax:'''
Line 10: Line 10:
where ''buttonName'' is one of:
where ''buttonName'' is one of:


*''button0, button1, ... button14'', the names of the [[review_common_buttons.html|main button bar]] buttons  </span>
*''button0, button1, ... button14'', the names of the [[Button Bar|main button bar]] buttons  </span>
*''extraButton0, extraButton1, ... extraButton14'', the names of the [[Button Bar#Launching a second button bar|extra button bar]] buttons  </span>


*''extraButton0, extraButton1, ... extraButton14'', the names of the [[review_common_buttons.html#launch_second_bar|extra button bar]] buttons  </span>
After you execute the command, the button is removed immediately from the button bar to which it applies but '''not'''<span class="f_Para"> from the mapping file (</span><span class="f_Monospace">ui.xml</span><span class="f_Para"> or </span><span class="f_Monospace">uimore.xml</span><span class="f_Para">) if it was specified there. A restart of the Client restores any mappings you remove with </span>''clearButton'',<span class="f_Para"> if they were in the </span><span class="f_Monospace">ui.xml</span><span class="f_Para"> or </span><span class="f_Monospace">uimore.xml</span><span class="f_Para"> file. </span>


<span class="f_Para">After you execute the command, the button is removed immediately from the button bar to which it applies but </span><span class="f_EmphBold">not</span><span class="f_Para"> from the mapping file (</span><span class="f_Monospace">ui.xml</span><span class="f_Para"> or </span><span class="f_Monospace">uimore.xml</span><span class="f_Para">) if it was specified there. A restart of the Client restores any mappings you remove with </span>''clearButton'',<span class="f_Para"> if they were in the </span><span class="f_Monospace">ui.xml</span><span class="f_Para"> or </span><span class="f_Monospace">uimore.xml</span><span class="f_Para"> file. </span>
<span class="f_Para">See also the </span><span class="f_Monospace">[[mapButton command|mapButton]]</span><span class="f_Para"> command. </span>
 
<span class="f_Para">See also the </span><span class="f_Monospace">[[mapbutton_cmd.html|mapButton]]</span><span class="f_Para"> command. </span>
|-
|-
| '''Client menu:'''
| '''Client menu:'''

Revision as of 03:51, 29 November 2022

Action:

Removes all previously set mappings for a particular Client button.

Syntax:

clearButton buttonName

where buttonName is one of:

  • button0, button1, ... button14, the names of the main button bar buttons  
  • extraButton0, extraButton1, ... extraButton14, the names of the extra button bar buttons  

After you execute the command, the button is removed immediately from the button bar to which it applies but not from the mapping file (ui.xml or uimore.xml) if it was specified there. A restart of the Client restores any mappings you remove with clearButton, if they were in the ui.xml or uimore.xml file.

See also the mapButton command.

Client menu: --
Introduced: Build 57