HTML Dialog - Revision history

WikiSysop at 00:46, 2 May 2024

2024-05-02T00:46:21Z

← Older revision		Revision as of 18:46, 1 May 2024
Line 105:		Line 105:
	'''Interaction:''' Read Only		'''Interaction:''' Read Only

	'''Returns:''' (integer) Width of dialog window in pixels when user closed the dialog.		'''Returns:''' (integer) Width of dialog window in pixels when user closed the dialog.

	'''For Example:'''		'''For Example:'''
Line 116:		Line 116:
	'''Interaction:''' Read Only		'''Interaction:''' Read Only

	'''Returns:''' (integer) Height of dialog window in pixels when user closed the dialog.		'''Returns:''' (integer) Height of dialog window in pixels when user closed the dialog.

	'''For Example:'''		'''For Example:'''
Line 406:		Line 406:

	===:GetDoubleField(string id)===		===:GetDoubleField(string id)===
	'''Returns:''' a double containing current value of a text input box displaying a double value in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddDoubleField before the dialog was displayed.		'''Returns:''' a double containing current value of a text input box displaying a double value in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddDoubleField before the dialog was displayed.

	::''element_id (string)Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)		::''element_id (string)Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)
Line 422:		Line 422:

	===:GetLabelField(string id)===		===:GetLabelField(string id)===
	'''Returns:''' a string containing current value of an element in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddLabelField before the dialog was displayed.		'''Returns:''' a string containing current value of an element in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddLabelField before the dialog was displayed.
	~~::''~~element_id'' (string)Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)		element_id (string) Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)


	===:GetRadioIndex(string id)===		===:GetRadioIndex(string id)===
	'''Returns:''' an integer containing current value of a radio group in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddRadioGroup before the dialog was displayed.		'''Returns:''' an integer containing current value of a radio group in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddRadioGroup before the dialog was displayed.

	~~::''~~element_id'' (string)Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)		element_id (string)Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)


Line 435:		Line 435:
	'''Returns:''' a string containing current value of a text input box element in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddTextField before the dialog was displayed.		'''Returns:''' a string containing current value of a text input box element in the HTML with id=<q>element_id</q> . The field must have been created with a previous call to AddTextField before the dialog was displayed.

	~~::''~~element_id'' (string)Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)		element_id (string) Id of the element in HTML to get value for (id=<q> element_id</q> in HTML)

	====Example Code:====		====Example Code:====
Line 442:		Line 442:
	===:GetTool (string element_ id)===		===:GetTool (string element_ id)===
	[[File:Top.jpg\|right\|30px\|link=HTML Dialog]]		[[File:Top.jpg\|right\|30px\|link=HTML Dialog]]
	'''Returns:''' the Tool selected by the ToolPicker with the passed id.		'''Returns:''' the Tool selected by the ToolPicker with the passed id.
	element_id (string)Id of the button element in HTML to use (id=<q>element_id</q> in HTML). The button MUST have class = <q>ToolPicker</q>		element_id (string)Id of the button element in HTML to use (id=<q>element_id</q> in HTML). The button MUST have class = <q>ToolPicker</q>

WikiSysop: /* :AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-12T00:25:34Z

:AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 18:25, 11 March 2024
Line 155:		Line 155:


	'''Example of TextField'''		'''Example of TextField''' (Revised: Mar 13, 2024)
	<nowiki>For HTML: For picker associated with an edit field:		<nowiki>For HTML: For picker associated with an edit field:
	<input name="textfield" type="text" size="40" maxlength="128" id="DirNameEdit">		<input name="textfield" type="text" size="40" maxlength="128" id="DirNameEdit">
Line 165:		Line 165:


	'''Example of LabelField'''		'''Example of LabelField''' (Revised: Mar 13, 2024)
	<nowiki>HTML for picker associated with a label field:		<nowiki>HTML for picker associated with a label field:
	<span id="DirNameLabel">< or span>		<span id="DirNameLabel">< or span>

WikiSysop: /* :AddFilePicker(bool File_can_be_new, string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-12T00:24:27Z

:AddFilePicker(bool File_can_be_new, string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 18:24, 11 March 2024
Line 241:		Line 241:
	::''buddy_is_edit (bool) true if the <q>buddy</q> field is an edit field (added with AddTextField), false if <q>buddy</q> is a label field (added with AddLabelField).''		::''buddy_is_edit (bool) true if the <q>buddy</q> field is an edit field (added with AddTextField), false if <q>buddy</q> is a label field (added with AddLabelField).''

	'''Example of TextField''' (Revised: ~~May 21~~, ~~2020~~)		'''Example of TextField''' (Revised: Mar 13, 2024)
	HTML:		HTML:
	For picker associated with an edit text field:		For picker associated with an edit text field:
Line 257:		Line 257:
	dialog:AddDirectoryPicker(false, "ChooseFileButton1", "FileNameEdit", true)		dialog:AddDirectoryPicker(false, "ChooseFileButton1", "FileNameEdit", true)

	'''Example of LabelField''' (Revised: ~~May 21~~, ~~2020~~)		'''Example of LabelField''' (Revised: Mar 13, 2024)
	HTML:		HTML:
	For picker associated with a label field:		For picker associated with a label field:

WikiSysop: /* :AddFilePicker(bool File_can_be_new, string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-12T00:05:19Z

:AddFilePicker(bool File_can_be_new, string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 18:05, 11 March 2024
Line 244:		Line 244:
	HTML:		HTML:
	For picker associated with an edit text field:		For picker associated with an edit text field:
	<input name="textfield" type="text" size="40" maxlength="128" ID="FileNameEdit">		<input name="textfield" type="text" size="40" maxlength="128" id="FileNameEdit">
	<~~BUTTON CLASS~~="FilePicker" ID="ChooseFileButton1" type=button>Choose~~:< or BUTTON~~>		<input clase="FilePicker" id="ChooseFileButton1" name="ChooseFileButton1" type=button value="Choose">

	Lua:		Lua:
Line 260:		Line 260:
	HTML:		HTML:
	For picker associated with a label field:		For picker associated with a label field:
	<nowiki><span id="FileNameLabel">< or span~~></nowiki~~>		<nowiki><span id="FileNameLabel">< or span>
	<~~BUTTON CLASS~~="FilePicker" ID="ChooseFileButton2" type=button>Choose~~:< or BUTTON~~>		<imput class="FilePicker" id="ChooseFileButton2" name="ChooseFileButton2" type=button value="Choose" >

	Lua:		Lua:
Line 271:		Line 271:
	For picker associated with existing file and a label field:		For picker associated with existing file and a label field:
	dialog:AddLabelField("FileNameLabel", "c:\\")		dialog:AddLabelField("FileNameLabel", "c:\\")
	dialog:AddFilePicker(false, "ChooseFileButton2", "FileNameLabel", false)		dialog:AddFilePicker(false, "ChooseFileButton2", "FileNameLabel", false) </nowiki>

	===:AddIntegerField(string element_ id, integer value)===		===:AddIntegerField(string element_ id, integer value)===

WikiSysop: /* :AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-11T23:55:18Z

:AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 17:55, 11 March 2024
Line 150:		Line 150:
	::''The button '''MUST''' have class = <q>DirectoryPicker</q>''		::''The button '''MUST''' have class = <q>DirectoryPicker</q>''
	::''element_id (string) id of the button element in HTML to use (id=<q>element_id</q> in HTML)''		::''element_id (string) id of the button element in HTML to use (id=<q>element_id</q> in HTML)''
	::''element_name (string) name of the button element in HTML ~~to use~~ (name=<q>element_name</q> in HTML)''		::''element_name (string) name of the button element in HTML is '''Required''' (name=<q>element_name</q> in HTML)''
	::''buddy_name (string) id of associated label or edit field which will hold the value the user picks''		::''buddy_name (string) id of associated label or edit field which will hold the value the user picks''
	::''buddy_is_edit(bool) true if the <q>buddy</q> field is an edit field (added with AddTextField), false if <q>buddy</q> is a label field (added with AddLabelField).''		::''buddy_is_edit(bool) true if the <q>buddy</q> field is an edit field (added with AddTextField), false if <q>buddy</q> is a label field (added with AddLabelField).''
Line 168:		Line 168:
	<nowiki>HTML for picker associated with a label field:		<nowiki>HTML for picker associated with a label field:
	<span id="DirNameLabel">< or span>		<span id="DirNameLabel">< or span>
	<input class="DirectoryPicker" id="ChooseDirButton2" type=button value="Choose">		<input class="DirectoryPicker" id="ChooseDirButton2" name="ChooseDirButton2" type=button value="Choose">

	For Lua: For picker associated with a label field:		For Lua: For picker associated with a label field:

WikiSysop: /* :AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-11T23:52:55Z

:AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 17:52, 11 March 2024
Line 148:		Line 148:

	::'''NOTE:''' The <Button > element '''MUST''' have a class = <q>DirectoryPicker</q> set		::'''NOTE:''' The <Button > element '''MUST''' have a class = <q>DirectoryPicker</q> set
	::''element_id (string) Id of the button element in HTML to use (id=<q>element_id</q> in HTML)~~. The button~~ '''~~MUST~~'~~'' have class~~ = <q>~~DirectoryPicker~~</q>''		::''The button '''MUST''' have class = <q>DirectoryPicker</q>''
			::''element_id (string) id of the button element in HTML to use (id=<q>element_id</q> in HTML)''
			::''element_name (string) name of the button element in HTML to use (name=<q>element_name</q> in HTML)''
	::''buddy_name (string) id of associated label or edit field which will hold the value the user picks''		::''buddy_name (string) id of associated label or edit field which will hold the value the user picks''
	::''buddy_is_edit(bool) true if the <q>buddy</q> field is an edit field (added with AddTextField), false if <q>buddy</q> is a label field (added with AddLabelField).''		::''buddy_is_edit(bool) true if the <q>buddy</q> field is an edit field (added with AddTextField), false if <q>buddy</q> is a label field (added with AddLabelField).''
Line 155:		Line 157:
	'''Example of TextField'''		'''Example of TextField'''
	<nowiki>For HTML: For picker associated with an edit field:		<nowiki>For HTML: For picker associated with an edit field:
	<input name="textfield" type="text" size="40" maxlength="128" id="DirNameEdit">		<input name="textfield" type="text" size="40" maxlength="128" id="DirNameEdit">
	<input class="DirectoryPicker" id="ChooseDirButton1" type=button value="Choose">		<input class="DirectoryPicker" id="ChooseDirButton1" name="ChooseDirButton1" type=button value="Choose">

	Lua for picker associated with an editable text field:		Lua for picker associated with an editable text field:

WikiSysop: /* :AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-11T23:39:34Z

:AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 17:39, 11 March 2024
Line 155:		Line 155:
	'''Example of TextField'''		'''Example of TextField'''
	<nowiki>For HTML: For picker associated with an edit field:		<nowiki>For HTML: For picker associated with an edit field:
	<input name="textfield" type="text" size="40" maxlength="128" ID="DirNameEdit">		<input name="textfield" type="text" size="40" maxlength="128" id="DirNameEdit">
	<~~BUTTON CLASS~~="DirectoryPicker" ID="ChooseDirButton1" type=button>Choose~~:< or BUTTON~~>		<input class="DirectoryPicker" id="ChooseDirButton1" type=button value="Choose">

	Lua for picker associated with an editable text field:		Lua for picker associated with an editable text field:
	dialog:AddTextField("DirNameEdit", "c:\\temp");		dialog:AddTextField("DirNameEdit", "c:\\temp");
	dialog:AddDirectoryPicker("ChooseDirButton1", "DirNameEdit", true); </nowiki>		dialog:AddDirectoryPicker("ChooseDirButton1", "DirNameEdit", true); </nowiki>


	'''Example of LabelField'''		'''Example of LabelField'''
	<nowiki>HTML for picker associated with a label field:		<nowiki>HTML for picker associated with a label field:
	<span id="DirNameLabel">< or span>		<span id="DirNameLabel">< or span>
	<~~BUTTON CLASS~~="DirectoryPicker" ID="ChooseDirButton2" type=button>Choose~~:< or BUTTON~~>		<input class="DirectoryPicker" id="ChooseDirButton2" type=button value="Choose">

	For Lua: For picker associated with a label field:		For Lua: For picker associated with a label field:

WikiSysop: /* :AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-11T23:32:41Z

:AddDirectoryPicker(string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 17:32, 11 March 2024
Line 155:		Line 155:
	'''Example of TextField'''		'''Example of TextField'''
	<nowiki>For HTML: For picker associated with an edit field:		<nowiki>For HTML: For picker associated with an edit field:
	<input name="textfield" type="text" size="40" maxlength="128" ID="DirNameEdit">		<input name="textfield" type="text" size="40" maxlength="128" ID="DirNameEdit">
	<BUTTON CLASS="DirectoryPicker" ID="ChooseDirButton1" type=button>Choose:< or BUTTON>		<BUTTON CLASS="DirectoryPicker" ID="ChooseDirButton1" type=button>Choose:< or BUTTON>

	Lua for picker associated with an editable text field:		Lua for picker associated with an editable text field:
	dialog:AddTextField("DirNameEdit", "c:\\temp");		dialog:AddTextField("DirNameEdit", "c:\\temp");
	dialog:AddDirectoryPicker("ChooseDirButton1", "DirNameEdit", true); </nowiki>		dialog:AddDirectoryPicker("ChooseDirButton1", "DirNameEdit", true); </nowiki>

	'''Example of LabelField'''		'''Example of LabelField'''
	<nowiki>HTML for picker associated with a label field:		<nowiki>HTML for picker associated with a label field:
	<span id="DirNameLabel">< or span>		<span id="DirNameLabel">< or span>
	<BUTTON CLASS="DirectoryPicker" ID="ChooseDirButton2" type=button>Choose:< or BUTTON>		<BUTTON CLASS="DirectoryPicker" ID="ChooseDirButton2" type=button>Choose:< or BUTTON>

	For Lua: For picker associated with a label field:		For Lua: For picker associated with a label field:

WikiSysop: /* :AddFilePicker(bool File_can_be_new, string element_ id, string buddy_name, bool buddy_is_edit) */

2024-03-11T23:12:52Z

:AddFilePicker(bool File_can_be_new, string element_ id, string buddy_name, bool buddy_is_edit)

← Older revision		Revision as of 17:12, 11 March 2024
Line 263:		Line 263:
	For picker associated with new file and a label field:		For picker associated with new file and a label field:
	dialog:AddLabelField("FileNameLabel", "c:\\")		dialog:AddLabelField("FileNameLabel", "c:\\")
	dialog:~~AddDirectoryPicker~~(true, "ChooseFileButton2", "FileNameLabel", false)		dialog:AddFilePicker(true, "ChooseFileButton2", "FileNameLabel", false)

	Lua:		Lua:
	For picker associated with existing file and a label field:		For picker associated with existing file and a label field:
	dialog:AddLabelField("FileNameLabel", "c:\\")		dialog:AddLabelField("FileNameLabel", "c:\\")
	dialog:~~AddDirectoryPicker~~(false, "ChooseFileButton2", "FileNameLabel", false)		dialog:AddFilePicker(false, "ChooseFileButton2", "FileNameLabel", false)

	===:AddIntegerField(string element_ id, integer value)===		===:AddIntegerField(string element_ id, integer value)===

WikiSysop: /* Methods */

2024-03-11T22:27:37Z

Methods

← Older revision		Revision as of 16:27, 11 March 2024
Line 159:		Line 159:

	Lua for picker associated with an editable text field:		Lua for picker associated with an editable text field:
	dialog:AddTextField("DirNameEdit", "c:\\temp");		dialog:AddTextField("DirNameEdit", "c:\\temp");
	dialog:AddDirectoryPicker("ChooseDirButton1", "DirNameEdit", true); </nowiki>		dialog:AddDirectoryPicker("ChooseDirButton1", "DirNameEdit", true); </nowiki>

	'''Example of LabelField'''		'''Example of LabelField'''
Line 168:		Line 168:

	For Lua: For picker associated with a label field:		For Lua: For picker associated with a label field:
	dialog:AddLabelField("DirNameLabel", "c:\\");		dialog:AddLabelField("DirNameLabel", "c:\\");
	dialog:AddDirectoryPicker("ChooseDirButton2", "DirNameLabel", false); </nowiki>		dialog:AddDirectoryPicker("ChooseDirButton2", "DirNameLabel", false); </nowiki>

	===:AddDoubleField(string element_ id, double value)===		===:AddDoubleField(string element_ id, double value)===