Dgs-dxwindow: Difference between revisions
| (5 intermediate revisions by 2 users not shown) | |||
| Line 24: | Line 24: | ||
<syntaxhighlight lang="lua">dgsSetProperty(window,"borderSize",borderSize)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(window,"borderSize",borderSize)</syntaxhighlight> | ||
*'''borderSize:''' An integer of the size of the border of the window in pixels. | *'''borderSize:''' An integer of the size of the border of the window in pixels. | ||
===closeButtonEnabled=== | |||
This property determines whether the close button of window is enabled or not. | |||
<syntaxhighlight lang="lua">dgsSetProperty(window,"closeButtonEnabled",closeButtonEnabled)</syntaxhighlight> | |||
*'''closeButtonEnabled:''' A bool of whether close button is enabled or not. | |||
===color=== | ===color=== | ||
| Line 30: | Line 35: | ||
*'''color:''' An integer of the color of the background of the window. | *'''color:''' An integer of the color of the background of the window. | ||
=== | ===colorCoded=== | ||
Whether the color code in the title text is enabled or not. ''Learn More [[dxDrawText]]'' | Whether the color code in the title text is enabled or not. ''Learn More [[dxDrawText]]'' | ||
<syntaxhighlight lang="lua">dgsSetProperty(window," | <syntaxhighlight lang="lua">dgsSetProperty(window,"colorCoded",colorCoded)</syntaxhighlight> | ||
*''' | *'''colorCoded:''' Set to true to enable embedded #FFFFFF color codes. | ||
===font=== | ===font=== | ||
| Line 66: | Line 71: | ||
<syntaxhighlight lang="lua">dgsSetProperty(window,"movable",movable)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(window,"movable",movable)</syntaxhighlight> | ||
*'''movable:''' A boolean value indicating whether user can move the window or not. | *'''movable:''' A boolean value indicating whether user can move the window or not. | ||
===sizable=== | ===sizable=== | ||
| Line 88: | Line 86: | ||
<syntaxhighlight lang="lua">dgsSetProperty(window,"textColor",textColor)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(window,"textColor",textColor)</syntaxhighlight> | ||
*'''textColor:''' An integer of the color of the title text of the window. | *'''textColor:''' An integer of the color of the title text of the window. | ||
===textOffset=== | |||
The offset of the title text of window. | |||
<syntaxhighlight lang="lua">dgsSetProperty(window,"textOffset",{offsetX,offsetY,relative})</syntaxhighlight> | |||
*'''offsetX''' : A float of the 2D X offset relative to the position of the text of window, depends on '''relative'''. | |||
*'''offsetY''' : A float of the 2D Y offset relative to the position of the text of window, depends on '''relative'''. | |||
*'''relative''' : A bool of whether the offset is relative or absolute. | |||
===textSize=== | ===textSize=== | ||
| Line 96: | Line 101: | ||
===titleColor=== | ===titleColor=== | ||
The color which can be translated by [[tocolor]] of the '''title''' of the window when the window is '''focused''' ( For ''' | The color which can be translated by [[tocolor]] of the '''title''' of the window when the window is '''focused''' ( For '''blurred''', see [[#titleColorBlur|titleColorBlur]] ). | ||
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColor",titleColor)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(window,"titleColor",titleColor)</syntaxhighlight> | ||
*'''titleColor:''' An integer of the color of the title of the focused window. | *'''titleColor:''' An integer of the color of the title of the focused window. | ||
===titleColorBlur=== | ===titleColorBlur=== | ||
The color which can be translated by [[tocolor]] of the title of the window when the window is blurred. | The color which can be translated by [[tocolor]] of the title of the window when the window is '''blurred'''. | ||
<syntaxhighlight lang="lua">dgsSetProperty(window,"titleColorBlur",titleColorBlur)</syntaxhighlight> | <syntaxhighlight lang="lua">dgsSetProperty(window,"titleColorBlur",titleColorBlur)</syntaxhighlight> | ||
*'''titleColorBlur:''' An integer of the color of the title of the blurred window. Set to ''nil'' to disable blur color. | *'''titleColorBlur:''' An integer of the color of the title of the blurred window. Set to ''nil'' to disable blur color. | ||
Latest revision as of 12:01, 11 April 2022
DGS Properties is always used to change the gui style and make it more fantastic.
This page shows the properties of dgs-dxwindow that you could use.
Main Functions
Properties
alignment
Alignment of the title text of the window.
The functions as follows are based on this property.
dgsWindowSetHorizontalAlign/dgsWindowGetHorizontalAlign
dgsWindowSetVerticalAlign/dgsWindowGetVerticalAlign
dgsSetProperty(window,"alignment",{alignX,alignY})
- alignX: Horizontal alignment of the title text of the windowl. Can be "left", "center" or "right".
- alignY: Vertical alignment of the title text of the window. Can be "top", "center" or "bottom".
borderSize
This property determines the border size in pixels which is used to resize the window.
dgsSetProperty(window,"borderSize",borderSize)
- borderSize: An integer of the size of the border of the window in pixels.
closeButtonEnabled
This property determines whether the close button of window is enabled or not.
dgsSetProperty(window,"closeButtonEnabled",closeButtonEnabled)
- closeButtonEnabled: A bool of whether close button is enabled or not.
color
The color which can be translated by tocolor of the background of the window.
dgsSetProperty(window,"color",color)
- color: An integer of the color of the background of the window.
colorCoded
Whether the color code in the title text is enabled or not. Learn More dxDrawText
dgsSetProperty(window,"colorCoded",colorCoded)
- colorCoded: Set to true to enable embedded #FFFFFF color codes.
font
This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText
dgsSetProperty(window,"font",font)
- font: A dx font element of the title text font of the window.
ignoreTitle
This property determines whether to ignore the window title when calculating window's child elements (useful for gui to dgs).
dgsSetProperty(window,"ignoreTitle",ignoreTitle)
- ignoreTitle: A bool of the state of whether to ignore the window title.
image
The texture element(texture/render target/screen source/shader etc) of the background of the window.
dgsSetProperty(window,"image",image)
- image: A texture element of the background of the window.
maxSize
This property determines the maximum width and height of the window that users can resize to.
dgsSetProperty(window,"maxSize",{maxWidth,maxHeight})
- maxWidth: An integer of the maximum width of the window.
- maxHeight: An integer of the maximum height of the window.
minSize
This property determines the minimum width and height of the window that users can resize to.
dgsSetProperty(window,"minSize",{minWidth,minHeight})
- minWidth: An integer of the minimum width of the window.
- minHeight: An integer of the minimum height of the window.
movable
This is equivalent to dgsWindowSetMovable, which allows you to specify whether or not a user can move a DGS window.
dgsSetProperty(window,"movable",movable)
- movable: A boolean value indicating whether user can move the window or not.
sizable
This is equivalent to dgsWindowSetSizable, which allows you to specify whether or not a user can resize a DGS window.
dgsSetProperty(window,"sizable",sizable)
- movable: A boolean value indicating whether user can resize the window or not.
text
This is equivalent to dgsSetText/dgsGetText.
dgsSetProperty(window,"text",text)
- text: A string of the title text of the window.
textColor
The color which can be translated by tocolor of the title text of the window.
dgsSetProperty(window,"textColor",textColor)
- textColor: An integer of the color of the title text of the window.
textOffset
The offset of the title text of window.
dgsSetProperty(window,"textOffset",{offsetX,offsetY,relative})
- offsetX : A float of the 2D X offset relative to the position of the text of window, depends on relative.
- offsetY : A float of the 2D Y offset relative to the position of the text of window, depends on relative.
- relative : A bool of whether the offset is relative or absolute.
textSize
The scale of the title text of the window. Learn More dxDrawText
dgsSetProperty(window,"textSize",{scaleX,scaleY})
- scaleX: A float of the 2D X scale of the title text of the window.
- scaleY: A float of the 2D Y scale of the title text of the window.
titleColor
The color which can be translated by tocolor of the title of the window when the window is focused ( For blurred, see titleColorBlur ).
dgsSetProperty(window,"titleColor",titleColor)
- titleColor: An integer of the color of the title of the focused window.
titleColorBlur
The color which can be translated by tocolor of the title of the window when the window is blurred.
dgsSetProperty(window,"titleColorBlur",titleColorBlur)
- titleColorBlur: An integer of the color of the title of the blurred window. Set to nil to disable blur color.
titleHeight
This property determines the title size in pixels which is also used to move the window.
dgsSetProperty(window,"titleHeight",titleHeight)
- titleHeight: An integer of the size of the title of the window in pixels.
titleImage
The texture element(texture/render target/screen source/shader etc) of the title background of the window.
dgsSetProperty(window,"titleImage",titleImage)
- titleImage: A texture element of the title background of the window.
See Also
General Properties
Unique Properties For DGS Core Elements
- dgs-dx3dinterface
- dgs-dx3dimage
- dgs-dx3dtext
- dgs-dx3dline
- dgs-dxbutton
- dgs-dxcheckbox
- dgs-dxcombobox
- dgs-dxdetectarea
- dgs-dxedit
- dgs-dxgridlist
- dgs-dximage
- dgs-dxlabel
- dgs-dxline
- dgs-dxmemo
- dgs-dxprogressbar
- dgs-dxradiobutton
- dgs-dxscrollbar
- dgs-dxscrollpane
- dgs-dxselector
- dgs-dxswitchbutton
- dgs-dxtabpanel
- dgs-dxtab
- dgs-dxwindow