Programmer Guide/Macro Library/COBJ - Revision history

Jw: /* MsgHandler */

2019-08-07T07:49:46Z

MsgHandler

← Older revision		Revision as of 09:49, 7 August 2019
Line 209:		Line 209:
	==MsgHandler==		==MsgHandler==
	<var>instname</var> MSGHANDLER <var>msgtype</var> <var>msgname</var> <var>msgid</var> <var>msgpar</var>		<var>instname</var> MSGHANDLER <var>msgtype</var> <var>msgname</var> <var>msgid</var> <var>msgpar</var>
	:This is the member function which processes the messages of shell items and/or shells attached to the instance <var>instname</var> using the function [[#AttachItem\|AttachItem or AttachShell]]. The function is called by the message handling system (see [[../GETMESSAGE\|~~GetMessage~~]] and [[../DISPATCHMSG\|~~DispatchMsg~~]]) when a message from an attached item/shell is received and dispatched.		:This is the member function which processes the messages of shell items and/or shells attached to the instance <var>instname</var> using the function [[#AttachItem\|AttachItem or AttachShell]]. The function is called by the message handling system (see [[../GETMESSAGE\|GETMESSAGE]] and [[../DISPATCHMSG\|DISPATCHMSG]]) when a message from an attached item/shell is received and dispatched.
	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default

Jw: /* MsgHandler */

2019-08-07T07:49:18Z

MsgHandler

← Older revision		Revision as of 09:49, 7 August 2019
Line 209:		Line 209:
	==MsgHandler==		==MsgHandler==
	<var>instname</var> MSGHANDLER <var>msgtype</var> <var>msgname</var> <var>msgid</var> <var>msgpar</var>		<var>instname</var> MSGHANDLER <var>msgtype</var> <var>msgname</var> <var>msgid</var> <var>msgpar</var>
	:This is the member function~~, processing~~ the messages of shell items and/or shells attached to the instance <var>instname</var>, using the function [[#AttachItem\|AttachItem or AttachShell]]. The function is called by the message handling system (see [[../GETMESSAGE\|GetMessage]] and [[../DISPATCHMSG\|DispatchMsg]]) when a message from an attached item/shell is received and dispatched.		:This is the member function which processes the messages of shell items and/or shells attached to the instance <var>instname</var> using the function [[#AttachItem\|AttachItem or AttachShell]]. The function is called by the message handling system (see [[../GETMESSAGE\|GetMessage]] and [[../DISPATCHMSG\|DispatchMsg]]) when a message from an attached item/shell is received and dispatched.
	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default

Jw: /* New */

2019-08-07T07:40:58Z

New

← Older revision		Revision as of 09:40, 7 August 2019
Line 10:		Line 10:
	COBJ NEW <var>classname</var>::<var>instname</var> [ <var>initargs</var> ]		COBJ NEW <var>classname</var>::<var>instname</var> [ <var>initargs</var> ]
	:Create a new instance of class <var>classname</var> and initialize it. To initialize the instance the public member function [[#Construct\|Construct]] is called (<code><var>newinst</var> Construct [ <var>initargs</var> ]</code>). The constructor must return 0 if the initialization was successful, or a non-zero value if the initialization has failed. If the initialization has failed, the instance <var>newinst</var> is deleted (without calling the [[#Destruct\|destructor]]) and an empty string is returned.		:Create a new instance of class <var>classname</var> and initialize it. To initialize the instance the public member function [[#Construct\|Construct]] is called (<code><var>newinst</var> Construct [ <var>initargs</var> ]</code>). The constructor must return 0 if the initialization was successful, or a non-zero value if the initialization has failed. If the initialization has failed, the instance <var>newinst</var> is deleted (without calling the [[#Destruct\|destructor]]) and an empty string is returned.
	:If an <var>instname</var> is specified it is used as name for the new instance. If an instance with name <var>instname</var> and class <var>classname</var> exists already, the function returns immediatly with result <var>instname</var>, without calling the <Code>Construct</code> member function.		:If <var>instname</var> is specified, it is used as the name for the new instance. If an instance with name <var>instname</var> and class <var>classname</var> exists already, the function returns immediatly with result <var>instname</var>, without calling the <Code>Construct</code> member function.
	:This function should be used rather than the command [[Programmer_Guide/Command_Reference/NEW\|NEW INSTANCE]], to create new [[Programmer_Guide/Shell_Items/Instance\|instance items]].		:This function should be used rather than the command [[Programmer_Guide/Command_Reference/NEW\|NEW INSTANCE]], to create new [[Programmer_Guide/Shell_Items/Instance\|instance items]].
	{\|class="einrahmen"		{\|class="einrahmen"

Jw at 06:16, 7 August 2019

2019-08-07T06:16:59Z

← Older revision		Revision as of 08:16, 7 August 2019
Line 384:		Line 384:

	Both functions of the derived class must only load/save the element data. All other functions are performed by the member functions of the base class.		Both functions of the derived class must only load/save the element data. All other functions are performed by the member functions of the base class.

			=See Also=
			[[Programmer_Guide/Source_code#Definition_of_Classes\|Definition of Classes]]

Jw at 06:16, 7 August 2019

2019-08-07T06:16:24Z

← Older revision		Revision as of 08:16, 7 August 2019
Line 2:		Line 2:
	'''File''': CLASSES.STX, linked to library STX.LIB		'''File''': CLASSES.STX, linked to library STX.LIB
	----		----
	The class CObj implements some basic functions of the {{STX}} class library. ~~The most~~ other classes of the standard library are derived from this class. It should also be used ~~ase~~ parent class for classes ~~implement~~ in scripts. The derived classes should call the overridden member functions of CObj.		The class CObj implements some basic functions of the {{STX}} class library. Most other classes of the standard library are derived from this class. It should also be used as the parent class for classes implemented in scripts. The derived classes should call the overridden member functions of CObj.

	=Static Functions=		=Static Functions=

Jw at 12:30, 6 August 2019

2019-08-06T12:30:42Z

← Older revision		Revision as of 14:30, 6 August 2019
Line 164:		Line 164:
	;See also: [[#Delete\|Delete]], [[#Destruct\|Destruct]]		;See also: [[#Delete\|Delete]], [[#Destruct\|Destruct]]

	==AttachItem / AttachShell ~~(public)~~==		==AttachItem / AttachShell==
	<var>instname</var> ATTACHITEM <var>itemname</var> [ <var>mhfun</var> ]		<var>instname</var> ATTACHITEM <var>itemname</var> [ <var>mhfun</var> ]
	<var>instname</var> ATTACHSHELL <var>shellid</var> [ <var>mhfun</var> ]		<var>instname</var> ATTACHSHELL <var>shellid</var> [ <var>mhfun</var> ]
Line 178:		Line 178:
	\|-		\|-
	\|<var>mhfun</var> \|\|The name of a public member function of <var>instname</var> which should process the messages.		\|<var>mhfun</var> \|\|The name of a public member function of <var>instname</var> which should process the messages.
	\|\|[[#MsgHandler ~~(public~~)\|MsgHandler]]		\|\|[[#MsgHandler)\|MsgHandler]]
	\|-		\|-
	!RESULT !!description		!RESULT !!description
Line 184:		Line 184:
	\|''undefined''\|\|The function has no return value.		\|''undefined''\|\|The function has no return value.
	\|}		\|}
	;See also: [[#DetachItem / DetachShell ~~(public)~~\|DetachItem]], [[#MsgHandler ~~(public)~~\|MsgHandler]], [[../SETMSGHANDLER\|macro SetMsgHandler]]		;See also: [[#DetachItem / DetachShell\|DetachItem]], [[#MsgHandler\|MsgHandler]], [[../SETMSGHANDLER\|macro SetMsgHandler]]

	==DetachItem / DetachShell ~~(public)~~==		==DetachItem / DetachShell==
	<var>instname</var> DETACHITEM <var>itemname</var> [ <var>delitem</var> ]		<var>instname</var> DETACHITEM <var>itemname</var> [ <var>delitem</var> ]
	<var>instname</var> DETACHSHELL <var>shellid</var>		<var>instname</var> DETACHSHELL <var>shellid</var>
Line 205:		Line 205:
	\|''undefined'' \|\|The function has no return value		\|''undefined'' \|\|The function has no return value
	\|}		\|}
	;See also: [[#AttachItem / AttachShell ~~(public)~~\|AttachItem]], [[../SETMSGHANDLER\|macro SetMsgHandler]]		;See also: [[#AttachItem / AttachShell\|AttachItem]], [[../SETMSGHANDLER\|macro SetMsgHandler]]

	==MsgHandler ~~(public)~~==		==MsgHandler==
	<var>instname</var> MSGHANDLER <var>msgtype</var> <var>msgname</var> <var>msgid</var> <var>msgpar</var>		<var>instname</var> MSGHANDLER <var>msgtype</var> <var>msgname</var> <var>msgid</var> <var>msgpar</var>
	:This is the member function, processing the messages of shell items and/or shells attached to the instance <var>instname</var>, using the function [[#AttachItem\|AttachItem or AttachShell]]. The function is called by the message handling system (see [[../GETMESSAGE\|GetMessage]] and [[../DISPATCHMSG\|DispatchMsg]]) when a message from an attached item/shell is received and dispatched.		:This is the member function, processing the messages of shell items and/or shells attached to the instance <var>instname</var>, using the function [[#AttachItem\|AttachItem or AttachShell]]. The function is called by the message handling system (see [[../GETMESSAGE\|GetMessage]] and [[../DISPATCHMSG\|DispatchMsg]]) when a message from an attached item/shell is received and dispatched.
Line 228:		Line 228:
	\|}		\|}
	;Note: The default function performs no message processing and returns 1!		;Note: The default function performs no message processing and returns 1!
	;See also: [[#AttachItem / AttachShell ~~(public)~~\|AttachItem]], [[../SETMSGHANDLER\|macro SetMsgHandler]], [[../GETMESSAGE\|GetMessage]], [[../StdLib#DispatchMsg\|DispatchMsg]]		;See also: [[#AttachItem / AttachShell\|AttachItem]], [[../SETMSGHANDLER\|macro SetMsgHandler]], [[../GETMESSAGE\|GetMessage]], [[../StdLib#DispatchMsg\|DispatchMsg]]

	==SerializeImport==		==SerializeImport==
Line 295:		Line 295:
	==SerializeInit (protected)==		==SerializeInit (protected)==
	<var>instname</var> SERIALIZEINIT <var>parname</var>=<var>parvalue</var> ; ...		<var>instname</var> SERIALIZEINIT <var>parname</var>=<var>parvalue</var> ; ...
	:This function configures the serialization member variables and is normally called by the constructor of classes using serialization. It must be called before the member functions [[#SerializeImport ~~(public)~~\|SerializeImport]] and [[#SerializeExport ~~(public)~~\|SerializeExport]] can be used. The following table shows a list of the supported (and required) serialization parameters.		:This function configures the serialization member variables and is normally called by the constructor of classes using serialization. It must be called before the member functions [[#SerializeImport\|SerializeImport]] and [[#SerializeExport\|SerializeExport]] can be used. The following table shows a list of the supported (and required) serialization parameters.
	{\|class="einrahmen"		{\|class="einrahmen"
	!<var>parname</var> !!description of <var>parvalue</var> !! member variable !! default value		!<var>parname</var> !!description of <var>parvalue</var> !! member variable !! default value
Line 327:		Line 327:
	==SerializeCheckVersion==		==SerializeCheckVersion==
	<var>instname</var> SERIALIZECHECKVERSION <var>...</var>		<var>instname</var> SERIALIZECHECKVERSION <var>...</var>
	:if called by [[#SerializeExport ~~(public)~~\|SerializeExport]] → Returns <code>1</code> if the version assigned to <code>&serializeVersion</code> is valid and supported, otherwise <code>0</code>.		:if called by [[#SerializeExport\|SerializeExport]] → Returns <code>1</code> if the version assigned to <code>&serializeVersion</code> is valid and supported, otherwise <code>0</code>.
	:if called by [[#SerializeImport ~~(public)~~\|SerializeImport]] → Returns <code>1</code> if the version of the element to be imported is valid and supported, otherwise <code>0</code>		:if called by [[#SerializeImport\|SerializeImport]] → Returns <code>1</code> if the version of the element to be imported is valid and supported, otherwise <code>0</code>
	{\|class="einrahmen"		{\|class="einrahmen"
	!RESULT !!description		!RESULT !!description

Jw: /* Serialization */

2019-08-06T12:28:57Z

Serialization

← Older revision		Revision as of 14:28, 6 August 2019
Line 338:		Line 338:
	;See also: [[#Serialization\|Serialization]]		;See also: [[#Serialization\|Serialization]]

	==Serialization==		=Serialization=

	<u>Member variables which '''must be''' initialized by child classes</u>		<u>Member variables which '''must be''' initialized by child classes</u>

Jw at 12:28, 6 August 2019

2019-08-06T12:28:28Z

← Older revision		Revision as of 14:28, 6 August 2019
Line 3:		Line 3:
	----		----
	The class CObj implements some basic functions of the {{STX}} class library. The most other classes of the standard library are derived from this class. It should also be used ase parent class for classes implement in scripts. The derived classes should call the overridden member functions of CObj.		The class CObj implements some basic functions of the {{STX}} class library. The most other classes of the standard library are derived from this class. It should also be used ase parent class for classes implement in scripts. The derived classes should call the overridden member functions of CObj.
	==New ~~(static)~~==
	~~'''static'''~~		=Static Functions=

			==New==
	COBJ NEW <var>classname</var> [ <var>initargs</var> ]		COBJ NEW <var>classname</var> [ <var>initargs</var> ]
	COBJ NEW <var>classname</var>::<var>instname</var> [ <var>initargs</var> ]		COBJ NEW <var>classname</var>::<var>instname</var> [ <var>initargs</var> ]
Line 35:		Line 37:
	;See also: [[#Delete\|Delete]], [[#Construct\|Construct]]		;See also: [[#Delete\|Delete]], [[#Construct\|Construct]]

	==Delete ~~(static)~~==		==Delete==
	COBJ DELETE <var>instname</var>		COBJ DELETE <var>instname</var>
	:Calls the [[#Destruct\|Destruct]] member function (<code><var>instname</var> Destruct</code>), to reset the instance, and than deletes the instance item. The return value of [[#Destruct\|Destruct]] is ignored.		:Calls the [[#Destruct\|Destruct]] member function (<code><var>instname</var> Destruct</code>), to reset the instance, and than deletes the instance item. The return value of [[#Destruct\|Destruct]] is ignored.
Line 52:		Line 54:
	;See also: [[#New\|New]], [[#Destroy\|Destroy]]		;See also: [[#New\|New]], [[#Destroy\|Destroy]]

	==Import ~~(static)~~==		==Import==
	COBJ IMPORT <var>classname</var> ; <var>filename</var> ; <var>silent</var>		COBJ IMPORT <var>classname</var> ; <var>filename</var> ; <var>silent</var>
	:Import a settings profile of class <var>classname</var> from the file <var>filename</var> into the workspace. This function creates an instance of <var>classname</var> and calls the member function [[#SerializeImport\|SerializeImport]] to import the file. The class <var>classname</var> must be derived from <code>CObj</code> and must implement the serialization interface members and a member function named <code>Save</code>, which saves a profile in the workspace. E.g. this function is used for the import of Viewer- and Color-profiles.		:Import a settings profile of class <var>classname</var> from the file <var>filename</var> into the workspace. This function creates an instance of <var>classname</var> and calls the member function [[#SerializeImport\|SerializeImport]] to import the file. The class <var>classname</var> must be derived from <code>CObj</code> and must implement the serialization interface members and a member function named <code>Save</code>, which saves a profile in the workspace. E.g. this function is used for the import of Viewer- and Color-profiles.
Line 78:		Line 80:
	;See also: [[#SerializeImport\|SerializeImport]], [[#Export\|Export]]		;See also: [[#SerializeImport\|SerializeImport]], [[#Export\|Export]]

	==Export ~~(static)~~==		==Export==
	COBJ EXPORT <var>classname</var> ; <var>setupname</var> ; <var>filename</var> ; <var>silent</var>		COBJ EXPORT <var>classname</var> ; <var>setupname</var> ; <var>filename</var> ; <var>silent</var>
	:Export the settings profile <var>setupname</var> of class <var>classname</var> from the workspace to the file <var>filename</var>. This function creates an instance of <var>classname</var> and calls the member function [[#SerializeExport\|SerializeExport]] to export the file. The class <var>classname</var> must be derived from <code>CObj</code> and must implement the serialization interface members and a member function named <code>Load</code>, which loads a profile from the workspace. E.g. this function is used for the export of Viewer- and Color-profiles.		:Export the settings profile <var>setupname</var> of class <var>classname</var> from the workspace to the file <var>filename</var>. This function creates an instance of <var>classname</var> and calls the member function [[#SerializeExport\|SerializeExport]] to export the file. The class <var>classname</var> must be derived from <code>CObj</code> and must implement the serialization interface members and a member function named <code>Load</code>, which loads a profile from the workspace. E.g. this function is used for the export of Viewer- and Color-profiles.
Line 108:		Line 110:
	;See also: [[#SerializeExport\|SerializeExport]], [[#Import\|Import]]		;See also: [[#SerializeExport\|SerializeExport]], [[#Import\|Import]]

	==Construct ~~(public)~~==		=Public Functions=

			==Construct==
	<var>instname</var> CONSTRUCT [ <var>initargs</var> ]		<var>instname</var> CONSTRUCT [ <var>initargs</var> ]
	:Default constructor. Currently this function do nothing and returns the result <code>0</code>. For compatibility reasons it should be invoked by the constructors of derived classes.		:Default constructor. Currently this function do nothing and returns the result <code>0</code>. For compatibility reasons it should be invoked by the constructors of derived classes.
Line 128:		Line 132:
	;See also: [[#New\|New]], [[#Destruct\|Destruct]]		;See also: [[#New\|New]], [[#Destruct\|Destruct]]

	==Destruct ~~(public)~~==		==Destruct==
	<var>instname</var> DESTRUCT		<var>instname</var> DESTRUCT
	:Default destructor. Currently this function do nothing and returns immediatly without any result (void). For compatibility reasoons it should be invoked by the destructors of derived classes.		:Default destructor. Currently this function do nothing and returns immediatly without any result (void). For compatibility reasoons it should be invoked by the destructors of derived classes.
Line 144:		Line 148:
	;See also: [[#Delete\|Delete]], [[#Destroy\|Destroy]], [[#Construct\|Construct]]		;See also: [[#Delete\|Delete]], [[#Destroy\|Destroy]], [[#Construct\|Construct]]

	==Destroy ~~(public)~~==		==Destroy==
	<var>instname</var> DESTROY		<var>instname</var> DESTROY
	:Calls the destructor to de-initialize the instance and than deletes the instance item <var>instname</var>.		:Calls the destructor to de-initialize the instance and than deletes the instance item <var>instname</var>.
Line 226:		Line 230:
	;See also: [[#AttachItem / AttachShell (public)\|AttachItem]], [[../SETMSGHANDLER\|macro SetMsgHandler]], [[../GETMESSAGE\|GetMessage]], [[../StdLib#DispatchMsg\|DispatchMsg]]		;See also: [[#AttachItem / AttachShell (public)\|AttachItem]], [[../SETMSGHANDLER\|macro SetMsgHandler]], [[../GETMESSAGE\|GetMessage]], [[../StdLib#DispatchMsg\|DispatchMsg]]

	==SerializeImport ~~(public)~~==		==SerializeImport==
	<var>instname</var> SERIALIZEIMPORT <var>file</var>=* ; <var>level</var>=current [; <var>params</var> ]		<var>instname</var> SERIALIZEIMPORT <var>file</var>=* ; <var>level</var>=current [; <var>params</var> ]
	:This function performs all necessary operations to import/restore the object data. After initializing the xml fileitem containing the element to be imported and preparing the member varaibles, the <code>onSerializeImport</code> member is called to perform the element/data import.		:This function performs all necessary operations to import/restore the object data. After initializing the xml fileitem containing the element to be imported and preparing the member varaibles, the <code>onSerializeImport</code> member is called to perform the element/data import.
Line 258:		Line 262:
	;See also: [[#Serialization\|Serialization]]		;See also: [[#Serialization\|Serialization]]

	==SerializeExport ~~(public)~~==		==SerializeExport==
	<var>instname</var> SERIALIZEEXPORT <var>file</var>=* ; <var>level</var>=current [; <var>params</var> ]		<var>instname</var> SERIALIZEEXPORT <var>file</var>=* ; <var>level</var>=current [; <var>params</var> ]
	:This function performs all necessary operations to export/save the object data. After initializing the xml fileitem, creating the export element and preparing the member varaibles, the <code>onSerializeExport</code> member is called to perform the element/data export.		:This function performs all necessary operations to export/save the object data. After initializing the xml fileitem, creating the export element and preparing the member varaibles, the <code>onSerializeExport</code> member is called to perform the element/data export.
Line 319:		Line 323:
	;See also: [[#Serialization\|Serialization]]		;See also: [[#Serialization\|Serialization]]

	==SerializeCheckVersion ~~(protected)~~==		=Protected Functions=

			==SerializeCheckVersion==
	<var>instname</var> SERIALIZECHECKVERSION <var>...</var>		<var>instname</var> SERIALIZECHECKVERSION <var>...</var>
	:if called by [[#SerializeExport (public)\|SerializeExport]] → Returns <code>1</code> if the version assigned to <code>&serializeVersion</code> is valid and supported, otherwise <code>0</code>.		:if called by [[#SerializeExport (public)\|SerializeExport]] → Returns <code>1</code> if the version assigned to <code>&serializeVersion</code> is valid and supported, otherwise <code>0</code>.
Line 333:		Line 339:

	==Serialization==		==Serialization==


	<u>Member variables which '''must be''' initialized by child classes</u>		<u>Member variables which '''must be''' initialized by child classes</u>

Jw: /* Delete (static) */

2017-06-22T10:54:10Z

Delete (static)

← Older revision		Revision as of 12:54, 22 June 2017
Line 38:		Line 38:
	COBJ DELETE <var>instname</var>		COBJ DELETE <var>instname</var>
	:Calls the [[#Destruct\|Destruct]] member function (<code><var>instname</var> Destruct</code>), to reset the instance, and than deletes the instance item. The return value of [[#Destruct\|Destruct]] is ignored.		:Calls the [[#Destruct\|Destruct]] member function (<code><var>instname</var> Destruct</code>), to reset the instance, and than deletes the instance item. The return value of [[#Destruct\|Destruct]] is ignored.
	:This function should be used rather than the command [[Programmer_Guide/Command_Reference/NEW\|DELETE <var>instname</var>]], to delete [[Programmer_Guide/Shell_Items/Instance\|instance items]].		:This function should be used rather than the command [[Programmer_Guide/Command_Reference/NEW\|DELETE <var>instname</var>]], to delete [[Programmer_Guide/Shell_Items/Instance\|instance items]]. If you just delete the instance using the [[Programmer_Guide/Command_Reference/NEW\|DELETE <var>instname</var>]] command, then the destructor is not called!
	{\|class="einrahmen"		{\|class="einrahmen"
	!argument !!description !!default		!argument !!description !!default

Toni: /* Serialization */

2016-01-29T14:12:50Z

Serialization

← Older revision		Revision as of 16:12, 29 January 2016
Line 351:		Line 351:
	:;<code>&serializeFilePath</code>: The path of the import/export file.		:;<code>&serializeFilePath</code>: The path of the import/export file.
	:;<code>&serializeState</code>: Either <code>import</code> or <code>export</code>. This is initialized by CObj if the import/export function is called.		:;<code>&serializeState</code>: Either <code>import</code> or <code>export</code>. This is initialized by CObj if the import/export function is called.
	:;<code>&serializeImportVersion</code>: The version of the element being imported. This is initialized by CObj before		:;<code>&serializeImportVersion</code>: The version of the element being imported. This is initialized by CObj before the import function is called.
	the import function is called.

	<u>Implementing Serialization for Classes</u>		<u>Implementing Serialization for Classes</u>