Programmer Guide/Shell Items - Revision history

Jw at 07:44, 15 March 2018

2018-03-15T07:44:31Z

← Older revision		Revision as of 09:44, 15 March 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{Shell}}
	{{Shell Item}}		{{Shell Item}}
	{\| class="wikitable"		{\| class="wikitable"

Jw: /* Protected shell items */

2016-10-25T06:59:42Z

Protected shell items

← Older revision		Revision as of 08:59, 25 October 2016
Line 207:		Line 207:

	==Protected shell items==		==Protected shell items==
	In some situations it may be useful to protect shell items from (accidental) deletion. Our first user of this feature is the[[Programmer_Guide/BScript\|script console]] which protects all its vital objects.		In some situations it may be useful to protect shell items from (accidental) deletion. Our first user of this feature is the [[Programmer_Guide/BScript\|script console]] which protects all its vital objects.

	{{STX}} implements two kinds of item protection:		{{STX}} implements two kinds of item protection:

Jw: /* References to shell items */

2016-03-31T11:28:30Z

References to shell items

← Older revision		Revision as of 13:28, 31 March 2016
Line 195:		Line 195:
	Shell item references are entities that ''refer to'' to a shell item instance. This works even if the owner of the target item (the item the reference is referring to) is a different shell, making shell item references a convenient way of sharing data between shells (but beware of synchronization issues - see below, and see the <code>LOCK</code> and <code>UNLOCK</code> functions). References may '''only''' refer to '''[[/Table\|table]]''', '''[[/File\|file]]''', and '''[[/Instance\|instance]]''' '''items'''.		Shell item references are entities that ''refer to'' to a shell item instance. This works even if the owner of the target item (the item the reference is referring to) is a different shell, making shell item references a convenient way of sharing data between shells (but beware of synchronization issues - see below, and see the <code>LOCK</code> and <code>UNLOCK</code> functions). References may '''only''' refer to '''[[/Table\|table]]''', '''[[/File\|file]]''', and '''[[/Instance\|instance]]''' '''items'''.

	<var>refName</var> := NEW <var>origType</var> * /Z <var>origName</var> [ <var>origShell</var> ] [/S]		<var>refName</var> := NEW <var>origType</var> * /Z <var>origName</var> [ <var>origShell</var> ] [/I]

	This command creates the reference <var>refName</var>, which refers to the original item whose type is <var>origType</var> and whose name is <var>origName</var>. If the original item is owned by another shell, its shell ID <var>origShell</var> must be specified, too. It is the option letter '''/Z''' that causes the [[Programmer_Guide/Command_Reference/NEW\|NEW]] command to create a reference instead of a new item.		This command creates the reference <var>refName</var>, which refers to the original item whose type is <var>origType</var> and whose name is <var>origName</var>. If the original item is owned by another shell, its shell ID <var>origShell</var> must be specified, too. It is the option letter '''/Z''' that causes the [[Programmer_Guide/Command_Reference/NEW\|NEW]] command to create a reference instead of a new item.
Line 204:		Line 204:
	* Deletion of the target item (i.e., the item a reference is referring to) is deferred until the last reference to the respective item gets deleted.		* Deletion of the target item (i.e., the item a reference is referring to) is deferred until the last reference to the respective item gets deleted.

	If the option '''/S''' is specified, errors will generate warning messages rather than error messages. See the [[Programmer_Guide/Command_Reference_Options/Silent_Flag\|Silent Flag]] page for details.		If the option '''/I''' is specified, errors will generate warning messages rather than error messages. See the [[Programmer_Guide/Command_Reference_Options/Silent_Flag\|Silent Flag]] page for details.

	==Protected shell items==		==Protected shell items==

Jw: /* Creating and deleting items, executing item functions */

2015-11-10T12:10:00Z

Creating and deleting items, executing item functions

← Older revision		Revision as of 14:10, 10 November 2015
Line 90:		Line 90:
	delete shell item(s) <var>itemname<sub>1</sub></var>, and so on.		delete shell item(s) <var>itemname<sub>1</sub></var>, and so on.

	The type of an item can be retrieved using this syntax: <code>~~name~~[?]</code>. E.g.:		The type of an item can be retrieved using this syntax: <code>itemname[?]</code>. E.g.:
	#table := new table *		#table := new table *
	if '$#table[?]' == table then		if '$#table[?]' == table then

Jw: /* Creating and deleting items, executing item functions */

2015-11-10T12:09:03Z

Creating and deleting items, executing item functions

← Older revision		Revision as of 14:09, 10 November 2015
Line 89:		Line 89:
	[[Programmer_Guide/Command_Reference/DELETE\|DELETE]] <var>itemname<sub>1</sub></var> …		[[Programmer_Guide/Command_Reference/DELETE\|DELETE]] <var>itemname<sub>1</sub></var> …
	delete shell item(s) <var>itemname<sub>1</sub></var>, and so on.		delete shell item(s) <var>itemname<sub>1</sub></var>, and so on.

			The type of an item can be retrieved using this syntax: <code>name[?]</code>. E.g.:
			#table := new table *
			if '$#table[?]' == table then
			// the new table command was successful
			end

	'''Note that:'''		'''Note that:'''

Jw at 07:38, 1 June 2015

2015-06-01T07:38:07Z

← Older revision		Revision as of 09:38, 1 June 2015
Line 68:		Line 68:
	\|-		\|-
	\|[[Programmer_Guide/Shell_Items/Wave\|<code>WAVE</code>]]		\|[[Programmer_Guide/Shell_Items/Wave\|<code>WAVE</code>]]
	\| A shell item for handling wave soundfiles, allowing playback and recording wave soundfiles as well as creating and manipulating sound sequencess. Wave items may also be used in numerical operations (e.g. to apply ~~an amazing~~ DSP algorithm on a signal).		\| A shell item for handling wave soundfiles, allowing playback and recording wave soundfiles as well as creating and manipulating sound sequencess. Wave items may also be used in numerical operations (e.g. to apply a DSP algorithm on a signal).
	\|-		\|-
	\|[[#References to shell items\|Shell Item Reference]]		\|[[#References to shell items\|Shell Item Reference]]

Jw: Consolidating content

2015-05-06T07:10:37Z

Consolidating content

← Older revision		Revision as of 09:10, 6 May 2015
Line 187:		Line 187:

	==References to shell items==		==References to shell items==
	~~There are shell~~ item references~~, i.e.~~ entities that ~~may be used to~~ ''~~referring~~ to'' to a shell item instance. This works even if the owner of the target item (the item the reference is referring to) is a different shell, making shell item references a convenient way of sharing data between shells (but beware synchronization issues - see below, and see the <code>LOCK</code> and <code>UNLOCK</code> functions). References may refer to [[/Table\|table]], [[/File\|file]], and [[/Instance\|instance]] items.		Shell item references are entities that ''refer to'' to a shell item instance. This works even if the owner of the target item (the item the reference is referring to) is a different shell, making shell item references a convenient way of sharing data between shells (but beware of synchronization issues - see below, and see the <code>LOCK</code> and <code>UNLOCK</code> functions). References may '''only''' refer to '''[[/Table\|table]]''', '''[[/File\|file]]''', and '''[[/Instance\|instance]]''' '''items'''.

	<var>refName</var> := NEW <var>origType</var> * /Z <var>origName</var> [ <var>origShell</var> ]		<var>refName</var> := NEW <var>origType</var> * /Z <var>origName</var> [ <var>origShell</var> ] [/S]

	This command creates the reference <var>refName</var>, which refers to the original item whose type is <var>origType</var> and whose name is <var>origName</var>. If the original item is owned by another shell, its shell ID <var>origShell</var> must be specified, too. It is the option letter '''/Z''' that causes the [[Programmer_Guide/Command_Reference/NEW\|NEW]] command to create a reference instead of a new item.		This command creates the reference <var>refName</var>, which refers to the original item whose type is <var>origType</var> and whose name is <var>origName</var>. If the original item is owned by another shell, its shell ID <var>origShell</var> must be specified, too. It is the option letter '''/Z''' that causes the [[Programmer_Guide/Command_Reference/NEW\|NEW]] command to create a reference instead of a new item.
Line 197:		Line 197:
	* The workspace object [[../Macro_Library/BSTXIni\|BSTXIni]] and the project object [[../Macro_Library/BDataSet\|BDataSet]] use references in order to share the XML workspace file and the XML project file.		* The workspace object [[../Macro_Library/BSTXIni\|BSTXIni]] and the project object [[../Macro_Library/BDataSet\|BDataSet]] use references in order to share the XML workspace file and the XML project file.
	* Deletion of the target item (i.e., the item a reference is referring to) is deferred until the last reference to the respective item gets deleted.		* Deletion of the target item (i.e., the item a reference is referring to) is deferred until the last reference to the respective item gets deleted.

			If the option '''/S''' is specified, errors will generate warning messages rather than error messages. See the [[Programmer_Guide/Command_Reference_Options/Silent_Flag\|Silent Flag]] page for details.

	==Protected shell items==		==Protected shell items==

Jw at 07:47, 28 April 2015

2015-04-28T07:47:43Z

← Older revision		Revision as of 09:47, 28 April 2015
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
	{{Shell Item}}		{{Shell Item}}

	{\| class="wikitable"		{\| class="wikitable"
	!colspan="13"\|[[Programmer_Guide/Shell_Items\|Shell Items]]		!colspan="13"\|[[Programmer_Guide/Shell_Items\|Shell Items]]
Line 19:		Line 18:
	\|[[#References to shell items\|Shell Item Reference]]		\|[[#References to shell items\|Shell Item Reference]]
	\|}		\|}


	{{STX}} implements a number of different objects which can be used to manipulate files, graphics, dialogs, etc. These objects are called ''shell items''.		{{STX}} implements a number of different objects which can be used to manipulate files, graphics, dialogs, etc. These objects are called ''shell items''.

Jw at 07:45, 28 April 2015

2015-04-28T07:45:19Z

@@ Line 1: / Line 1: @@
 {{DISPLAYTITLE:{{SUBPAGENAME}}}}
 {{Shell Item}}
 {{STX}} implements a number of different objects which can be used to manipulate files, graphics, dialogs, etc. These objects are called ''shell items''.

Jw at 05:43, 28 April 2015

2015-04-28T05:43:32Z

← Older revision		Revision as of 07:43, 28 April 2015
Line 22:		Line 22:
	\|A shell item for initiating a Dynamic Data Exchange (DDE) conversation with a DDE server and exchanging data between the server and the item (e.g. to exchange data with Microsoft Excel, a spreadsheet application popular among Windows users, or Word, a kind of text editor).		\|A shell item for initiating a Dynamic Data Exchange (DDE) conversation with a DDE server and exchanging data between the server and the item (e.g. to exchange data with Microsoft Excel, a spreadsheet application popular among Windows users, or Word, a kind of text editor).
	\|-		\|-
	\|[[Programmer_Guide/Shell_Items/Dialog\|<code>MENU</code> ~~(dialog)~~]]		\|[[Programmer_Guide/Shell_Items/Dialog\|<code>DIALOG\|MENU</code>]]
	\| ~~An improperly named~~ shell item for designing and displaying dialog boxes and processing user input. A dialog ~~(<code>MENU</code>)~~ is always a part of a display item.<BR>Note: It is a bit misleading that the dialog item is called <code>MENU</code>. This has historical reasons, and ~~we were uneager to change the name in order not to break existing code~~.		\| A shell item for designing and displaying dialog boxes and processing user input. A dialog is always a part of a display item.<BR>Note: It is a bit misleading that the dialog item may also be called a <code>MENU</code> item. This has historical reasons, and is retained for backward compatibility (as of {{STX}} 4.3.
	\|-		\|-
	\|[[Programmer_Guide/Shell_Items/Display\|<code>DISPLAY</code>]]		\|[[Programmer_Guide/Shell_Items/Display\|<code>DISPLAY</code>]]