GuiEditSetCaratIndex - Revision history

AlexTMjugador: Changed "DeprecatedWithAlt" template to "Deprecated"

2015-02-13T16:27:56Z

Changed "DeprecatedWithAlt" template to "Deprecated"

← Older revision		Revision as of 16:27, 13 February 2015
Line 1:		Line 1:
	~~{{DeprecatedWithAlt\|guiEditSetCaretIndex\|}}~~
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
			{{Deprecated\|guiEditSetCaretIndex\|}}

	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 edit box.

Ccw at 01:37, 12 January 2014

2014-01-12T01:37:15Z

← Older revision		Revision as of 01:37, 12 January 2014
Line 1:		Line 1:
			{{DeprecatedWithAlt\|guiEditSetCaretIndex\|}}
	__NOTOC__		__NOTOC__
	~~{{deprecated}}~~
	{{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 edit box.

	~~{{New feature\|3\|1.0\|~~
	~~This function has been renamed. Please use [[guiEditSetCaretIndex]] for 1.0~~
	}}

	==Syntax==		==Syntax==

Talidan at 16:07, 30 January 2009

2009-01-30T16:07:34Z

← Older revision		Revision as of 16:07, 30 January 2009
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{deprecated}}
	{{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 edit box.

Talidan at 03:41, 1 January 2009

2009-01-01T03:41:34Z

← Older revision		Revision as of 03:41, 1 January 2009
Line 2:		Line 2:
	{{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 edit box.

			{{New feature\|3\|1.0\|
			This function has been renamed. Please use [[guiEditSetCaretIndex]] for 1.0
			}}

	==Syntax==		==Syntax==

Talidan at 01:07, 3 November 2007

2007-11-03T01:07:56Z

← Older revision		Revision as of 01:07, 3 November 2007
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function moveToEndOnClick()		function moveToEndOnClick()
	if ( getKeyState ( "lctrl" ) == true ) and ( ~~guiGetType~~(source) == "edit" ) then -- if the user is holding down left control		if ( getKeyState ( "lctrl" ) == true ) and ( getElementType(source) == "gui-edit" ) then -- if the user is holding down left control
	local text = guiGetText ( source )		local text = guiGetText ( source )
	local textLength = string.len ( text )		local textLength = string.len ( text )

Talidan at 12:32, 22 October 2007

2007-10-22T12:32:32Z

← Older revision		Revision as of 12:32, 22 October 2007
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function moveToEndOnClick()		function moveToEndOnClick()
	if ( getKeyState ( "lctrl" ) == true ) then -- if the user is holding down left control		if ( getKeyState ( "lctrl" ) == true ) and ( guiGetType(source) == "edit" ) then -- if the user is holding down left control
	local text = guiGetText ( source )		local text = guiGetText ( source )
	local textLength = string.len ( text )		local textLength = string.len ( text )

Talidan at 12:05, 22 October 2007

2007-10-22T12:05:30Z

← Older revision		Revision as of 12:05, 22 October 2007
Line 25:		Line 25:
	end		end
	end		end
	addEventHandler ( "~~onClientClick~~", getRootElement(), moveToEndOnClick ) -- add an event handler for clicks		addEventHandler ( "onClientGUIClick", getRootElement(), moveToEndOnClick ) -- add an event handler for clicks
	</syntaxhighlight>		</syntaxhighlight>

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

Arc at 18:04, 18 August 2007

2007-08-18T18:04:39Z

← Older revision		Revision as of 18:04, 18 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	{{Client function}}		{{Client function}}
	This function sets the current position of the ~~carat~~ (the text cursor) within the edit box.		This function sets the current position of the caret (the text cursor) within the edit box.

	==Syntax==		==Syntax==
Line 13:		Line 13:

	===Returns===		===Returns===
	Returns ''true'' if the index was ~~successful~~ set, ''false'' otherwise.		Returns ''true'' if the index was successfully set, ''false'' otherwise.

	==Example==		==Example==
Line 19:		Line 19:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function moveToEndOnClick()		function moveToEndOnClick()
	if ( getKeyState ( "lctrl" ) == true ) then --if ~~he's~~ holding down left control		if ( getKeyState ( "lctrl" ) == true ) then -- if the user is holding down left control
	local text = guiGetText ( source )		local text = guiGetText ( source )
	local textLength = string.len ( text )		local textLength = string.len ( text )
	guiEditSetCaratIndex ( source, textLength )--set the ~~carat~~ index. ~~The~~ function ~~wont~~ work anyway ~~for other types of elements so no check is required.~~		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
	end		end
	addEventHandler ( "onClientClick", getRootElement(), moveToEndOnClick )--add an event handler for ~~this~~		addEventHandler ( "onClientClick", getRootElement(), moveToEndOnClick ) -- add an event handler for clicks
	</syntaxhighlight>		</syntaxhighlight>

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

Talidan at 15:00, 11 August 2007

2007-08-11T15:00:16Z

← Older revision		Revision as of 15:00, 11 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
			{{Client function}}
	This function sets the current position of the carat (the text cursor) within the edit box.		This function sets the current position of the carat (the text cursor) within the edit box.

Talidan at 14:51, 11 August 2007

2007-08-11T14:51:33Z

← Older revision		Revision as of 14:51, 11 August 2007
Line 1:		Line 1:
	__NOTOC__		__NOTOC__
	~~<!-- Describe in plain english what this function does. Don't go into details, just give an overview -->~~
	This function sets the current position of the carat (the text cursor) within the edit box.		This function sets the current position of the carat (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 8:

	===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 successful 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 ) then --if he's holding down left control
	--~~This line does~~ this~~...~~		local text = guiGetText ( source )
	~~mooo~~		local textLength = string.len ( text )
			guiEditSetCaratIndex ( source, textLength )--set the carat index. The function wont work anyway for other types of elements so no check is required.
			end
			end
			addEventHandler ( "onClientClick", getRootElement(), moveToEndOnClick )--add an event handler for this
	</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]]~~