Controls


Button/Switch

<button name="... />


A button usually is an OS specific control. The <button> tag inherits all <view> attributes, it doesn't implement new ones.


<helpbutton locator="..."/>


A click opens the help system at the specified location.


<switch name="..." title="..." style="..." bitmap="..." icon="..." blink="..." />


Attributes:

style Defines the behaviour:
push- bitmap has two parts (normal and pushed)
on 
onoff*- bitmap has four parts (normal & pushed for each stage)
edit- string specified in title could be edited on Double-Click

Additional styles:
immediate- the switch acts on mouse-down, not on mouse-up
rollover- bitmap has three parts for each stage (normal, pushed, rollover)
bitmap referes to a bitmap in resources section
icon if specified, an icon switch will be created (the icon is drawn onto the bitmap).
blink specifies the name of an application-specific value that controls blinking of the switch
If it's not specified, the switch does not blink. When blinking, the displayed state changes between pressed and not pressed.
title if a title is specified, a text switch will be created where the title will be displayed on


Button States:

The bitmap of a switch is divided vertically into two or or three (rollover) sections per stage, depending on its style.

onoff/on style:  
off, not pressed
off, pressed
off, rollover
on, not pressed
on, pressed
on, rollover
     push style:  
not pressed
pressed
rollover


HOWTO animate switches


Checkbox/Radiobutton

<checkbox name="... />



A checkbox usually is an OS specific control. The <checkbox> tag inherits all <view> attributes, it doesn't implement new ones.


<radiobutton name="... />


A radiobutton usually is an OS specific control. The <radiobutton> tag inherits all <view> attributes, it doesn't implement new ones.



Radiogroup

<radiogroup name="..." align="...">
    <!-- place controls here -->
</radiogroup>


All controls in a radiogroup behave "mutual exclusive", that means only one control can be switched on at a time. It is mainly used for radiobuttons.


Attributes:

align alignment of controls inside the radiogroup, can be "horiz" or "vert"*.



Scrollbar

<scrollbar name="..." style="..." bitmaps="..."/>


Attributes:

style can be "horizontal"* or "vertical"
bitmaps referes to a bitmap collection with the following bitmaps:

<collection name="... >
  <bitmap name="UpButton" ... />
  <bitmap name="DownButton" ... />
  <bitmap name="VerticalBack" ... />
  <bitmap name="VerticalHandle" ... />
  <bitmap name="VerticalHandleTop" ... />
  <bitmap name="VerticalHandleBottom" ... />
  <bitmap name="LeftButton" ... />
  <bitmap name="RightButton" ... />
  <bitmap name="HorizontalBack" ... />
  <bitmap name="HorizontalHandle" ... />
  <bitmap name="HorizontalHandleLeft" ... />
  <bitmap name="HorizontalHandleRight" ... />
</collection>

If the bitmaps attribute is not specified, an OS specific scrollbar will be created.



Slider

<slider name="..." style="..." handle="..." background="..." offset="x,y" defaultval="int" />


If no handle and/or background bitmaps are specified, a OS specific slider will be created.


Attributes:

style defines the direction:
horizontal*,
horizontal-small,
vertical or
vertical-small
handle handle bitmap
background background bitmap
offset offset to actual background in background bitmap
defaultval default value



Knob

1) <knob name="..." handle="..." background="..." offset="x,y" [knobmode="..."]/>

2) <knob name="..." bitmap="..."/>


A knob can be described in two different ways:

1) It consists of a background and a handle bitmap, where the handle is moved circular to display the knob position.
2) All knob positions are rendered in a filmstrip.


Attributes:

handle handle bitmap
background background bitmap
offset background offset
bitmap filmstrip which contains the knob positions
knobmode Changes the behaviour for all (!!) knobs:

circular*,
relativ-circular or
linear


Filmstrip



Text Displays/Edit

<text name="..." style="..." just="..." bgcolor="#color" displaywidth="integer"/>
<edit name="..." style="..." just="..." bgcolor="#color" displaywidth="integer"/>


Attributes:

style Can be a combination of:
border- control has a border
no-title- control has no title
title-right- title is right-aligned
no-clipboard- disable copy & paste
visible-inactive- text accessible if not active
led- black background
fit-string- fit string to display width
transparent- control is transparent

e.g. "border|title-right|fit-string"
just text justification, can be a combination of "left", "top", "right", "bottom" separated with pipes (e.g. "left|top")
bgcolor background color
displaywidth display width


<valuebox name="..." style="..."/>


Attributes:

style Additional styles:
no-updown- no up/down box
popup-slider- popup a slider
doubleclick- double-click editing


<rationalbox name="..." style="..."/>


Attributes:

style Additional styles:
border- special border


<optmenu name="..." style="..."/>


Attributes:

style Additional styles:
transparent- control is transparent
nodropdown- no drop-down box
commandmenu- menu behaves like a command menu
menubreak- page break for large menus (Windows only)



UpDown Box

<updownbox name="..." style="..."/>


Attributes:

style
updown
leftright
up
down
left
right
transparent
repeat



Image

<image bitmap="..." style="..." />


Attributes:

bitmap bitmap to display
style the style determines how the bitmap is drawn in the view rectangle.
If none of the following styles is specified, the bitmap is drawn in it's original size (clipped to the view).
scale- the bitmap is scaled to the view size
hrepeat- the bitmap is repeated horizontally to fit the view's width
vrepeat- the bitmap vertically to fit the view's height
animate- the bitmap will be animated if it is a filmstrip



Label

<label title="..." just="..." style="..." />


Attributes:

just text justification, see Text displays/edit
style
autowidth- the width of the label is set to fit the text, ignoring the width in size.

Note that the title displayed in the label is translated.


Decor

<decor style="..." bgcolor="..." />


Attributes:

style can be one of the following (try how it looks):
workarea
dialogframe
groupframe
solidrect- draws a rectangle filled with the given bgcolor

bgcolor background color, only used with "solidrect" style



Bitmap Scale

<bitmapscale name="..." maximum="..." style="..." bitmap="..." segmentsize="pixels" background="..." offset="x,y" />


Attributes:

maximum name of an application-specific value which should be displayed as maximum (e.g. peak of a vu-meter)
style can be "horizontal" or "vertical", combined with "manipulate".
If "manipulate" is set (e.g. "vertical|manipulate") the bitmap scale allows user interaction.
bitmap foreground bitmap
segmentsize segment size in pixels
background background bitmap
offset offset to actual background in background bitmap



Bitmap Display

<bitmapdisplay name="..." bitmap="..."/>


The bitmap display is a passive element that is used to display a value. The bitmap is horizontally divided into as many sections as the value has steps between its minimum and maximum. Lets assume the value can be either 0 or 1. In this case, the bitmap is divided into an upper and a lower half. If the value is 0, the upper half is displayed and if the value is 1 the lower half is displayed.



Listbox

<listbox name="..." style="..."/>


Attributes:

style hscroll - horizontal scrollbar
vscroll - vertical scrollbar
title - show title
border
transparent
vlines - vertical grid lines
hlines - horizontal grid lines
select - enable selection
exclusive - exclusive selection
selectAlways - prevent empty selection
close - close the window on double click, enter, escape



Progressbar

<progressbar name="..." style="..." title="..."/>


Attributes:

style border - control has a border
nodigits - no percent text
title (inherited) specifies the (initial) progress text



Application-specific controls

<control name="..." class="..." [attribute list]/>


The control tag is a placeholder for application-specific controls, identified by a class name. It can have any number of additional attributes. Of course it inherits all attributes of the <view> tag, too.


Attributes:

class control class name




Copyright ©2004 Steinberg Media Technologies GmbH. All Rights Reserved.
Last Modified: