DgsMemoGetCaretPosition: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(Created page with "__NOTOC__ {{Client function}} This function sets the current position of the caret (the text cursor) within the memo. ==Syntax== <syntaxhighlight lang="lua"> bool dgsDxMemo...")
 
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
{{Client function}}
{{Client function}}
This function sets the current position of the caret (the text cursor) within the memo.
This function gets the current position of the caret (the text cursor) within the memo.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool dgsDxMemoGetCaretPosition ( element theElement )
int int dgsMemoGetCaretPosition ( element theElement )
</syntaxhighlight>  
</syntaxhighlight>  


Line 12: Line 12:


===Returns===
===Returns===
Returns two ''floats'' indicating the position of the caret, index and line respectively.
Returns two ''integers'' indicating the position of the caret, index and line respectively.


==Example==
==Example==
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
DGS = exports.dgs
DGS = exports.dgs
memo = DGS:dgsDxCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
memo = DGS:dgsCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
index,line = DGS:dgsDxMemoGetCaretPosition(memo)
index,line = DGS:dgsMemoGetCaretPosition(memo)
outputChatBox("Caret Position: Index ("..index..")  Line ("..line..")")
outputChatBox("Caret Position: Index ("..index..")  Line ("..line..")")
</syntaxhighlight>
</syntaxhighlight>

Latest revision as of 10:56, 20 January 2018

This function gets the current position of the caret (the text cursor) within the memo.

Syntax

int int dgsMemoGetCaretPosition ( element theElement )

Required Arguments

  • theElement: The memo to get from.

Returns

Returns two integers indicating the position of the caret, index and line respectively.

Example

DGS = exports.dgs
memo = DGS:dgsCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
index,line = DGS:dgsMemoGetCaretPosition(memo)
outputChatBox("Caret Position: Index ("..index..")  Line ("..line..")")

See Also

Custom Cursor Functions

Multi Language Supports

Animation

3D Element

3D Interface

3D Line

3D Image

3D Text

Browser

Button

Check Box

Combo Box

Custom Renderer

Edit

Detect Area

Drag'N Drop

Grid List

Image

Memo

Menu

Label

Layout

Line

Progress Bar

Radio Button

Scale Pane

Scroll Bar

Scroll Pane

Selector

Style

Switch Button

Tab Panel

Window

Basic Shape Plugins

Circle

Quadrilateral

Rounded Rectangle

Other Plugins

Blur Box

Canvas

Chart

Color Picker

Effect 3D

Gradient

Mask

Media Browser

Nine Slice

Object Preview Supports

Paste Handler

QRCode

Remote Image

Screen Source

SVG

Tooltips