(v13) Doobri classes
This page applies to Harlequin v13.1r0 and later; and to Harlequin MultiRIP but not Harlequin Core
The manner in which doobris of different classes map to particular elements of a dialog depends on the platform and its GUI conventions. See (v13) Harlequin MultiRIP plugins on Microsoft Windows .
An abstract description of each class follows. The class‐to‐element mapping for Windows is given as an example in each description.
| A check box. |
| A text box restricted to accept only digits and the“‐” (minus/hyphen) character. |
| A text box restricted as for Note: Exponential numbers cannot be entered into such a text box. |
| An unrestricted text box. Any characters can be entered. |
| A combo box. |
| A text box and file selection common dialog. |
| Text box and modified file selection common dialog. |
| Group boxes, static text. These are included so that localizations can be applied to the RIP text. |
dcBool
This class represents a boolean or flag element with an accompanying text label describing the effect or state enabled when the flag is on. On Windows the element would be presented as a check box.
The class corresponds to a struction_type
of STIO_BOOL
.
dcInt
This class represents an element for user entry and editing a value of some sort, usually an integer. The element restricts input to only these characters:
0 1 2 3 4 5 6 7 8 9 -
That is, 0 to 9 and the hyphen/minus character.
The element should be accompanied by a text label describing what the value entered represents. On Windows the element would be presented as a (suitably restricted) text box.
This class corresponds to a struction_type
of STIO_INT
.
dcFloat
As for dcInt
, except that the element allows the “.
” (period/full stop) character as well. This class corresponds to a struction_type
of STIO_FLOAT
.
dcString
This represents an element for user entry and editing of a textual string, using any characters. This class corresponds to a struction_type
of STIO_INLINE_STRING
.
dcSelection
This class represents an element allowing the user to select an item from a number of options, usually in a drop‐down list, accompanied by a text label describing the parameter the selection provides a value for. Depending on the platform, the user might also be able to type a value into the element.
This class corresponds to a struction_type
of STIO_INLINE_STRING
.
dcFilename
This class represents an element allowing the user to browse for and select a filename, accompanied by a descriptive text label. The element displays a filename, which the user can edit if the platform look and feel permits. The user can also click on a Browse button, thereby producing the platform's standard file selection dialog.
If the flags
of the Doobri
structure contain DF_MUST_EXIST
, the names the user enters must correspond to existing files.
This class corresponds to a struction_type
of STIO_INLINE_STRING
.
dcFolder
As for dcFilename
, but the element operates on a folder or directory, rather than an individual file.
If the flags
of the Doobri
structure contain DF_MUST_EXIST
, the names the user enters must correspond to existing folders / directories.
This class corresponds to a struction_type
of STIO_INLINE_STRING
.
dcStatic
This class corresponds to any “static” elements of a dialog. A static element is one which has no value associated with it, but which you, dialog writer, may wish to enable or disable. Examples of static elements include group boxes or label gadgets (Motif), and static text (Windows).
This class does not correspond to any struction_type
, since there is no associated variable value.