Attributes
Attributes
From ThrottleWiki
attention: this page is very much work in progress!
Attributes define specific properties of the different elements of Throttlelauncher syntax: attribute="value"
- name - The name of the element.
- applies to: all elements
- mandatory:yes
- path - The path of an image.
- aplies to: icon, text, clock
- mandatory:yes
- allowed values: absolute or relative (to setup folder) path to image files. If the image does not exist, an empty space is shown
- exec - path to executable file or built-in command. Can be a shortcut (*.lnk)
- applies to:icon, text, clock, panel
- mandatory:no
- Note: see also Events
- params - parameters to be passed to the exec.
- aplies to: see exec
- mandatory:no
- height - height of the element in pixels. The image is scaled to the specified height. If only height is specified, the width is also scaled so the aspect ratio stays the same. If both are specified, the image is scaled to the specified height and width, regardless of the aspect ratio.
- applies to: icon, text, clock, panel, row
- when used in a row, it specifies the row height, and it is the default height value for elements in the row
- when used in a panel, it defines the height occupied by the panel, and it is the default height value for elements in the panel
- mandatory: no
- default: the actual height of the image, if also the width is absent.
- applies to: icon, text, clock, panel, row
- width - Width of the element in pixels. The image is scaled to the specified width. If only width is specified, the height is also scaled so the aspect ratio stays the same. If both are specified, the image is scaled to the specified height and width, regardless of the aspect ratio.
- applies to: see height.
- mandatory: no
- default: the actual width of the image, if also the height is absent.
- showtext - if true, the name is displayed below the image. The font is defined in the skin that applies to the icon
- applies to: icon, text, ...
- allowed values: true,false
- mandatory: no
- default: false
- rowspan - the amount of rows in a row element the icon occupies.
- allowed values: number
- mandatory: no
- default:1
- X,Y - horizontal resp. vertical position in pixels of the icon within a panel element
- mandatory: no
- allowed values: number
- default: 0
- text - a text value. Can contain variables.
- mandatory:no
- fonttype - allows to specify font name, point size and bold (true/false).
- mandatory: no
- default: the font in the applicable skin file if any. Else, system font.
- syntax: [font name,]size, bold
- allowed values for font name: installed font names. (To install a font, copy a font.ttf file to your \windows folder and softreset). The font name used here must be the actual name of the font, not the name of the *.ttf file).
- allowed values for size: number
- allowed values for bold: boolean
- fontcolor-allows to specify the color of the font by specifying values for R,G, and B
- mandatory:no
- syntax:R,G,B
- allowed values for R,G, and B: 0..255
- default value: as specified in skin file
- Topmargin-allows to specify the number of pixels below the top of the text element that the text should be displayed.
- mandatory: no
- allowed values: number
- default value: 0
- Leftmargin-allows to specify the number of pixels from the left side of the text element the text should be displayed.
- mandatory: no
- allowed values: number
- default: If not specified, the text is centered with respect to the text element.
- Textwidth-specifies the width of the text box inside a text element. See also "options".
- applies to: text elements
- mandatory:no
- default value: if no text width is specified, the entire text is displayed in one line.
- Textheight-specifies the height of the text box inside a text element.
- mandatory:no
- default value:If not specified, the text is wrapped once (!?)
- options-options for text display
- mandatory:no
- allowed values: clip
- clip causes the text to be cut off, to fit into text width
- default value: if not specified, the text will wrap, on whole words, to fit into text width, unless there is no textwitdth then the text is displayed completely in one line
Row:
- name-name of the row.
- mandatory: yes
- layout
- allowed values: rows, cols, free
- mandatory:no
- default:rows
- rows: arranges elements next to eachother (unless "rows">1), and horizontal scrolling
- cols: arranges elements under eachother (unless "cols">1) and vertical scrolling
- Note: a row with layout = "cols" must also have a height and a width for vertical scrolling to work
- free: allows to place elements in the row by coordinates (is this correct?)
- rows - the number of rows in the row element.
- allowed values: number
- mandatory:no
- default:1
- for values n>1 arranges the elements so that there are n rows in the row element which behave as one.
- cols
- same as rows but the other way around
- scrolling - defines the scrolling mode for the row.
- allowed values: paged, direct,kinetic,wheeloffortune,none
- mandatory:no
- default: the value in the overall parameter.
- skin - path pointing to a folder that contains a skin.xml file. For the row that has this attribute, the values in this skin file will overwrite the values in in the overall skin file defined in the parameters section.
- allowed values: path to a folder containing a skin.xml file
- mandatory:no
- default: the overall skin specified in the parameters section.
- height-height of the row in pixels
- allowed values:number
- mandatory:no
- default: The maximum of the heights of the elements in the row, taking "rows" and "marginY" into account.
- marginX,marginY-space, in pixels, between adjacent icons horizontally and vertically
- allowed values: number
- mandatory:no
- default:0
Page:
- loadonstartup - defines whether the page is loaded on startup of the app so loading is quicker when it is selected.
- mandatory: no
- allowed values: true, false
- default: false
- autounload - defines whether the memory is released after leaving a page
- mandatory: no
- allowed values: true, false
- default: false
Many of the attributes can contain variables