Creation/Dev/Script/Client/GuiControlProfile: Difference between revisions
From Graal Bible
m (Fixed typos and added some clarification) |
Pooper200000 (talk | contribs) No edit summary |
||
(9 intermediate revisions by 2 users not shown) | |||
Line 1: | Line 1: | ||
[[Category:Scripting Reference]] | |||
Inherits [[Creation/Dev/Script/Client/TGraalVar|TGraalVar]]. | |||
=Description= | |||
GUI profiles define the look of a GUI control. Several GUI controls can share the same profile, and the profile can be exchanged at any time. | |||
For more information: [[Creation/Dev/GScript/Understanding_GUI_Profiles|Understanding GUI Profiles]] | |||
=Variables= | |||
<pre> | <pre> | ||
align - string - controls justification of text: "left", "center" or "right", | |||
align - string - "left", "center" or "right" | also set autosizewidth=false if you want to center or right-align GuiTextCtrls | ||
autosizeheight - boolean | autosizeheight - boolean | ||
autosizewidth - boolean | autosizewidth - boolean | ||
bitmap - string - filename of the image template, ie: "guiblue_window.png" | bitmap - string - filename of the image template, ie: "guiblue_window.png" | ||
border - integer | border - integer (1..5): | ||
bordercolor - | 0 - no border | ||
bordercolorhl - | 1 - single-color border using bordercolor | ||
bordercolorna - | 2 - rectangle using white and bordercolorna | ||
3 - lowered rectangle using white, fillcolor and bordercolorna | |||
4 - raised rectangle using white, black and bordercolor | |||
5 - bitmap border | |||
bordercolor - {red,green,blue,alpha} - default border color of the control | |||
bordercolorhl - {red,green,blue,alpha} - border color when the control is active | |||
bordercolorna - {red,green,blue,alpha} - border color when the control is disabled | |||
borderthickness - integer - size of the border (in pixels?) | borderthickness - integer - size of the border (in pixels?) | ||
cankeyfocus - boolean - can this control steal key focus? (textboxes must have this set to true) | cankeyfocus - boolean - can this control steal key focus? (textboxes must have this set to true) | ||
cursorcolor - | cursorcolor - {red,green,blue,alpha} - color of the cursor (caret) in a text box | ||
fillcolor - | fillcolor - {red,green,blue,alpha} - default background color | ||
fillcolorhl - | fillcolorhl - {red,green,blue,alpha} - background color when active | ||
fillcolorna - | fillcolorna - {red,green,blue,alpha} - background color when disabled | ||
fontcolor - | fontcolor - {red,green,blue,alpha} - default font color | ||
fontcolorhl - | fontcolorhl - {red,green,blue,alpha} - font color when highlighted | ||
fontcolorna - | fontcolorna - {red,green,blue,alpha} - font color when disabled | ||
fontcolorsel - | fontcolorsel - {red,green,blue,alpha} - font color of selected text (in a textbox) | ||
fontcolorlink - | fontcolorlink - {red,green,blue,alpha} - default font color of links | ||
fontcolorlinkhl - | fontcolorlinkhl - {red,green,blue,alpha} - font color of links when active | ||
fontsize - integer - size of the font | fontsize - integer - size of the font | ||
fontstyle - string - combination of font styles, ie: "bc" | fontstyle - string - combination of font styles, | ||
ie: "bc" (b - bold, i - italic, u - underline, | |||
s - strikeout, c - centered, r - right aligned) | |||
fonttype - string - type of font to use, ie: "Tempus Sans ITC" | fonttype - string - type of font to use, ie: "Tempus Sans ITC" | ||
justify - string - the same like "align" | justify - string - the same like "align" | ||
linespacing - integer - | linespacing - integer - number of pixels between lines in multiline controls | ||
modal - boolean - | modal - boolean - can be focussed and steals the input | ||
mouseoverselected - boolean - does putting your mouse over this control act as if it was clicked? | (e.g. edit controls or text list control | ||
where you navigate with the cursor key) | |||
mouseoverselected - boolean - does putting your mouse over | |||
this control act as if it was clicked? | |||
numbersonly - boolean - can only numbers be entered in this control? | numbersonly - boolean - can only numbers be entered in this control? | ||
opaque - boolean - if set to true, transparency will be ignored | opaque - boolean - if set to true, transparency will be ignored | ||
returntab - boolean | returntab - boolean | ||
shadowcolor - {red,green,blue} - specifies the color | |||
of the shadow (use in combination with textshadow=true) | |||
shadowoffset - array of format {offsetx,offsety} - | |||
specifies the position of the shadow | |||
(use in combination with textshadow=true) | |||
soundbuttondown - string - filename of sound played when the control is clicked | soundbuttondown - string - filename of sound played when the control is clicked | ||
soundbuttonover - string - filename of sound played when the mouse is hovered over the control | soundbuttonover - string - filename of sound played when the mouse is hovered over the control | ||
tab - boolean | tab - boolean | ||
textoffset - string | textoffset - string - controls how far offset the | ||
text is from the top-left of the control | |||
textshadow - boolean - enables or disables the shadow | |||
transparency - float - alpha transparency of the control (from 0 to 1) | transparency - float - alpha transparency of the control (from 0 to 1) | ||
</pre> | </pre> |
Latest revision as of 23:51, 15 February 2010
Inherits TGraalVar.
Description
GUI profiles define the look of a GUI control. Several GUI controls can share the same profile, and the profile can be exchanged at any time. For more information: Understanding GUI Profiles
Variables
align - string - controls justification of text: "left", "center" or "right", also set autosizewidth=false if you want to center or right-align GuiTextCtrls autosizeheight - boolean autosizewidth - boolean bitmap - string - filename of the image template, ie: "guiblue_window.png" border - integer (1..5): 0 - no border 1 - single-color border using bordercolor 2 - rectangle using white and bordercolorna 3 - lowered rectangle using white, fillcolor and bordercolorna 4 - raised rectangle using white, black and bordercolor 5 - bitmap border bordercolor - {red,green,blue,alpha} - default border color of the control bordercolorhl - {red,green,blue,alpha} - border color when the control is active bordercolorna - {red,green,blue,alpha} - border color when the control is disabled borderthickness - integer - size of the border (in pixels?) cankeyfocus - boolean - can this control steal key focus? (textboxes must have this set to true) cursorcolor - {red,green,blue,alpha} - color of the cursor (caret) in a text box fillcolor - {red,green,blue,alpha} - default background color fillcolorhl - {red,green,blue,alpha} - background color when active fillcolorna - {red,green,blue,alpha} - background color when disabled fontcolor - {red,green,blue,alpha} - default font color fontcolorhl - {red,green,blue,alpha} - font color when highlighted fontcolorna - {red,green,blue,alpha} - font color when disabled fontcolorsel - {red,green,blue,alpha} - font color of selected text (in a textbox) fontcolorlink - {red,green,blue,alpha} - default font color of links fontcolorlinkhl - {red,green,blue,alpha} - font color of links when active fontsize - integer - size of the font fontstyle - string - combination of font styles, ie: "bc" (b - bold, i - italic, u - underline, s - strikeout, c - centered, r - right aligned) fonttype - string - type of font to use, ie: "Tempus Sans ITC" justify - string - the same like "align" linespacing - integer - number of pixels between lines in multiline controls modal - boolean - can be focussed and steals the input (e.g. edit controls or text list control where you navigate with the cursor key) mouseoverselected - boolean - does putting your mouse over this control act as if it was clicked? numbersonly - boolean - can only numbers be entered in this control? opaque - boolean - if set to true, transparency will be ignored returntab - boolean shadowcolor - {red,green,blue} - specifies the color of the shadow (use in combination with textshadow=true) shadowoffset - array of format {offsetx,offsety} - specifies the position of the shadow (use in combination with textshadow=true) soundbuttondown - string - filename of sound played when the control is clicked soundbuttonover - string - filename of sound played when the mouse is hovered over the control tab - boolean textoffset - string - controls how far offset the text is from the top-left of the control textshadow - boolean - enables or disables the shadow transparency - float - alpha transparency of the control (from 0 to 1)