Dgs-dxmemo: Difference between revisions

Revision as of 10:59, 17 July 2021

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

allowCopy

This property determines whether the content of memo can be copy(ctrl+c)/cut(ctrl+x)

dgsSetProperty(memo,"allowCopy",allowCopy)

allowCopy: A boolean value of the state of whether this memo allows users to copy something from it.

padding

This property determines the content padding from 4 sides of element (left/top/right/bottom)

dgsSetProperty(memo,"padding", {horizontal, vetical})

horizontal: A float of the horizontal padding in pixels.
vetical: A float of the vertical padding in pixels.

bgColor

This property determines the background color of the memo.

dgsSetProperty(memo,"bgColor",bgColor)

bgColor: An integer of the color that can be converted by tocolor.

bgColorBlur

This property determines the background color of the memo when it is blurred.

dgsSetProperty(memo,"bgColorBlur",bgColorBlur)

bgColorBlur: An integer of the color that can be converted by tocolor, leave to nil to use bgColor.

bgImage

This property determines the background image of the memo.

dgsSetProperty(memo,"bgImage",bgImage)

bgImage: A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget).

bgImageBlur

This property determines the background image of the memo when it is blurred.

dgsSetProperty(memo,"bgImageBlur",bgImageBlur)

bgImageBlur: A material element that serves as the background image of the memo (texture/shader/screen source/renderTarget), leave to nil to use bgImage.

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.

caretHeight

The height of the caret of the memo (multiple of the font height).

dgsSetProperty(memo,"caretHeight",caretHeight)

caretHeight: A float of the caret height.

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.

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.

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.

font

This is equivalent to dgsSetFont/dgsGetFont. Learn More dxDrawText

dgsSetProperty(memo,"font",font)

font: A dx font element of the text font of the memo.

memo

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

dgsSetProperty(memo,"memo",gmemo)

gmemo: A gui-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.

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.

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.

scrollSize

This property determines how many lines will get scrolled out of the rendering area once when you are scrolling your mouse wheel.

dgsSetProperty(memo,"scrollSize",scrollSize)

scrollSize: Lines to be scrolled.

selectColorBlur

The color which can be translated by tocolor of the rectangle of text selection of the memo when blurred.

dgsSetProperty(memo,"selectColorBlur",selectColorBlur)

selectColorBlur: An integer of the color of the rectangle of text selection of the memo when blurred.

selectColor

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

dgsSetProperty(memo,"selectColor",selectColor)

selectColor: An integer of the color of the rectangle of text selection of the memo.

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.

showLine

This property stores the value of how many lines does the text move to top.

dgsSetProperty(memo,"showLine",line)

line: An integer indicates how many lines does the text move to top.

showPos

This property stores the value of how many pixels of the text are moved to left.

dgsSetProperty(memo,"showPos",posX)

posX: An integer indicates how many pixels of the text are moved to left.

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 )

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.

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.

typingSound

Typing sound, nil for disabled. This is equivalent to dgsMemoSetTypingSound/dgsMemoGetTypingSound

dgsSetProperty(memo,"typingSound",typingSound)

typingSound: A string of the path/url of typing sound.

typingSoundVolume

Typing sound, nil for disabled. This is equivalent to dgsMemoSetTypingSoundVolume/dgsMemoGetTypingSoundVolume

dgsSetProperty(memo,"typingSoundVolume",typingSoundVolume)

typingSoundVolume: A float of the volume of the typing sound. Range is from 0.0 to 1.0. This can go above 1.0 for amplification.

wordWrap

This property determines the word wrap state of dgs memo. This is equivalent to dgsMemoSetWordWrapState/dgsMemoGetWordWrapState

dgsSetProperty(memo,"wordWrap",wordWrap)

wordWarp: An integer or a bool of word wrap state, vaild state are as follows:
- false: Non-wordwrap
- 1: Split via single character ( This will break a word into 2 parts )
- 2: Split via word

@@ Line 15: / Line 15: @@
 ===padding===
 This property determines the content padding from 4 sides of element (left/top/right/bottom)
-<syntaxhighlight lang="lua">dgsSetProperty(memo,"padding", {fromLeft/fromTop/fromRight/fromBottom})</syntaxhighlight>
+<syntaxhighlight lang="lua">dgsSetProperty(memo,"padding", {horizontal, vetical})</syntaxhighlight>
-*'''padding:'''  A table value contains the padding you want to apply
+*'''horizontal:'''  A float of the horizontal padding in pixels.
+*'''vetical:'''  A float of the vertical padding in pixels.
 ===bgColor===