Reconfiguring GUI buttons and hot keys - Revision history

Ekern at 18:55, 6 January 2023

2023-01-06T18:55:17Z

← Older revision		Revision as of 18:55, 6 January 2023
Line 19:		Line 19:
	<span class="f_Para">There is another way to set buttons or keyboard shortcuts that does not involve a mapping file or a Client restart: </span>		<span class="f_Para">There is another way to set buttons or keyboard shortcuts that does not involve a mapping file or a Client restart: </span>

	: 1. From the Client's [[Using the console and command line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[~~using_debuggertools_obj.html~~\|DebuggerTools]] class, issue these commands as necessary:		: 1. From the Client's [[Using the console and command line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[Using the DebuggerTools class methods\|DebuggerTools]] class, issue these commands as necessary:

	* [[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want		* [[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want

Ekern at 18:49, 28 September 2022

2022-09-28T18:49:33Z

← Older revision		Revision as of 18:49, 28 September 2022
Line 21:		Line 21:
	: 1. From the Client's [[Using the console and command line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html\|DebuggerTools]] class, issue these commands as necessary:		: 1. From the Client's [[Using the console and command line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html\|DebuggerTools]] class, issue these commands as necessary:

	*[[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want		* [[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want
	*[[mapKey command\|mapKey]], which specifies the keyboard shortcut you want		* [[mapKey command\|mapKey]], which specifies the keyboard shortcut you want
	*[[clearButton command\|clearButton]], which removes the button mapping you specify		* [[clearButton command\|clearButton]], which removes the button mapping you specify
	*[[clearKey command\|clearKey]], which removes the keyboard shortcut you specify		* [[clearKey command\|clearKey]], which removes the keyboard shortcut you specify

	: 2. View the button arrangement or test the key combination you specified or removed.		: 2. View the button arrangement or test the key combination you specified or removed.

Ekern at 18:11, 28 September 2022

2022-09-28T18:11:24Z

Ekern at 16:48, 26 September 2022

2022-09-26T16:48:36Z

Ekern at 01:57, 20 September 2022

2022-09-20T01:57:51Z

← Older revision		Revision as of 01:57, 20 September 2022
Line 11:		Line 11:

	==== Using a mapping file ====		==== Using a mapping file ====
	1. [[Setting up the ui.xml file\|Create]] an XML file that contains the [[Client Command Reference\|command]] or [[Using Debugger Macros\|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. ~~</span><span class="f_ListContinue">~~This file must be named <~~/span~~>~~'''~~ui.xml~~'''~~<~~span class="f_ListContinue"~~> and ~~</span><span class="f_Para">~~[[change_location_client_work.html\|is assumed]]~~</span><span class="f_ListContinue">~~ to reside in the installation target folder (along with the JanusDebugger.exe Client program). ~~</span><span class="f_Para">~~) Its location can be changed [[change_location_client_work.html\|in the Client configuration file]].~~</span>~~		1. [[Setting up the ui.xml file\|Create]] an XML file that contains the [[Client Command Reference\|command]] or [[Using Debugger Macros\|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. This file must be named <var>ui.xml</var> and [[change_location_client_work.html\|is assumed]] to reside in the installation target folder (along with the JanusDebugger.exe Client program). ) Its location can be changed [[change_location_client_work.html\|in the Client configuration file]].

	2. Restart the Debugger Client.		2. Restart the Debugger Client.
Line 27:		Line 27:

	2. View the button arrangement or test the key combination you specified or removed.		2. View the button arrangement or test the key combination you specified or removed.
			: Unless you changed only a button modifier (a key you press along with clicking the button), an updated button's new label is displayed and the button is available for immediate use. A cleared button is removed immediately from its button bar. The button mapping and hot key updates you make with mapButton or mapKey are '''not''' reflected in the ui.xml file, and do not persist over a restart of the Client.

	Unless you changed only a button modifier (a key you press along with clicking the button), an updated button's new label is displayed and the button is available for immediate use. A cleared button is removed immediately from its button bar. The button mapping and hot key updates you make with mapButton or mapKey are '''not''' reflected in the ui.xml file, and do not persist over a restart of the Client.		Additional Client commands let you modify buttons:

	~~<span class="f_Para">~~Additional Client commands let you modify buttons: ~~</span>~~

	*[[disableButton command\|disableButton]] and [[enableButton command\|enableButton]] disable and enable button bar buttons.		*[[disableButton command\|disableButton]] and [[enableButton command\|enableButton]] disable and enable button bar buttons.
	*[[labelButton command\|labelButton]] lets you replace the label of a button.		*[[labelButton command\|labelButton]] lets you replace the label of a button.

	~~<span class="f_Para">~~The following sections discuss the eligible commands, buttons, and keys, how you create a ~~</span>~~<var>ui.xml</var~~><span class="f_Para"~~> file for their reconfigurations, and what their default settings are: ~~</span>~~		The following sections discuss the eligible commands, buttons, and keys, how you create a <var>ui.xml</var> file for their reconfigurations, and what their default settings are:
			*[[intro_configurable_components.html\|Introducing the configurable components]]
	~~<span class="f_SimpleListText">~~[[intro_configurable_components.html\|Introducing the configurable components]]~~</span><span class="f_SimpleList"> </span>~~		*[[Setting up the ui.xml file\|Setting up the ui.xml file]]
			*[[Default settings of buttons and hot keys\|Default settings of buttons and hot keys]]
	~~<span class="f_SimpleListText">~~[[Setting up the ui.xml file\|Setting up the ui.xml file]] ~~</span>~~

	~~<span class="f_SimpleListText">~~[[Default settings of buttons and hot keys\|Default settings of buttons and hot keys]] ~~</span>~~

	[[Category:Debugger Home]]		[[Category:Debugger Home]]

Ekern: Created page with "TOC The fifteen buttons in the main button bar (and those in any [..."

2022-09-19T14:41:49Z

Created page with "__TOC__ The fifteen buttons in the main button bar (and those in any [..."

New page

__TOC__
The fifteen [[intro_configurable_components.html#named_buttons|buttons]] in the [[review_common_buttons.html|main button bar]] (and those in any [[review_common_buttons.html#launch_second_bar|extra button bar]]) are fully configurable. You can set the buttons to perform commands or macros, and you can change their positions or add [[intro_configurable_components.html#named_buttons|separator buttons]]. 

You may also create your own [[intro_configurable_components.html#keyboard_shortcut|keyboard shortcuts]] (also called "hot keys") for commonly used commands. 

If necessary, you can even provide an alternative customization that overrides the primary reconfiguration. This lets you provide, say, group level settings that may be overridden by individual level settings. 

The default setting of a configurable button is provided where the individual button is discussed in this document, and the settings are also summarized [[Default settings of buttons and hot keys|later]] in this section. 

To reconfigure buttons or keyboard shortcuts, you can define a mapping file or use a Client command. 

==== Using a mapping file ====
1. [[Setting up the ui.xml file|Create]] an XML file that contains the [[Client Command Reference|command]] or [[Using Debugger Macros|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. This file must be named '''ui.xml''' and [[change_location_client_work.html|is assumed]] to reside in the installation target folder (along with the JanusDebugger.exe Client program). ) Its location can be changed [[change_location_client_work.html|in the Client configuration file]].

2. Restart the Debugger Client.

==== Using a Client command ====

There is another way to set buttons or keyboard shortcuts that does not involve a mapping file or a Client restart: 

1. From the Client's [[using_macro_console_cmdline.html#macro_command_line|Command Line]] tool, or within a [[Using Debugger Macros|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html|DebuggerTools]] class, issue these commands as necessary:

*[[mapButton command|mapButton]], which specifies the button [[setup_ui_xml_file.html#mapping_element|mapping]] you want
*[[mapKey command|mapKey]], which specifies the keyboard shortcut you want
*[[clearButton command|clearButton]], which removes the button mapping you specify
*[[clearKey command|clearKey]], which removes the keyboard shortcut you specify

2. View the button arrangement or test the key combination you specified or removed.

Unless you changed only a button modifier (a key you press along with clicking the button), an updated button's new label is displayed and the button is available for immediate use. A cleared button is removed immediately from its button bar. The button mapping and hot key updates you make with mapButton or mapKey are '''not''' reflected in the ui.xml file, and do not persist over a restart of the Client.

Additional Client commands let you modify buttons: 

*[[disableButton command|disableButton]] and [[enableButton command|enableButton]] disable and enable button bar buttons.
*[[labelButton command|labelButton]] lets you replace the label of a button.

The following sections discuss the eligible commands, buttons, and keys, how you create a <var>ui.xml</var> file for their reconfigurations, and what their default settings are: 

[[intro_configurable_components.html|Introducing the configurable components]] 

[[Setting up the ui.xml file|Setting up the ui.xml file]] 

[[Default settings of buttons and hot keys|Default settings of buttons and hot keys]] 

[[Category:Debugger Home]]

← Older revision		Revision as of 18:11, 28 September 2022
Line 10:		Line 10:
	<span class="f_Para">To reconfigure buttons or keyboard shortcuts, you can define a mapping file or use a Client command. </span>		<span class="f_Para">To reconfigure buttons or keyboard shortcuts, you can define a mapping file or use a Client command. </span>

	==== Using a mapping file ====		=== Using a mapping file ===
	1. [[Setting up the ui.xml file\|Create]] an XML file that contains the [[Client Command Reference\|command]] or [[Using Debugger Macros\|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. This file must be named <var>ui.xml</var> and [[ Changing the location of Client work files\|is assumed]] to reside in the installation target folder (along with the JanusDebugger.exe Client program). ) Its location can be changed [[ Changing the location of Client work files\|in the Client configuration file]].		: 1. [[Setting up the ui.xml file\|Create]] an XML file that contains the [[Client Command Reference\|command]] or [[Using Debugger Macros\|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. This file must be named <var>ui.xml</var> and [[ Changing the location of Client work files\|is assumed]] to reside in the installation target folder (along with the JanusDebugger.exe Client program). ) Its location can be changed [[ Changing the location of Client work files\|in the Client configuration file]].

	2. Restart the Debugger Client.		: 2. Restart the Debugger Client.

	==== Using a Client command ====		=== Using a Client command ===

	<span class="f_Para">There is another way to set buttons or keyboard shortcuts that does not involve a mapping file or a Client restart: </span>		<span class="f_Para">There is another way to set buttons or keyboard shortcuts that does not involve a mapping file or a Client restart: </span>

	1. From the Client's [[~~using_macro_console_cmdline.html#macro_command_line~~\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html\|DebuggerTools]] class, issue these commands as necessary:		: 1. From the Client's [[Using the console and command line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html\|DebuggerTools]] class, issue these commands as necessary:

	*[[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want		*[[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want
Line 26:		Line 26:
	*[[clearKey command\|clearKey]], which removes the keyboard shortcut you specify		*[[clearKey command\|clearKey]], which removes the keyboard shortcut you specify

	2. View the button arrangement or test the key combination you specified or removed.		: 2. View the button arrangement or test the key combination you specified or removed.
	: Unless you changed only a button modifier (a key you press along with clicking the button), an updated button's new label is displayed and the button is available for immediate use. A cleared button is removed immediately from its button bar. The button mapping and hot key updates you make with mapButton or mapKey are '''not''' reflected in the ui.xml file, and do not persist over a restart of the Client.		:: Unless you changed only a button modifier (a key you press along with clicking the button), an updated button's new label is displayed and the button is available for immediate use. A cleared button is removed immediately from its button bar. The button mapping and hot key updates you make with mapButton or mapKey are '''not''' reflected in the ui.xml file, and do not persist over a restart of the Client.

	Additional Client commands let you modify buttons:		Additional Client commands let you modify buttons:

← Older revision		Revision as of 16:48, 26 September 2022
Line 1:		Line 1:
	__TOC__		__TOC__
	<span class="f_Para">The fifteen [[~~intro_configurable_components.html~~#~~named_buttons~~\|buttons]] in the [[~~review_common_buttons.html~~\|main button bar]] (and those in any [[~~review_common_buttons.html~~#~~launch_second_bar~~\|extra button bar]]) are fully configurable. You can set the buttons to perform commands or macros, and you can change their positions or add [[~~intro_configurable_components.html~~#~~named_buttons~~\|separator buttons]]. </span>		<span class="f_Para">The fifteen [[Introducing the configurable components#Named buttons and separators\|buttons]] in the [[Button Bar\|main button bar]] (and those in any [[Button Bar#Launching a second button bar\|extra button bar]]) are fully configurable. You can set the buttons to perform commands or macros, and you can change their positions or add [[Introducing the configurable components#Named buttons and separators\|separator buttons]]. </span>

	<span class="f_Para">You may also create your own [[~~intro_configurable_components.html~~#~~keyboard_shortcut~~\|keyboard shortcuts]] (also called "hot keys") for commonly used commands. </span>		<span class="f_Para">You may also create your own [[Introducing the configurable components#Keyboard shortcuts\|keyboard shortcuts]] (also called "hot keys") for commonly used commands. </span>

	<span class="f_Para">If necessary, you can even provide an alternative customization that overrides the primary reconfiguration. </span><span class="f_Notes">This lets you provide, say, group level settings that may be overridden by individual level settings. </span>		<span class="f_Para">If necessary, you can even provide an alternative customization that overrides the primary reconfiguration. </span><span class="f_Notes">This lets you provide, say, group level settings that may be overridden by individual level settings. </span>
Line 11:		Line 11:

	==== Using a mapping file ====		==== Using a mapping file ====
	1. [[Setting up the ui.xml file\|Create]] an XML file that contains the [[Client Command Reference\|command]] or [[Using Debugger Macros\|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. This file must be named <var>ui.xml</var> and [[~~change_location_client_work.html~~\|is assumed]] to reside in the installation target folder (along with the JanusDebugger.exe Client program). ) Its location can be changed [[~~change_location_client_work.html~~\|in the Client configuration file]].		1. [[Setting up the ui.xml file\|Create]] an XML file that contains the [[Client Command Reference\|command]] or [[Using Debugger Macros\|macro]] (multiple commands) to execute paired with the button and/or key that invokes it. This file must be named <var>ui.xml</var> and [[ Changing the location of Client work files\|is assumed]] to reside in the installation target folder (along with the JanusDebugger.exe Client program). ) Its location can be changed [[ Changing the location of Client work files\|in the Client configuration file]].

	2. Restart the Debugger Client.		2. Restart the Debugger Client.
Line 21:		Line 21:
	1. From the Client's [[using_macro_console_cmdline.html#macro_command_line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html\|DebuggerTools]] class, issue these commands as necessary:		1. From the Client's [[using_macro_console_cmdline.html#macro_command_line\|Command Line]] tool, or within a [[Using Debugger Macros\|macro]], or from within a User Language request by using the ClientCommand method of the [[using_debuggertools_obj.html\|DebuggerTools]] class, issue these commands as necessary:

	*[[mapButton command\|mapButton]], which specifies the button [[~~setup_ui_xml_file~~.~~html~~#~~mapping_element~~\|mapping]] you want		*[[mapButton command\|mapButton]], which specifies the button [[Setting up the ui.xml file#To set up a ui.xml file:\|mapping]] you want
	*[[mapKey command\|mapKey]], which specifies the keyboard shortcut you want		*[[mapKey command\|mapKey]], which specifies the keyboard shortcut you want
	*[[clearButton command\|clearButton]], which removes the button mapping you specify		*[[clearButton command\|clearButton]], which removes the button mapping you specify
Line 34:		Line 34:

	The following sections discuss the eligible commands, buttons, and keys, how you create a <var>ui.xml</var> file for their reconfigurations, and what their default settings are:		The following sections discuss the eligible commands, buttons, and keys, how you create a <var>ui.xml</var> file for their reconfigurations, and what their default settings are:
	*[[~~intro_configurable_components.html~~\|Introducing the configurable components]]		*[[Introducing the configurable components\|Introducing the configurable components]]
	*[[Setting up the ui.xml file\|Setting up the ui.xml file]]		*[[Setting up the ui.xml file\|Setting up the ui.xml file]]
	*[[Default settings of buttons and hot keys\|Default settings of buttons and hot keys]]		*[[Default settings of buttons and hot keys\|Default settings of buttons and hot keys]]

	[[Category:Debugger Home]]		[[Category:Debugger Home]]