III. Functional objects
93
Developer handbook DATAformXTension © 1992-2004 www.gassenhuber.de
III. Functional objects
Functional objects are DATAform objects with a type *T that is greater than 100. They offer
functions that go further than normal DATAform objects:
-
They set the mode with which the following DATAform objects should be processed such
as import or delete.
-
They activate or deactivate the group function.
-
They export information about the current QuarkXPress document or create a new docu-
ment.
-
They save the QuarkXPress document or change the page view.
Functional objects may be included in a text with DATAformTags, however, this is not manda-
tory.
All functional objects work in one direction only. They are not bi-directional like most other
DATAformTags. With one exception, all functional objects work in the direction towards
QuarkXPress and are therefore not exported.
Only the object *T107 document parameter <= is exported. It provides information concerning
the current QuarkXPress document and is exported as the first object in a text with
DATAformTags.
When importing a text with DATAformTags it is skipped and may be omitted without prob-
lem.
Box objects and functional objects
Box object
DATAform object which describes a QuarkXPress box or a Quark-
XPress line, ¶*T3*$hello¶
QuarkXPress Object
A box or a line in QuarkXPress.
Functional object
DATAform object that, for example, defines the importing mode
¶*T101*M1*$¶
There are two basic modes of processing a text with DATAformTags: import and update. Nor-
mally the mode will be defined previous to reading by selecting the corresponding menu com-
mands Import boxes and Update contents or by the equivalent commands of the message
interface IMPORT and UPDATE.
The chosen mode is in this case used for the entire import procedure.
Functional objects
Functional objects allow you, for instance, to set the processing mode by the text with
DATAformTags itself. The mode remains valid until a new functional object is transferred.
Functional objects do not themselves create or describe a QuarkXPress box. They are always
positioned before following box objects and define e.g. how these objects should be translated
into a QuarkXPress object.
Syntax
Functional objects are made up of the type of function *T with a value >100 and one or more
arguments, given under *M etc.
Example: ¶*T101*M1*$¶
The argument Tags, like M, each have their own meaning within functional objects.