GuiEditSetCaratIndex: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Client function}} | {{Client function}} | ||
This function sets the current position of the | 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 | 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 | 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 | 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 | addEventHandler ( "onClientClick", getRootElement(), moveToEndOnClick ) -- add an event handler for clicks | ||
</syntaxhighlight> | </syntaxhighlight> | ||
==See Also== | ==See Also== | ||
{{GUI_functions}} | {{GUI_functions}} | ||
Revision as of 18:04, 18 August 2007
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 ) 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 ( "onClientClick", getRootElement(), moveToEndOnClick ) -- add an event handler for clicks
See Also
General functions
- guiBringToFront
- getChatboxLayout
- getChatboxCharacterLimit
- guiCreateFont
- guiBlur
- guiFocus
- guiGetAlpha
- guiGetCursorType
- guiGetEnabled
- guiGetFont
- guiGetInputEnabled
- guiGetInputMode
- guiGetPosition
- guiGetProperties
- guiGetProperty
- guiGetScreenSize
- guiGetSize
- guiGetText
- guiGetVisible
- guiMoveToBack
- guiSetAlpha
- guiSetEnabled
- guiSetFont
- guiSetInputEnabled
- guiSetInputMode
- guiSetPosition
- guiSetProperty
- guiSetSize
- guiSetText
- guiSetVisible
- isChatBoxInputActive
- isConsoleActive
- isDebugViewActive
- isMainMenuActive
- isMTAWindowActive
- isTransferBoxActive
- setChatboxCharacterLimit
- setDebugViewActive
Browsers
Buttons
Checkboxes
Comboboxes
- guiCreateComboBox
- guiComboBoxAddItem
- guiComboBoxClear
- guiComboBoxGetItemCount
- guiComboBoxGetItemText
- guiComboBoxGetSelected
- guiComboBoxIsOpen
- guiComboBoxRemoveItem
- guiComboBoxSetItemText
- guiComboBoxSetOpen
- guiComboBoxSetSelected
Edit Boxes
- guiCreateEdit
- guiEditGetCaretIndex
- guiEditGetMaxLength
- guiEditIsMasked
- guiEditIsReadOnly
- guiEditSetCaretIndex
- guiEditSetMasked
- guiEditSetMaxLength
- guiEditSetReadOnly
Gridlists
- guiCreateGridList
- guiGridListAddColumn
- guiGridListAddRow
- guiGridListAutoSizeColumn
- guiGridListClear
- guiGridListGetColumnCount
- guiGridListGetColumnTitle
- guiGridListGetColumnWidth
- guiGridListGetHorizontalScrollPosition
- guiGridListGetItemColor
- guiGridListGetItemData
- guiGridListGetItemText
- guiGridListGetRowCount
- guiGridListGetSelectedCount
- guiGridListGetSelectedItem
- guiGridListGetSelectedItems
- guiGridListGetSelectionMode
- guiGridListIsSortingEnabled
- guiGridListGetVerticalScrollPosition
- guiGridListInsertRowAfter
- guiGridListRemoveColumn
- guiGridListRemoveRow
- guiGridListSetColumnTitle
- guiGridListSetColumnWidth
- guiGridListSetHorizontalScrollPosition
- guiGridListSetItemColor
- guiGridListSetItemData
- guiGridListSetItemText
- guiGridListSetScrollBars
- guiGridListSetSelectedItem
- guiGridListSetSelectionMode
- guiGridListSetSortingEnabled
- guiGridListSetVerticalScrollPosition
Memos
- guiCreateMemo
- guiMemoGetCaretIndex
- guiMemoGetVerticalScrollPosition
- guiMemoSetVerticalScrollPosition
- guiMemoIsReadOnly
- guiMemoSetCaretIndex
- guiMemoSetReadOnly
Progressbars
Radio Buttons
Scrollbars
Scrollpanes
- guiCreateScrollPane
- guiScrollPaneGetHorizontalScrollPosition
- guiScrollPaneGetVerticalScrollPosition
- guiScrollPaneSetHorizontalScrollPosition
- guiScrollPaneSetScrollBars
- guiScrollPaneSetVerticalScrollPosition
Static Images
Tab Panels
Tabs
Text Labels
- guiCreateLabel
- guiLabelGetColor
- guiLabelGetFontHeight
- guiLabelGetTextExtent
- guiLabelSetColor
- guiLabelSetHorizontalAlign
- guiLabelSetVerticalAlign