GuiEditSetCaratIndex: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
No edit summary
 
m (Changed "DeprecatedWithAlt" template to "Deprecated")
 
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
__NOTOC__  
__NOTOC__  
<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->
{{Client function}}
This function sets the current position of the carat (the text cursor) within the edit box.
{{Deprecated|guiEditSetCaretIndex|}}
 
This function sets the current position of the caret (the text cursor) within the edit box.


==Syntax==  
==Syntax==  
<!-- NOTE: don't use 'special' names for variable names, e.g. you shouldn't be writing things like 'player player, vehicle vehicle', instead write something like 'player thePlayer, vehicle vehicleToGetInto'. This is less confusing and prevents the syntax highlighting being odd -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
bool guiEditSetCaratIndex ( element theElement, int index )
bool guiEditSetCaratIndex ( element theElement, int index )
Line 10: Line 11:


===Required Arguments===  
===Required Arguments===  
<!-- List each argument one per line. This should be the argument's name as in the argument list above, NOT the argument's data type -->
*'''theElement:''' The exit box to be changed.
*'''theElement:''' The exit 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.


===Returns===
===Returns===
<!-- Make this descriptive. Explain what cases will return false. If you're unsure, add a tag to it so we can check -->
Returns ''true'' if the index was successfully set, ''false'' otherwise.
Returns ''true'' if the function is successful, ''false'' otherwise.


==Example==  
==Example==
<!-- Explain what the example is in a single sentance -->
This example makes the text cursor jump to the end of an edit box if the user is holding the Left Control button.
This example does...
<!-- Add the code below, an emphasis should be on making it clear, not optimized. You could provide two versions if you wish, one clear and well commented, the other optimized -->
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
--This line does...
function moveToEndOnClick()
blabhalbalhb --abababa
if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then          -- if the user is holding down left control
--This line does this...
local text = guiGetText ( source )
mooo
local textLength = string.len ( text )
guiEditSetCaratIndex ( 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
</syntaxhighlight>
</syntaxhighlight>


==See Also==
==See Also==
<!-- Change FunctionArea to the area that this function is in on the main function list page, e.g. Server, Player, Vehicle etc -->
{{GUI_functions}}
{{GUI_functions}}
[[Category:Incomplete]]

Latest revision as of 16:27, 13 February 2015

Emblem-important.png This function is deprecated. This means that its use is discouraged and that it might not exist in future versions.
Please use guiEditSetCaretIndex instead.


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

Syntax

bool guiEditSetCaratIndex ( element theElement, int index )

Required Arguments

  • theElement: The exit 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 )
		guiEditSetCaratIndex ( 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/GuiEditSetCaratIndex?oldid=44593"