Dgs-dxmemo: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
Line 18: Line 18:
*'''textlen''' : A table stores the length of text in every line.
*'''textlen''' : A table stores the length of text in every line.


===textcolor===
===textColor===
The color which can be translated by [[tocolor]] of the text of the memo.
The color which can be translated by [[tocolor]] of the text of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textcolor",textcolor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textColor",textColor)</syntaxhighlight>
*'''textcolor''' : An integer of the color of the text of the memo.
*'''textColor''' : An integer of the color of the text of the memo.


===textsize===
===textSize===
The scale of the text of the memo. ''Learn More [[dxDrawText]]''
The scale of the text of the memo. ''Learn More [[dxDrawText]]''
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textsize",{scaleX,scaleY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"textSize",{scaleX,scaleY})</syntaxhighlight>
*'''scaleX''' : A float of the 2D X scale of the text of the memo.
*'''scaleX''' : A float of the 2D X scale of the text of the memo.
*'''scaleY''' : A float of the 2D Y scale of the text of the memo.
*'''scaleY''' : A float of the 2D Y scale of the text of the memo.


===cursorposXY===
===caretPos===
The position in which the caret stays.
The position in which the caret stays.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"cursorposXY",{index,line})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretPos",{index,line})</syntaxhighlight>
*'''index''' : An integer of the index of the text in current line of the memo.
*'''index''' : An integer of the index of the text in current line of the memo.
*'''line''' : An integer of the line of the memo.
*'''line''' : An integer of the line of the memo.
Line 40: Line 40:
*'''caretColor''' : An integer of the color that can be converted by [[tocolor]].
*'''caretColor''' : An integer of the color that can be converted by [[tocolor]].


===selectfrom===
===selectFrom===
The position from which the text is selected.
The position from which the text is selected.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectfrom",{index,line})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectFrom",{index,line})</syntaxhighlight>
*'''index''' : An integer of the index of the text in the line where the text is selected from of the memo.
*'''index''' : An integer of the index of the text in the line where the text is selected from of the memo.
*'''line''' : An integer of the line where the text is selected from of the memo.
*'''line''' : An integer of the line where the text is selected from of the memo.
Line 50: Line 50:
<syntaxhighlight lang="lua">dgsSetProperty(memo,"font",font)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"font",font)</syntaxhighlight>
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the memo.
*'''font''' : A [[Element/DX_font|dx font element]] of the text font of the memo.
===rightLength===
The max value of the index and line of the memo. This is for scroll bar detection.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"rightLength",{index,line})</syntaxhighlight>
*'''index''' : An integer of the max value of the index of the memo.
*'''line''' : An integer of the max value of the line of the memo.


===showPos===
===showPos===
Line 67: Line 61:
*'''line''' : An integer indicates how many lines are moved to top.
*'''line''' : An integer indicates how many lines are moved to top.


===cursorStyle===
===caretStyle===
This is equivalent to [[dgsMemoSetCaretStyle]]/[[dgsMemoGetCaretStyle]].
This is equivalent to [[dgsMemoSetCaretStyle]]/[[dgsMemoGetCaretStyle]].


Line 79: Line 73:


This is Text_
This is Text_
<syntaxhighlight lang="lua">dgsSetProperty(memo,"cursorStyle",cursorStyle)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretStyle",caretStyle)</syntaxhighlight>
*'''cursorStyle''' : An integer of the caret style of the memo.
*'''caretStyle''' : An integer of the caret style of the memo.


===cursorThick===
===caretThick===
This property allows us to change the thickness of caret of the memo.
This property allows us to change the thickness of caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"cursorThick",cursorThick)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretThick",caretThick)</syntaxhighlight>
*'''cursorThick''' : An integer of the thickness of the caret of the memo.
*'''caretThick''' : An integer of the thickness of the caret of the memo.


===scrollBarThick===
===scrollBarThick===
Line 92: Line 86:
*'''scrollBarThick''' : An integer of the thickness of scroll bars of the memo.
*'''scrollBarThick''' : An integer of the thickness of scroll bars of the memo.


===cursorOffset===
===caretOffset===
The offset of the caret of the memo.
The offset of the caret of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"cursorOffset",{offsetX,offsetY})</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"caretOffset",{offsetX,offsetY})</syntaxhighlight>
*'''offsetX''' : A float of the 2D X position offset of the caret of the memo.
*'''offsetX''' : A float of the 2D X position offset of the caret of the memo.
*'''offsetY''' : A float of the 2D Y position offset of the caret of the memo.
*'''offsetY''' : A float of the 2D Y position offset of the caret of the memo.
Line 108: Line 102:
*'''readOnlyCaretShow''' : A bool indicates whether the caret is shown or hidden when the memo is read-only.
*'''readOnlyCaretShow''' : A bool indicates whether the caret is shown or hidden when the memo is read-only.


===side===
===selectColor===
The border size of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"side",side)</syntaxhighlight>
*'''side''' : A float of the border size of the memo.
 
===sidecolor===
The border color which can be translated by [[tocolor]] of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"sidecolor",sidecolor)</syntaxhighlight>
*'''sidecolor''' : An integer of the color of the border of the memo.
 
===selectcolor===
The color which can be translated by [[tocolor]] of the rectangle of test selection of the memo.
The color which can be translated by [[tocolor]] of the rectangle of test selection of the memo.
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectcolor",selectcolor)</syntaxhighlight>
<syntaxhighlight lang="lua">dgsSetProperty(memo,"selectColor",selectColor)</syntaxhighlight>
*'''selectcolor''' : An integer of the color of the rectangle of test selection of the memo.
*'''selectColor''' : An integer of the color of the rectangle of test selection of the memo.


===memo===
===memo===

Revision as of 12:44, 14 August 2018

DGS Properties is always used to change the gui style and make it more fantastic.

This page shows the properties of dgs-dxmemo that you could use.

Main Functions

Properties

text

This is equivalent to dgsSetText/dgsGetText. 

dgsSetProperty(memo,"text",text)
  • text : A table of the text of the memo.( Because of multi lines, I use table instead of string )

textLength

This is for scroll bar detection. You had better not touch it. 

dgsSetProperty(memo,"textLength",textlen)
  • textlen : A table stores the length of text in every line.

textColor

The color which can be translated by tocolor of the text of the memo. 

dgsSetProperty(memo,"textColor",textColor)
  • textColor : An integer of the color of the text of the memo.

textSize

The scale of the text of the memo. Learn More dxDrawText 

dgsSetProperty(memo,"textSize",{scaleX,scaleY})
  • scaleX : A float of the 2D X scale of the text of the memo.
  • scaleY : A float of the 2D Y scale of the text of the memo.

caretPos

The position in which the caret stays. 

dgsSetProperty(memo,"caretPos",{index,line})
  • index : An integer of the index of the text in current line of the memo.
  • line : An integer of the line of the memo.

caretColor

This property determines the color of the caret 

dgsSetProperty(memo,"caretColor",caretColor)
  • caretColor : An integer of the color that can be converted by tocolor.

selectFrom

The position from which the text is selected. 

dgsSetProperty(memo,"selectFrom",{index,line})
  • index : An integer of the index of the text in the line where the text is selected from of the memo.
  • line : An integer of the line where the text is selected from of the memo.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText 

dgsSetProperty(memo,"font",font)

showPos

The min value of the x position of the text of the memo starts to show in the render target. ( I don't know how to explain it. XD ) 

dgsSetProperty(memo,"showPos",posX)
  • posX : An integer indicates how many the pixels of the text are moved to left.

showLine

The min value of the line of the text of the memo starts to show in the render target. ( I don't know how to explain it. XD ) 

dgsSetProperty(memo,"showLine",line)
  • line : An integer indicates how many lines are moved to top.

caretStyle

This is equivalent to dgsMemoSetCaretStyle/dgsMemoGetCaretStyle.

This property allows us to change the style of caret of the memo. ( 0 is "|"; 1 is "_" )

Example(0):

This is Text|

Example(1):

This is Text_ 

dgsSetProperty(memo,"caretStyle",caretStyle)
  • caretStyle : An integer of the caret style of the memo.

caretThick

This property allows us to change the thickness of caret of the memo. 

dgsSetProperty(memo,"caretThick",caretThick)
  • caretThick : An integer of the thickness of the caret of the memo.

scrollBarThick

This property allows us to change the thickness of scroll bars of the memo. 

dgsSetProperty(memo,"scrollBarThick",scrollBarThick)
  • scrollBarThick : An integer of the thickness of scroll bars of the memo.

caretOffset

The offset of the caret of the memo. 

dgsSetProperty(memo,"caretOffset",{offsetX,offsetY})
  • offsetX : A float of the 2D X position offset of the caret of the memo.
  • offsetY : A float of the 2D Y position offset of the caret of the memo.

readOnly

This is equivalent to dgsMemoSetReadOnly/dgsMemoGetReadOnly. 

dgsSetProperty(memo,"readOnly",readOnly)
  • readOnly : A bool indicates whether the memo is only readable.

readOnlyCaretShow

Whether the caret of memo will show/hide under read-only mode. 

dgsSetProperty(memo,"readOnlyCaretShow",readOnlyCaretShow)
  • readOnlyCaretShow : A bool indicates whether the caret is shown or hidden when the memo is read-only.

selectColor

The color which can be translated by tocolor of the rectangle of test selection of the memo. 

dgsSetProperty(memo,"selectColor",selectColor)
  • selectColor : An integer of the color of the rectangle of test selection of the memo.

memo

This property stores a gui-memo which is used to input characters. 

dgsSetProperty(memo,"memo",gmemo)
  • gmemo : A gui-memo.

renderTarget

This property stores a render target of the memo. 

dgsSetProperty(memo,"renderTarget",renderTarget)
  • renderTarget : A render target that is used to render the text.

scrollbars

This property stores two scroll bars which can be got by dgsMemoGetScrollBar of the memo. 

dgsSetProperty(memo,"scrollbars",{Vertical,Horizontal})
  • Vertical : A vertical scroll bar of the memo.
  • Horizontal : A horizontal scroll bar of the memo.

See Also

General Properties

Unique Properties For DGS Core Elements

Extra Properties For DGS Plugins

Retrieved from "https://wiki.multitheftauto.com/wiki/Dgs-dxmemo?oldid=58086"