Programmer Guide/Macro Library/Kernal/CAppSetup - Revision history

Jw at 09:23, 28 November 2018

2018-11-28T09:23:04Z

← Older revision		Revision as of 11:23, 28 November 2018
Line 1:		Line 1:
	{{DISPLAYTITLE:{{SUBPAGENAME}}}}		{{DISPLAYTITLE:{{SUBPAGENAME}}}}
			{{TOC limit\|4}}
	==CAppSetup : CObj==		==CAppSetup : CObj==

Jw at 09:22, 28 November 2018

2018-11-28T09:22:49Z

← Older revision		Revision as of 11:22, 28 November 2018
Line 4:		Line 4:
	The CAPPSETUP class is still being documented		The CAPPSETUP class is still being documented

	====CAppSetup Member Functions====		===CAppSetup Member Functions===

	=====CONSTRUCT profileType profileSubType profileName=====		====CONSTRUCT profileType profileSubType profileName====

	=====Usage:=====		=====Usage:=====
Line 34:		Line 34:
	Viewer1<nowiki>\|</nowiki>Viewer2\|Viewer3\|DSP1App\|DSP1Copy\|DSP1Amplify\|DSP1Normalize\|DSP1AGC\|DSP1Filter\|DSP1Bandpass\|DSP1Spectrum\|DSP1DeNoise\|DSP1Irrelevance		Viewer1<nowiki>\|</nowiki>Viewer2\|Viewer3\|DSP1App\|DSP1Copy\|DSP1Amplify\|DSP1Normalize\|DSP1AGC\|DSP1Filter\|DSP1Bandpass\|DSP1Spectrum\|DSP1DeNoise\|DSP1Irrelevance

	=====DELETEPROFILE=====		====DELETEPROFILE====

	=====Result:=====		=====Result:=====
Line 44:		Line 44:
	Show a dialog prompting the user to delete the profile. The function returns 1 if the user chooses to delete and 0 if they cancel the dialog box.		Show a dialog prompting the user to delete the profile. The function returns 1 if the user chooses to delete and 0 if they cancel the dialog box.

	=====DESTRUCT=====		====DESTRUCT====

	=====Description:=====		=====Description:=====
Line 50:		Line 50:
	Destroy the CAppSetup instance and clean up.		Destroy the CAppSetup instance and clean up.

	=====LISTPROFILES [table]=====		====LISTPROFILES [table]====

	=====Usage:=====		=====Usage:=====
Line 68:		Line 68:
	Creates a sorted list of profile names for the current profile type.		Creates a sorted list of profile names for the current profile type.

	=====LOAD<nowiki>\|</nowiki>LOADPROFILE [profileName]=====		====LOAD<nowiki>\|</nowiki>LOADPROFILE [profileName]====

	=====Usage:=====		=====Usage:=====
Line 86:		Line 86:
	Load all application settings for the specified profile and convert loaded settings to shell or global variables. If no profile name is specified, the instance's current profile is used.		Load all application settings for the specified profile and convert loaded settings to shell or global variables. If no profile name is specified, the instance's current profile is used.

	=====RESTART=====		====RESTART====

	=====Usage:=====		=====Usage:=====
Line 94:		Line 94:
	=====Description:=====		=====Description:=====

	=====RUN wait ; audioSet ; audioSegment ; channel=====		====RUN wait ; audioSet ; audioSegment ; channel====

	=====Usage:=====		=====Usage:=====
Line 121:		Line 121:
	Run the application.		Run the application.

	=====SAVEPROFILEAS=====		====SAVEPROFILEAS====

	=====Result:=====		=====Result:=====
Line 131:		Line 131:
	Show a dialog box prompting the user to save the current profile under a new name.		Show a dialog box prompting the user to save the current profile under a new name.

	=====SAVE<nowiki>\|</nowiki>SAVEPROFILE [profileName]=====		====SAVE<nowiki>\|</nowiki>SAVEPROFILE [profileName]====

	=====usage:=====		=====usage:=====
Line 149:		Line 149:
	Store all application setup variables into a table and save the table into the setup elements for the specified profile. If no profile name is specified, the instance's current profile name is used.		Store all application setup variables into a table and save the table into the setup elements for the specified profile. If no profile name is specified, the instance's current profile name is used.

	=====SET parameter=value [parameterX=valueX ...]=====		====SET parameter=value [parameterX=valueX ...]====

	=====Usage:=====		=====Usage:=====
Line 167:		Line 167:
	Set one or multiple parameter values.		Set one or multiple parameter values.

	=====SETUPDIALOG=====		====SETUPDIALOG====

	=====Result:=====		=====Result:=====
Line 177:		Line 177:
	Show the setup dialog for the instance's current profile.		Show the setup dialog for the instance's current profile.

	=====WAIT=====		====WAIT====

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

Toni: Toni moved page Programmer Guide/Macro Library/CAppSetup to Programmer Guide/Macro Library/Kernal/CAppSetup without leaving a redirect

2018-03-07T08:24:05Z

Toni moved page Programmer Guide/Macro Library/CAppSetup to Programmer Guide/Macro Library/Kernal/CAppSetup without leaving a redirect

← Older revision	Revision as of 10:24, 7 March 2018
(No difference)

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

2011-04-28T07:57:51Z

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

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

Admin: 1 revision: Initial import

2010-11-18T16:31:30Z

1 revision: Initial import

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

193.171.195.8: initial import

2010-05-17T13:05:27Z

initial import

New page

{{DISPLAYTITLE:{{SUBPAGENAME}}}}
==CAppSetup : CObj==

The CAPPSETUP class is still being documented

====CAppSetup Member Functions====

=====CONSTRUCT profileType profileSubType profileName=====

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

{|
|-
|profileType
|the name of the application profile type (see below)
|-
|profileSubType
|the name of the sub<nowiki>-</nowiki>profile type to use or * if there is no sub-profile type
|-
|profileName
|the profile name
|}

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

0

=====Description:=====

Initializes a new CAppSetup instance with data from the profile passed.

The following application profile types are supported:

Viewer1<nowiki>|</nowiki>Viewer2|Viewer3|DSP1App|DSP1Copy|DSP1Amplify|DSP1Normalize|DSP1AGC|DSP1Filter|DSP1Bandpass|DSP1Spectrum|DSP1DeNoise|DSP1Irrelevance

=====DELETEPROFILE=====

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

1 on success, 0 on failure

=====Description:=====

Show a dialog prompting the user to delete the profile. The function returns 1 if the user chooses to delete and 0 if they cancel the dialog box.

=====DESTRUCT=====

=====Description:=====

Destroy the CAppSetup instance and clean up.

=====LISTPROFILES [table]=====

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

{|
|-
|table
|name of target table or * if a table should be created.
|}

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

a table containing a list of all profile ids for the current instance's profile type

=====Description:=====

Creates a sorted list of profile names for the current profile type.

=====LOAD<nowiki>|</nowiki>LOADPROFILE [profileName]=====

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

{|
|-
|profileName
|the name of the application profile to load
|}

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

void

=====Description:=====

Load all application settings for the specified profile and convert loaded settings to shell or global variables. If no profile name is specified, the instance's current profile is used.

=====RESTART=====

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

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

=====Description:=====

=====RUN wait ; audioSet ; audioSegment ; channel=====

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

{|
|-
|wait
|1 if the macro/script should wait for the application to finish before continuing to the next command.
|-
|audioSet
|the audio set IREF
|-
|audioSegment
|the audio segment
|-
|channel
|the audio channel
|}

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

0 for success, 1 on failure

=====Description:=====

Run the application.

=====SAVEPROFILEAS=====

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

1

=====Description:=====

Show a dialog box prompting the user to save the current profile under a new name.

=====SAVE<nowiki>|</nowiki>SAVEPROFILE [profileName]=====

=====usage:=====

{|
|-
|profileName
|the name of the application profile
|}

=====result:=====

void

=====description:=====

Store all application setup variables into a table and save the table into the setup elements for the specified profile. If no profile name is specified, the instance's current profile name is used.

=====SET parameter=value [parameterX=valueX ...]=====

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

{|
|-
|parameter=value
|set the specified parameter to the specified value
|}

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

void

=====Description:=====

Set one or multiple parameter values.

=====SETUPDIALOG=====

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

the string 'Okay' if the user pressed the OK button, or 'Cancel' if the user pressed the Cancel button.

=====Description:=====

Show the setup dialog for the instance's current profile.

=====WAIT=====

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

<code>WAIT exit</code>

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

;<var>exit</var>

:<code>1</code> if application should exit, <code>0</code> if the application should wait until the user closes it.