GuiEditSetCaretIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
(New page: __NOTOC__ {{Client function}} This function sets the current position of the caret (the text cursor) within the edit box. ==Syntax== <syntaxhighlight lang="lua"> bool guiEditSetCaretIndex ( element th...)
 
(Replace to predefined variables.)
 
(3 intermediate revisions by 3 users not shown)
Line 6: Line 6:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiEditSetCaretIndex ( element theElement, int index )
bool guiEditSetCaretIndex ( element theElement, int index )
</syntaxhighlight>  
</syntaxhighlight>
{{OOP||[[Element/GUI/Edit_field|GuiEdit]]:setCaretIndex|caretIndex|guiEditGetCaretIndex}}


===Required Arguments===  
===Required Arguments===  
*'''theElement:''' The exit box to be changed.
*'''theElement:''' The edit box to be changed.
*'''index:''' An integer referring to the desired position within the box.
*'''index:''' An integer referring to the desired position within the box.


Line 25: Line 26:
end
end
end
end
addEventHandler ( "onClientGUIClick", getRootElement(), moveToEndOnClick )    -- add an event handler for clicks
addEventHandler ( "onClientGUIClick", root, moveToEndOnClick )    -- add an event handler for clicks
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
{{GUI_functions}}
{{GUI_functions}}
{{GUI_events}}

Latest revision as of 07:14, 17 May 2023

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

Syntax

bool guiEditSetCaretIndex ( element theElement, int index )

OOP Syntax Help! I don't understand this!

Method: GuiEdit:setCaretIndex(...)
Variable: .caretIndex
Counterpart: guiEditGetCaretIndex


Required Arguments

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

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", root, 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

Input

GUI


Retrieved from "https://wiki.multitheftauto.com/wiki/GuiEditSetCaretIndex?oldid=76817"