Programmer Guide/Macro Library/DataSetCmd - Revision history

Jw: /* GetSelected */

2019-09-27T12:29:11Z

GetSelected

← Older revision		Revision as of 14:29, 27 September 2019
Line 13:		Line 13:
	;Description: This function retrieves attributes of elements selected in of the lists/regions of the workspace GUI.		;Description: This function retrieves attributes of elements selected in of the lists/regions of the workspace GUI.

	;<var>type</var> = '''sets''': Get sets selected in the detail view of the workspace. The detail view ~~displayes~~ a list of sets, if an element of type '''Set''' (folder) or the root element (STXDataSet) is selected in the overview.		;<var>type</var> = '''sets''': Get sets selected in the detail view of the workspace. The detail view displays a list of sets, if an element of type '''Set''' (folder) or the root element (STXDataSet) is selected in the overview.
	:table entry format: <var>elementTag ; elementID ; elementIRef [; srate ; channels [; soundfilepath]]</var>		:table entry format: <var>elementTag ; elementID ; elementIRef [; srate ; channels [; soundfilepath]]</var>
	:* The values <var>srate</var> and <var>channels</var> are set for selected audio sets (AFile, ASequence)		:* The values <var>srate</var> and <var>channels</var> are set for selected audio sets (AFile, ASequence)
	:* The value <var>soundfilepath</var> is set only for audio sets of type AFile		:* The value <var>soundfilepath</var> is set only for audio sets of type AFile

	;<var>type</var> = '''segments''': Get ASeg elements (segments) selected in the detail view of the workspace. The detail view ~~displayes~~ a list of segments, if an audio set (AFile, ASequence, ASegList) is selected in the overview.		;<var>type</var> = '''segments''': Get ASeg elements (segments) selected in the detail view of the workspace. The detail view displays a list of segments, if an audio set (AFile, ASequence, ASegList) is selected in the overview.
	:table entry format: <var>audioSetIRef ; segmentID ; segmentCH</var>		:table entry format: <var>audioSetIRef ; segmentID ; segmentCH</var>

Jw: /* GetSelected */

2019-09-27T12:28:41Z

GetSelected

← Older revision		Revision as of 14:28, 27 September 2019
Line 21:		Line 21:
	:table entry format: <var>audioSetIRef ; segmentID ; segmentCH</var>		:table entry format: <var>audioSetIRef ; segmentID ; segmentCH</var>

	;<var>type</var> = '''parameters''': Get APar elements (saved parameters) selected in the detail view of the workspace. The detail view ~~displayes~~ a list of parameters, if an audio set (AFile, ASequence, ASegList) is selected in the overview.		;<var>type</var> = '''parameters''': Get APar elements (saved parameters) selected in the detail view of the workspace. The detail view displays a list of parameters, if an audio set (AFile, ASequence, ASegList) is selected in the overview.
	:table entry format: <var>audioSetIRef ; segmentID ; segmentCH ; aparMethod ; aparType</var>		:table entry format: <var>audioSetIRef ; segmentID ; segmentCH ; aparMethod ; aparType</var>

Toni at 09:11, 7 March 2018

2018-03-07T09:11:28Z

← Older revision		Revision as of 11:11, 7 March 2018
Line 83:		Line 83:
	==Uncommon Functions and Functions for internal use only==		==Uncommon Functions and Functions for internal use only==

	All <code>DataSetCmd</code> functions not documented here are strictly reserved for the use by the main application <code>DataSet</code> (Workspace).		All <code>DataSetCmd</code> functions not documented here are strictly reserved for the use by the main application <code>DataSet</code> (Workspace). Some of these functions are described in the kernal page [[/Kernal/DataSetCmd\|DataSetCmd]].

Toni at 12:22, 2 March 2018

2018-03-02T12:22:50Z

@@ Line 5: / Line 5: @@
 This macro implements a set of functions for the project management and for the communication with the main application shell <code>DataSet</code> (Workspace) and its GUI.
-==Workspace GUI Communication and Update==
+==Get/Set Selected Elements==
 ===GetSelected===
@@ Line 42: / Line 42: @@
 </pre>
-==Uncommon Functions and Functions for internal use only==
+===GetSegment & GetWave===
-The following functions are not often used and not so important for user script programming. If you want to know more about these functions look at the comments in the source (file '''DataSet.stx''', macro <code>DataSetCmd</code>).
+===RefreshAll===
-* ....
+All <code>DataSetCmd</code> functions not documented here are strictly reserved for the use by the main application <code>DataSet</code> (Workspace).

Toni: Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}} - Interface to Main Application and GUI}} :'''File''': DataSet.STX, linked to library STX.LIB :'''See also''': [[User_Guide/Workspace|Workspace]..."

2018-03-02T10:43:48Z

Created page with "{{DISPLAYTITLE:{{SUBPAGENAME}} - Interface to Main Application and GUI}} :'''File''': DataSet.STX, linked to library STX.LIB :'''See also''': [[User_Guide/Workspace|Workspace]..."

New page

{{DISPLAYTITLE:{{SUBPAGENAME}} - Interface to Main Application and GUI}}
:'''File''': DataSet.STX, linked to library STX.LIB
:'''See also''': [[User_Guide/Workspace|Workspace]], [[Programmer_Guide/Macro_Library/BDataSet|BDataSet]]

This macro implements a set of functions for the project management and for the communication with the main application shell <code>DataSet</code> (Workspace) and its GUI.

==Workspace GUI Communication and Update==

===GetSelected===
;Usage: <code>datasetcmd getselected <var>type</var></code>
:;<var>type</var>: selects from which part of the GUI selected elements should be retrieved
;Result: An empty string or a simple table item containing the selected elements. The line format of the table depends on <var>type</var>
;Description: This function retrieves attributes of elements selected in of the lists/regions of the workspace GUI.

;<var>type</var> = '''sets''': Get sets selected in the detail view of the workspace. The detail view displayes a list of sets, if an element of type '''Set''' (folder) or the root element (STXDataSet) is selected in the overview.
:table entry format: <var>elementTag ; elementID ; elementIRef [; srate ; channels [; soundfilepath]]</var>
:* The values <var>srate</var> and <var>channels</var> are set for selected audio sets (AFile, ASequence)
:* The value <var>soundfilepath</var> is set only for audio sets of type AFile

;<var>type</var> = '''segments''': Get ASeg elements (segments) selected in the detail view of the workspace. The detail view displayes a list of segments, if an audio set (AFile, ASequence, ASegList) is selected in the overview.
:table entry format: <var>audioSetIRef ; segmentID ; segmentCH</var>

;<var>type</var> = '''parameters''': Get APar elements (saved parameters) selected in the detail view of the workspace. The detail view displayes a list of parameters, if an audio set (AFile, ASequence, ASegList) is selected in the overview.
:table entry format: <var>audioSetIRef ; segmentID ; segmentCH ; aparMethod ; aparType</var>

;<var>type</var> = '''element''': Get the element selected in the overview.
:table entry format: <var>elementTag ; elementIRef ; elementID</var>

;Example:

<pre>
// process all selected segments
if '$(#seglist := datasetcmd getselected segments)[?]' == table then
for #i := 0 to $#i < $#seglist[] step #i := int $#i+1
readtab $#seglist #aset';'#id';'#ch';'# /del

// do something

end
delete $#seglist
end
</pre>

==Uncommon Functions and Functions for internal use only==

The following functions are not often used and not so important for user script programming. If you want to know more about these functions look at the comments in the source (file '''DataSet.stx''', macro <code>DataSetCmd</code>).

* ....