DgsMemoMoveCaret: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
m (Thisdp moved page DgsDxMemoMoveCaret to DgsMemoMoveCaret)
 
(8 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 edit box.
This function sets the current position of the caret (the text cursor) within the memo by offsets.


==Syntax==  
==Syntax==  
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiEditSetCaretIndex ( element theElement, int indexoffset [, int lineoffset = 0, bool selectText = false, bool noChangeLine = false ] )
bool dgsMemoMoveCaret ( element theElement, int indexoffset [, int lineoffset = 0, bool selectText = false, bool noChangeLine = false ] )
</syntaxhighlight>  
</syntaxhighlight>  


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The edit box to be changed.
*'''theElement:''' The memo to be changed.
*'''indexoffset:''' An integer indicated how many indexes will the cursor move within the box.
*'''indexoffset:''' An integer indicated how many indexes will the cursor move within the memo.


===Optional Arguments===
===Optional Arguments===
*'''lineoffset:''' An integer indicated how many lines will the cursor move within the box.
*'''lineoffset:''' An integer indicated how many lines will the cursor move within the memo.
*'''selectText:''' A bool indicated whether this movement will select text.
*'''selectText:''' A bool indicated whether this movement will select text.
*'''noChangeLine:''' A bool indicated whether this movement won't jump to another line.
*'''noChangeLine:''' A bool indicated whether this movement won't jump to another line.
Line 21: Line 21:


==Example==
==Example==
This example makes the text cursor jump to the end of an edit box if the user is holding the Left Control button.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function moveToEndOnClick()
DGS = exports.dgs
if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then          -- if the user is holding down left control
 
local text = guiGetText ( source )
memo = DGS:dgsCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)
local textLength = string.len ( text )
 
guiEditSetCaretIndex ( source, textLength ) -- set the caret index. No need to check if the clicked control is actually an edit box as this function won't work on other controls anyway
DGS:dgsBringToFront(memo)
end
 
end
setTimer(function()
addEventHandler ( "onClientGUIClick", getRootElement(), moveToEndOnClick )   -- add an event handler for clicks
DGS:dgsMemoMoveCaret(memo,1)
end,500,10)
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{DGSFUNCTIONS}}
{{DGSFUNCTIONS}}

Latest revision as of 10:55, 20 January 2018

This function sets the current position of the caret (the text cursor) within the memo by offsets.

Syntax

bool dgsMemoMoveCaret ( element theElement, int indexoffset [, int lineoffset = 0, bool selectText = false, bool noChangeLine = false ] )

Required Arguments

  • theElement: The memo to be changed.
  • indexoffset: An integer indicated how many indexes will the cursor move within the memo.

Optional Arguments

  • lineoffset: An integer indicated how many lines will the cursor move within the memo.
  • selectText: A bool indicated whether this movement will select text.
  • noChangeLine: A bool indicated whether this movement won't jump to another line.

Returns

Returns true if the index was successfully set, false otherwise.

Example

DGS = exports.dgs

memo = DGS:dgsCreateMemo(500,200,200,300,"This is a dgs-dxmemo",false)

DGS:dgsBringToFront(memo)

setTimer(function()
	DGS:dgsMemoMoveCaret(memo,1)
end,500,10)

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

Retrieved from "https://wiki.multitheftauto.com/wiki/DgsMemoMoveCaret?oldid=53561"