Default Control Properties

From DevWiki

Jump to: navigation, search

Applications,Boxee GUI API,Controls

Default properties and events (tags and attributes) are available for all skin controls: Note that all tag names are lower case. XML tag names are case sensitive!

Element Description
description Only used to make things clear for the skinner. Not read by Boxee at all.
type The type of control.
id Specifies the control's id. The value this takes depends on the control type, and the window that you are using the control on. There are special control id's that must be present in each window. Any other controls that the skinner adds can be any id they like. Any controls that the skinner specifies content needs not have an id unless it's needed for animation purposes. For instance, most image and label controls don't need an id if the skinner specifies they're content.
posx Specifies where the left edge of the control should be drawn, relative to it's parent's left edge. If an "r" is included (eg 180r) then the measurement is taken from the parent's right edge (in the left direction).
posy Specifies where the top edge of the control should be drawn, relative to it's parent's top edge. If an "r" is included (eg 180r) then the measurement is taken from the parent's bottom edge (in the up direction).
width Specifies the width that should be used to draw the control.
height Specifies the height that should be used to draw the control.
visible Specifies a condition as to when this control will be visible. Can be true, false, or a condition. See here for more information. Defaults to true.
animation Specifies the animation to be run when the control enters a particular state. See here for more information
camera Specifies the location (relative to the parent's coordinates) of the camera. Useful for the 3D animations such as rotatey. Format is <camera x="20" y="30" />
colordiffuse This specifies the color to be used for the texture basis. It's in hex AARRGGBB format. If you define <colordiffuse>FFFF00FF</colordiffuse> (magenta), the image will be given a magenta tint when rendered. Defaults to FFFFFFFF (no tint). You can also specify this as a name from the colour theme.


For focusable events, the following are also available:

Element Description
onup Specifies the <id> of the control that should be moved to when the user moves up off this control. Can point to a control group (which remembers previous focused items).
ondown Specifies the <id> of the control that should be moved to when the user moves down off this control. Can point to a control group (which remembers previous focused items).
onleft Specifies the <id> of the control that should be moved to when the user moves left off this control. Can point to a control group (which remembers previous focused items).
onright Specifies the <id> of the control that should be moved to when the user moves right off this control. Can point to a control group (which remembers previous focused items).
hitrect Specifies the location and size of the "focus area" of this control (relative to the parent's coordinates) used by the mouse cursor. Format is <hitrect x="20" y="30" w="50" h="10" />
enable Specifies a condition as to when this control will be enabled. Can be true, false, or a condition. See here for more information. Defaults to true.
pulseonselect This specifies whether or not a button type will "pulse" when it has focus. This is done by varying the alpha channel of the button. Defaults to true.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox