Programmer Guide/Macro Library/CMenu - Revision history

Jw: /* GetTable */

2018-11-14T11:00:51Z

GetTable

← Older revision		Revision as of 13:00, 14 November 2018
Line 266:		Line 266:
	===GetTable===		===GetTable===

	Returns the table to be used as an <code>AddPopup</code> parameter. Note that this will only return items which have a menu assigned.		Returns the table to be used as an <code>AddPopup</code> parameter. Note that this will only return items which have a menu key assigned (see [[#AddItem\|<samp>AddItem</samp>]]).

	=====Usage:=====		=====Usage:=====

Jw: /* GetTable */

2018-11-14T10:59:30Z

GetTable

← Older revision		Revision as of 12:59, 14 November 2018
Line 266:		Line 266:
	===GetTable===		===GetTable===

	Returns the table to be used as an <code>AddPopup</code> parameter.		Returns the table to be used as an <code>AddPopup</code> parameter. Note that this will only return items which have a menu assigned.

	=====Usage:=====		=====Usage:=====

Jw: /* UseHotkeyFile */

2018-11-09T09:04:42Z

UseHotkeyFile

← Older revision		Revision as of 11:04, 9 November 2018
Line 360:		Line 360:
	===UseHotkeyFile===		===UseHotkeyFile===

	Specify a hotkey file to read hotkeys from.		Specify a hotkey file to read hotkeys from. This should be called after menu items have been added, since it will only assign to existing entries.

	=====Usage:=====		=====Usage:=====

Jw: /* Result: */

2018-11-07T13:00:06Z

Result:

← Older revision		Revision as of 15:00, 7 November 2018
Line 357:		Line 357:

	An empty string on success and an error code on failure.		An empty string on success and an error code on failure.

			===UseHotkeyFile===

			Specify a hotkey file to read hotkeys from.

			=====Usage:=====

			<code><var>inst</var> UseHotkeyFile <var>hotkeyFileName</var></code>

			=====Parameters:=====

			;<var>hotkeyFileName</var>:The file name/path of the hotkey file to load.

			=====Result:=====

			-1 on failure.

	====CMenu Examples====		====CMenu Examples====

Jw: /* Parameters: */

2017-09-07T08:41:52Z

Parameters:

← Older revision		Revision as of 10:41, 7 September 2017
Line 43:		Line 43:
	:<code>hotkey</code> - The value associated with the key '<code>hotkey</code>' is parsed and the resulting string is appended to the item '<code>menu</code>' value. For example, the string '<code>Cc</code>' is converted into the hotkey 'Ctrl+C', whilst '<code>CA</code>' is converted to the hotkey 'Ctrl+Shift+A'. Note that the asterisk character <code>*</code> is not allowed as a hotkey.		:<code>hotkey</code> - The value associated with the key '<code>hotkey</code>' is parsed and the resulting string is appended to the item '<code>menu</code>' value. For example, the string '<code>Cc</code>' is converted into the hotkey 'Ctrl+C', whilst '<code>CA</code>' is converted to the hotkey 'Ctrl+Shift+A'. Note that the asterisk character <code>*</code> is not allowed as a hotkey.

	:<code>dynamicVariable</code> - The variable from which to read the 'X' string to use for dynamic menus. E.g. if the variable contains either 0 or 1, then the dynamic menus 'menu0' and 'menu1' can be defined using <code>AddItem()</code> and the menu item will be set accordingly when <code>GetTable()</code> is called. The dynamic variable must be a [[Programmer_Guide/General_Descriptions/Names,_Namespaces,_Keywords_and_Options#Variable_Names\|shell variable]].		:<code>dynamicVariable</code> - The variable from which to read the 'X' string to use for dynamic menus. E.g. if the variable contains either 0 or 1, then the dynamic menus 'menu0' and 'menu1' can be defined using <code>AddItem()</code> and the menu item will be set accordingly when <code>GetTable()</code> is called. The dynamic variable must be a [[Programmer_Guide/General_Descriptions/Names,_Namespaces,_Keywords_and_Options#Variable_Names\|shell or global variable]].

	:<code>menuX</code> - The dynamic menu item (used depending on the value of <code>dynamicVariable</code>).		:<code>menuX</code> - The dynamic menu item (used depending on the value of <code>dynamicVariable</code>).

Jw: /* Parameters: */

2017-09-07T08:41:39Z

Parameters:

← Older revision		Revision as of 10:41, 7 September 2017
Line 43:		Line 43:
	:<code>hotkey</code> - The value associated with the key '<code>hotkey</code>' is parsed and the resulting string is appended to the item '<code>menu</code>' value. For example, the string '<code>Cc</code>' is converted into the hotkey 'Ctrl+C', whilst '<code>CA</code>' is converted to the hotkey 'Ctrl+Shift+A'. Note that the asterisk character <code>*</code> is not allowed as a hotkey.		:<code>hotkey</code> - The value associated with the key '<code>hotkey</code>' is parsed and the resulting string is appended to the item '<code>menu</code>' value. For example, the string '<code>Cc</code>' is converted into the hotkey 'Ctrl+C', whilst '<code>CA</code>' is converted to the hotkey 'Ctrl+Shift+A'. Note that the asterisk character <code>*</code> is not allowed as a hotkey.

	:<code>dynamicVariable</code> - The variable from which to read the 'X' string to use for dynamic menus. E.g. if the variable contains either 0 or 1, then the dynamic menus 'menu0' and 'menu1' can be defined using <code>AddItem()</code> and the menu item will be set accordingly when <code>GetTable()</code> is called.		:<code>dynamicVariable</code> - The variable from which to read the 'X' string to use for dynamic menus. E.g. if the variable contains either 0 or 1, then the dynamic menus 'menu0' and 'menu1' can be defined using <code>AddItem()</code> and the menu item will be set accordingly when <code>GetTable()</code> is called. The dynamic variable must be a [[Programmer_Guide/General_Descriptions/Names,_Namespaces,_Keywords_and_Options#Variable_Names\|shell variable]].

	:<code>menuX</code> - The dynamic menu item (used depending on the value of <code>dynamicVariable</code>).		:<code>menuX</code> - The dynamic menu item (used depending on the value of <code>dynamicVariable</code>).

Jw: /* CMenu Examples */

2016-12-07T09:52:59Z

CMenu Examples

← Older revision		Revision as of 11:52, 7 December 2016
Line 388:		Line 388:
	$#cmenu additem ; menu=item1 ; hotkey=C1 ; cmd=cmd1 ; args=args1 ; id=command1		$#cmenu additem ; menu=item1 ; hotkey=C1 ; cmd=cmd1 ; args=args1 ; id=command1
	$#cmenu additem ; menu=item2 ; hotkey=C2 ; cmd=cmd2 ; args=args2 ; id=command2		$#cmenu additem ; menu=item2 ; hotkey=C2 ; cmd=cmd2 ; args=args2 ; id=command2
	$#cmenu additem ; menu=item3 ; hotkey=C3 ; cmd=cmd3 ; args=args3 ; id=command3		$#cmenu additem ; menu=item3 ; hotkey=C3 ; cmd=cmd3 ; args=args3 ; id=command3

	// add menu to dialog		// add menu to dialog

Jw at 11:26, 15 November 2016

2016-11-15T11:26:09Z

← Older revision		Revision as of 13:26, 15 November 2016
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|3}}
	==CMenu : CObj==		==CMenu : CObj==

Toni: moved Programmer Guide/Class Library/CMenu : CObj to Programmer Guide/Macro Library/CMenu

2011-04-28T07:58:43Z

moved Programmer Guide/Class Library/CMenu : CObj to Programmer Guide/Macro Library/CMenu

← Older revision	Revision as of 09:58, 28 April 2011
(No difference)

Admin: 1 revision: Initial import

2010-11-18T16:31:32Z

1 revision: Initial import

← Older revision	Revision as of 18:31, 18 November 2010
(No difference)