Quick links
 
 
 

Theme designer manual

 "Setup.txt" configuration file


Updated:

July 1, 2002



This text file you can edit through "Notepad", enables to setup parameters for the theme.
It is made of a sequence of commands, each of them being followed by one or several parameters.

Each command, followed by its parameters, occupies one row in the text file.
Rows beginning by # are ignored, and enable to write comments.

Order of commands does not matter. For readability reasons, it is however recommended to sort them logically.

Here is the list of available commands, along with their meaning. Commands are written below in upper case, but in the file they can either be written in lower or upper case. Expected parameters are written here between < >. These symbols must not be written in the text file. It is only a convention of writing for this manual in order to help separate easily the miscellaneous parameters for each command.

Text commands

These commands enable to set texts that describe the theme. Each command is followed by a language switch (FR, EN, DE, ES, IT, JP) that enables to specify a localized version of the text in a given language.
Language list is:
FR    French
EN    English
DE    Deutsch
ES    Spanish
IT    Italiano
JP    Japanese
If no text is specified for the language currently selected in the application, the English version is used.
If you do not want to specify different texts according to the language, only English version (EN) has to be defined.

For example, if you write, using the "COMMENT" command (see meaning below):

COMMENT EN    My personal Theme
COMMENT FR   Mon thème personnel

French user will read "Mon thème personnel", other users (English and other languages) will read "My personal Theme".
 

Command: COMMENT


Meaning:

This command sets the comment related to the theme (descriptive text)
Parameters: <Language> <text>
Example: COMMENT FR Thème Prairie (aspect champêtre)
 
Command: VERSION

Meaning:

This command sets the version number for the theme
Parameters: <Language> <texte>
Example: VERSION EN version 1.0 beta 4
 
Command: COPYRIGHT

Meaning:

This command sets the author name and the legual information for the theme
Parameters: <Language> <texte>
Example: COPYRIGHT EN (c) John Doe 2002.
 
Command: EMAIL

Meaning:

This command sets the author's e-mail address
Parameters: <Language> <e-mail address>
Example: EMAIL EN john.doe@myssite.com
 
Command: HOMEPAGE

Meaning:

This command sets the author's main Web page address
Parameters: <Language> <Web address>
Example: HOMEPAGE EN www.myssite.com/members/doe
 
Command: DOWNLOADPAGE

Meaning:

This command sets the author's theme download Web page address

Parameters: <Language> <Web address>
Example: DOWNLOADPAGE EN www.myssite.com/members/doe/themes  

External picture specification commands

 

We saw a theme is made of three files: the configuration text file, called "setup.txt", documented here, as well as a default background picture and a picture that collects all objects appearance.
The following commands define picture file names, as well as the way to handle them.
 

Command: THEMEBMP


Meaning:

This command sets the file name for the BMP file that includes the objects and windows drawing
Parameters: <file namer>
Example: SKINBMP ObjectsPrairie.bmp
 
Command: BACKGROUNDBMP

Meaning:

This command sets the file name for the BMP file of the default background for this theme.
Parameters: <file name>
Example: BACKGROUNDBMP BackPrairie.bmp
 
Command: BACKGROUNDTYPE

Meaning:

This command sets the default display type for the background picture
Parameters: <display type>
MOSAIC
Picture is drawn in real size, then repeated as a mosaic in order to fill in the desktop background.
STRETCH
Picture is stretched in order to fill in the desktop background
Example: BACKGROUNDTYPE MOSAIC
 
 
Command: THEMEGLOBALCOLOR

Meaning:

This command sets the dominant color for the theme. This color will be substituted by the one selected by the user when changing theme color.
Parameters: BLUE, RED, GREEN, CYAN,MAGENTA, YELLOW, GRAY, NONE
Example: THEMEGLOBALCOLOR  blue
 
 

Object size commands


 
Command: MARGIN

Meaning:

This command sets the margins (in pixels) applied to an object: the application defines the theorical area user by each object in their enclosing window. But the actual area used by the object can be slightly bigger (positive margins) or smaller (negative margins) than the theorical area.
Be careful however: setting too big margins can make close objects overlap each other.
Parameters: <object> <left margin> <top margin> <right margin> <bottom margin>
Object can be:

EDITTEXT

. Here is an edit text (editable text) object, as it can be displayed on screen. The blinking cursor, that enables the user to type in his text, is symbolized here by a gray bar.

Red rectangle is the theorical display area that has been defined in the program.

The total rectangle of the object (green) can be bigger than this area. Pixel margins are defined by the following command:

MARGIN EDITTEXT left top right bottom


LIST

Unimplemented at present
FOCUS
Unimplemented at present


PUSHBUTTON

. Here is a push button as it can be displayed on screen.

Red rectangle is the theorical display area that has been defined in the program.

The total rectangle of the button (green) can be bigger than this area. Pixel margins are defined by the following command:

MARGIN EDITTEXT left top right bottom

Area in which the button caption is displayed (blue rectangle) is also defined relatively to the red area, using the following command:

EXTRAMARGIN PUSHBUTTONCAPTION left top right bottom
(see below)


POPUPBUTTON

. Here is a popup button as it can be displayed on screen.

Red rectangle is the theorical display area that has been defined in the program.

The total rectangle of the button (green) can be bigger than this area. Pixel margins are defined by the following command:

MARGIN EDITTEXT left top right bottom

Area in which the button caption is displayed (blue rectangle) is also defined relatively to the red area, using the following command:

EXTRAMARGIN PUSHBUTTONCAPTION left top right bottom
(see below)
Area in which the button arrow is displayed (purple rectangle) is also defined relatively to the red area, using the following command:
EXTRAMARGIN PUSHBUTTONCAPTION left top right bottom
(see below)


BEVELBUTTON

. Here is a bevel button as it can be displayed on screen.

Red rectangle is the theorical display area that has been defined in the program.

The total rectangle of the button (green) can be bigger than this area. 

Pixel margins are defined by the following command:

MARGIN EDITTEXT left top right bottom


TABFRONT

. Here is a tab front button (currently selected tab index) as it can be displayed on screen.

Red rectangle is the theorical display area that has been defined in the program.

The total rectangle of the button (green) can be bigger than this area. Pixel margins are defined by the following command:

MARGIN EDITTEXT left top right bottom


TABBACK

. Here is a tab back button (unselected  tab index) as it can be displayed on screen.

Red rectangle is the theorical display area that has been defined in the program.

The total rectangle of the button (green) can be bigger than this area. Pixel margins are defined by the following command:

MARGIN EDITTEXT left top right bottom



 
Command: EXTRAMARGIN

Meaning:

Some objects need extra margins, that are defined through this command.
Parameters: <object> <left margin> <top margin> <right margin> <bottom margin>
Object can be:
DEFAULTBUTTON
. A push button that has been define as default button by the application (the one that is selected when the user presses "Enter") can be graphically bigger than the other buttons.

This command sets the extra magin to be applied to this kind of push buttons.

Red rectangle is the theorical display area that has been defined in the program.

Green rectangle shows the standard push button display rectangle, set through the MARGIN PUSHBUTTON command.

The total rectangle of the default push button (purple) can be even bigger than this area. The extra margin for default push button outside the standard push button area (green) is set through the following command:

EXTRAMARGIN DEFAULTBUTTON left top right bottom

PUSHBUTTONCAPTION
. This command sets the area for push button caption, relatively to the object area defined in the program.

Push button caption area (blue) can be bigger than this area. Extra margins, in pixels, are set through the following command:

EXTRAMARGIN PUSHBUTTONCAPTION left top right bottom

POPUPBUTTONCAPTION

. This command sets the area for popup button caption, relatively to the object area (red) defined in the program.

popup button caption area (blue) can be bigger than this area. Extra margins, in pixels, are set through the following command:

EXTRAMARGIN POPUPBUTTONCAPTION left top right bottom


POPUPARROW

. This command sets the area for popup button arrow, relatively to the object area (red) defined in the program.

popup button caption area (purple) can be bigger than this area. Extra margins, in pixels, are set through the following command:

EXTRAMARGIN POPUPARROW left top right bottom
Note 1: "left" parameter is unused, because the arrow widtn is calculated according to its icon size.
Note 2: Do not forget that negative margin values enable to define areas smaller than the original area.



Text effect commands

 
 
Command: FONT

Meaning:

This command sets the character font (name, size, style) used in each of the object type.
Parameters: <Object type> <font(s)>

Object types can be:

SYSTEM
In a window, default font for statuc texts, edit texts, check boxes caption.
Be careful: can be redefined by the application for each of its windows.
MENUTITLE
Menu title font in menu bar
MENUITEM
Menu item font (in the menu pane that opens under the menu bar)
WINDOWTITLE
Standard window title font
PUSHBUTTON
Push button caption font
TABTITLE
Tab index title font
UTILITYWINDOWTITLE
"Palette" window title font


Character fonts to be applied are defined this way

Font 1 name,size,style;Font 2 name,size,style...

A style is a combination of the words bold, italic or underline, separated by spaces, or std if no style has to be set.

Fonts are parsed in the order they are written. The first font to be present in the system is used.

If you do not specify size or style after the first font, previous values are kept.

Example: FONT PUSHBUTTON Tahoma,12,bold italic;Verdana,10;Arial,11,std;MS Sans Serif
Sets, for push button caption font:
Tahoma, size 12, bold, italic.
If this font does not exist in the user's system, tries Verdana, size 10, bold italic.
If this font does not exist in the user's system, tries Arial, size 11, no style.
If this font does not exist in the user's system, tries MS Sans Serif, size 11, no style.

Note: Style for MENUITEM font (item in menu pane) is not taken into account, because the application selects by itself what options have to be displayed in bold or italic.
 

Commands: EFFECT / DISPLAY


Meaning:

This command sets the way of displaying texts in objects (location, color)
Parameters: <Object type> <Object state>

It is followed by one or more DISPLAY commands

Parameters: <RGB color> <X offset in pixels> <Y offset in pixel>

Object type can be:

MENUTITLE
Option in menu bar
MENUITEM
Option in menu pane
WINDOWTITLE
Window title
PUSHBUTTON
Push button
CHECKBOX
Check box
RADIOBUTTON
"Radio" button
STATICTEXT
Static text
TABFRONT
Front (selected) tab index
TABBACK
Unselected tab index
Object state can be:
 
INACTIVE
Object is not activated (cannot be clicked)
ACTIVE
Object is active
PRESSED
Object is pressed (mouse button down on it)
UNDERMOUSE
Object is under the mouse pointer (pointed)
Be careful: All objects cannot be in all states. For example, a window title can only be either active or inactive.

Example:
EFFECT WINDOWTITLE ACTIVE
    DISPLAY FF0000 -1 0
    DISPLAY 0000FF 1 0
    DISPLAY FFFFFF 0 0

Window title will be written:
- One pixel to the left, in red
- One pixel to the right, in blue
- At the regular location, in white

This will show a white text, outlined in red on the left and in blue on the right.
 

Command: KNOBARROWSHAPE New HA 8.2.0 / MA 6.2.0


Meaning:

This command sets the shape of the knob indicator
Parameters: <Shape type> <Max distance> <min distance> <bottom width> <notch>

Shape type can be:

ARROW
An arrow
CIRCLE
A circle (in this case, width and notch are unused)
Other parameters are given in percentage of the knob size.

Example:
KNOBARROWSHAPE ARROW 98 40 30 18
Knob indicator will be an arrow, whose top will be located at 98% of the knob total size, its bottom beong located at 40% of this size.
Arrow bottom will be 30% width, with a notch of 18% height.
 

Command: KNOBARROWCOLOR New HA 8.2.0 / MA 6.2.0


Meaning:

This command sets the color of knob indicator
Parameters: <RGB color>

Example:
KNOBARROWCOLOR 0000FF
Indicator will be blue.
 

Command: KNOBSHADOW Nouveau HA 8.2.0 / MA 6.2.0


Meaning:

This command sets the knob shadow
Parameters: <shadow size> <shadow strength>

Knobs are automatically shadowed. Shadow size is provided in pixels before resizing, and strngth in percentage of complete black.

Example:
KNOBSHADOW 6 20
Shadow will be 6 pixels long and will start as a very pale gray (20%).

Window appearance control commands


Command: WINDOWEFFECT

Meaning:

This commande defines default opening and closing effects for each type of window.
Plese note duration and transparency ratio settings can be overlapped by local settings of the application itself.
Parameters: <Window type> <Opening effect type> <Opening duration> <Closing effect type> <Closing duration> <Transparency ratio>

Window type can be:
 

FIRSTMENUPANE
First menu pane to open
HIERACHICALMENUPANE
Hierarchical menu pane
POPUPMENUPANE
Popup menu pane
OTHERMENUPANE
Other menu pane
ALERTWINDOW
Alert box
MODALWINDOW
Modal window
FLOATINGWINDOW
Floating window (palette)
DOCUMENTWINDOW
Document window
OTHERWINDOW
Other window type


Opening or closing effect type can be:

NONE
No effect (appears/disappears instantaneously)
FROMTOP
Opens from top/Closes to top
FROMLEFT
Opens from left/Closes to left
FROMBOTTOM
Opens from bottom/Closes to bottom
FROMRIGHT
Opens from right/Closes to right
FROMBOTRIGHT
Opens from bottom-right/Closes to bottom-right
FADE
Fade in/out
Duration is provided in 1000th of second.
Transparency ratio is provided in tenth of percent (per 1000), 0 for opaque, 1000 to invisible.

Example:

WINDOWEFFECT ALERTWINDOW   FROMTOP 100 FROMTOP 50 85

Alert boxes will open in 1/10th of second from the top, will close to the top in 1/20th of second, and will be translucent at 8.5%
 

Command: CHILDMENUDELAY


Meaning:

Sets the delay before opening a hierarchical menu
Parameter: <Delay>

Delay is provided in 60th of second.

Example:

CHILDMENUDELAI 60

A delay of one second will be done before opening a hierarchical menu.

 

Miscellaneous commands


 
Command: DEBUG

Meaning:

When this command is written at the beginning of the setup.txt file, when a syntax error is found in the file opens an alert box when the theme is loaded. Otherwise, errors are not reported and when an unknown command is encountered, the whole row is ignored.
Parameters: none




Top of page
Legal information Last update:  (c) Myriad