Programmer Guide/Macro Library/CTemplates - Revision history

Jw at 07:06, 6 April 2018

2018-04-06T07:06:55Z

← Older revision		Revision as of 09:06, 6 April 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}} - Template Management}}		{{DISPLAYTITLE:{{SUBPAGENAME}} - Template Management}}
			[[Category:Templates]]
	:'''File''': Classes.STX, linked to library STX.LIB		:'''File''': Classes.STX, linked to library STX.LIB
	:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]]		:'''Parent class''': [[Programmer Guide/Macro Library/COBJ\|CObj]]

2018-03-07T11:08:40Z

@@ Line 3: / Line 3: @@
 :'''Parent class''': [[Programmer Guide/Macro Library/COBJ|CObj]]
-A class to manage templates (e.g. of type '''DialogTemplate''', '''ASegTemplate''' or '''attrTemplate''')
+A class to manage templates. In {{STx}} templates are used to define attributes for specific data types. The most important data type using a template is '''ASeg''', this is type of elements storing audio segment definitions. Templates of type '''ASegTemplate''' are used to define additional segment attributes for a specific application. Templates are also used to define the content variables and the layout of dialogs managed by the class [[Programmer_Guide/Macro_Library/ModalDialog|ModalDialog]]. The available templates are stored as xml-files in the subdirectory '''templates''' of the {{STx}} installation directory. To ''install'' it is only necessary to copy the xml-file containing the definitions into this directory. The template name (id) is the name of the xml-file and the type is the tag of the root element of the file (see section [[#Example|Example]]).
 ==Create Instance==
@@ Line 66: / Line 67: @@
 :;<var>id</var>: the id of the template
 ;Result: An extended table contains all definitions of all variables of the selected template. The returns table has the string fields '''Type''', '''Name''', '''Default''', '''Values''' and '''Flags'''.

2018-03-07T10:34:58Z

Create Instance

← Older revision		Revision as of 12:34, 7 March 2018
Line 8:		Line 8:
	;Usage:		;Usage:
	:<code>ctemplates [ <var>type</var> ]</code>		:<code>ctemplates [ <var>type</var> ]</code>
	:<code>cobj new ctemplates [ <var>~~typetag~~</var> ]</code>		:<code>cobj new ctemplates [ <var>type</var> ]</code>
	:;<var>type</var>: selects the type of templates to be managed (default: '''ASegTemplate''')		:;<var>type</var>: selects the type of templates to be managed (default: '''ASegTemplate''')
	;Result: an initialized instance		;Result: an initialized instance

2018-03-07T10:34:44Z

← Older revision		Revision as of 12:34, 7 March 2018
Line 9:		Line 9:
	:<code>ctemplates [ <var>type</var> ]</code>		:<code>ctemplates [ <var>type</var> ]</code>
	:<code>cobj new ctemplates [ <var>typetag</var> ]</code>		:<code>cobj new ctemplates [ <var>typetag</var> ]</code>
	:;<var>type</var>selects the type of templates to be managed (default: '''ASegTemplate''')		:;<var>type</var>: selects the type of templates to be managed (default: '''ASegTemplate''')
	;Result: an initialized instance		;Result: an initialized instance

2018-03-07T10:34:21Z

Create Instance

← Older revision		Revision as of 12:34, 7 March 2018
Line 7:		Line 7:
	==Create Instance==		==Create Instance==
	;Usage:		;Usage:
	:<code>ctemplates [ <var>~~typetag~~</var> ]</code>		:<code>ctemplates [ <var>type</var> ]</code>
	:<code>cobj new ctemplates [ <var>typetag</var> ]</code>		:<code>cobj new ctemplates [ <var>typetag</var> ]</code>
	:;<var>~~typetag~~</var>selects the type of templates to be managed (default: '''ASegTemplate''')		:;<var>type</var>selects the type of templates to be managed (default: '''ASegTemplate''')
	;Result: an initialized instance		;Result: an initialized instance

2018-03-07T10:33:16Z

GetVars

← Older revision		Revision as of 12:33, 7 March 2018
Line 65:		Line 65:
	;Usage: <code><var>instance</var> getvars <var>id</var></code>		;Usage: <code><var>instance</var> getvars <var>id</var></code>
	:;<var>id</var>: the id of the template		:;<var>id</var>: the id of the template
	;Result: An extended table contains all ~~the~~ definitions of all variables of the selected template. The returns table has the string fields '''Type''', '''Name''', '''Default''', '''Values''' and '''Flags'''.		;Result: An extended table contains all definitions of all variables of the selected template. The returns table has the string fields '''Type''', '''Name''', '''Default''', '''Values''' and '''Flags'''.

2018-03-07T10:32:55Z

CheckFlag

← Older revision		Revision as of 12:32, 7 March 2018
Line 51:		Line 51:

	==CheckFlag==		==CheckFlag==
	;Usage: <code><var>instance</var> ~~getflags~~ <var>id ; attr ; flag</var></code>		;Usage: <code><var>instance</var> checkflag <var>id ; attr ; flag</var></code>
	:;<var>id</var>: the id of the template		:;<var>id</var>: the id of the template
	:;<var>attr</var>: the name of the attribute		:;<var>attr</var>: the name of the attribute

2018-03-07T10:32:34Z

GetList

← Older revision		Revision as of 12:32, 7 March 2018
Line 22:		Line 22:
	==GetList==		==GetList==
	;Usage: <code><var>instance</var> getlist</code>		;Usage: <code><var>instance</var> getlist</code>
	;Result: an semi-colon separated list of the id's of the available templates of the selected type		;Result: a semi-colon separated list of the id's of the available templates of the selected type

	==GetAttributeList==		==GetAttributeList==

2018-03-07T10:32:15Z

2017-07-26T07:15:29Z

getList

← Older revision		Revision as of 09:15, 26 July 2017
Line 21:		Line 21:
	=====Usage:=====		=====Usage:=====

	<code><var>inst</var> getList ~~[ <var>rType</var> ]~~</code>		<code><var>inst</var> getList</code>

	=====~~Parameters~~:=====		=====Result:=====

			A list containing the ids of the segment templates currently loaded in {{STX}}.

	~~;<var>rType</var>~~		===getTable===

	~~:The type~~ of ~~list to return~~. ~~Possible values are~~:		Retrieve a table of loaded templates. The table is an extended table with one field: 'id'

	:~~<code>table</code> - Return a simple table.~~		=====Usage:=====

	:<code>~~list~~</code> ~~- Return a semi-colon separated list.~~		<code><var>inst</var> getTable</code>

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

	~~Depending on <var>rType</var>, a~~ table ~~or a list~~ containing the ~~ids of the segment~~ templates in ~~the current~~ {{STX}} ~~INI file~~.		An extended table with one field (id) containing the templates currently loaded in {{STX}}.

	===Reload===		===Reload===