DgsMemoMoveCaret: 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 edit box. ==Syntax== <syntaxhighlight lang="lua"> bool guiEd...")
 
Line 12: Line 12:
*'''indexoffset:''' An integer referring to the desired position within the box.
*'''indexoffset:''' An integer referring to the desired position within the box.
===Optional Arguments===
===Optional Arguments===
*'''lineoffset:''' An integer referring to the desired position within the box.
*'''lineoffset:''' An integer indicated how many lines will the cursor move in the box.
*'''selectText:''' An integer referring to the desired position within the box.
*'''selectText:''' A bool indicated whether this movement will select text.
*'''noChangeLine:''' An integer referring to the desired position within the box.
*'''noChangeLine:''' A bool indicated whether this movement won't jump to another line.


===Returns===
===Returns===

Revision as of 08:54, 2 December 2017

This function sets the current position of the caret (the text cursor) within the edit box.

Syntax

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

Required Arguments

  • theElement: The edit box to be changed.
  • indexoffset: An integer referring to the desired position within the box.

Optional Arguments

  • lineoffset: An integer indicated how many lines will the cursor move in the box.
  • 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

This example makes the text cursor jump to the end of an edit box if the user is holding the Left Control button. 

function moveToEndOnClick()
	if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then          -- if the user is holding down left control
		local text = guiGetText ( source )
		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
	end
end
addEventHandler ( "onClientGUIClick", getRootElement(), moveToEndOnClick )    -- add an event handler for clicks

See Also

General functions

Browsers

Buttons

Checkboxes

Comboboxes

Edit Boxes

Gridlists

Memos

Progressbars

Radio Buttons

Scrollbars

Scrollpanes

Static Images

Tab Panels

Tabs

Text Labels

Windows

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