GuiEditGetCaretIndex: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{New feature/item|3.0135|1.3.5|6054| This function returns the caret (the text cursor) position within the editbox. }} ==Syntax== <syntaxhighlight lang="lua"> int guiEditGetCaretIndex ( elem...") |
(OOP syntax) |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Client function}} | |||
__NOTOC__ | |||
{{New feature/item|3.0135|1.3.5|6054| | {{New feature/item|3.0135|1.3.5|6054| | ||
This function returns the caret (the text cursor) position within the editbox. | This function returns the caret (the text cursor) position within the editbox. | ||
| Line 6: | Line 8: | ||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
int guiEditGetCaretIndex ( element theElement ) | int guiEditGetCaretIndex ( element theElement ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
{{OOP||[[Element/GUI/Edit_field|GuiEdit]]:getCaretIndex|caretIndex|guiEditSetCaretIndex}} | |||
===Required Arguments=== | ===Required Arguments=== | ||
| Line 15: | Line 18: | ||
==Example== | ==Example== | ||
<syntaxhighlight lang="lua"> | This example outputs the caret position of the edit field to the chat | ||
<syntaxhighlight lang="lua"> | |||
local edit = guiCreateEdit(0.4,0.4,0.3,0.1,"",true) | |||
addEventHandler("onClientGUIChanged",edit,function() | |||
outputChatBox("Caret index is: "..guiEditGetCaretIndex(edit)) -- output index to chat | |||
end) | |||
</syntaxhighlight> | |||
==See Also== | ==See Also== | ||
{{GUI_functions}} | {{GUI_functions}} | ||
{{GUI_events}} | |||
Latest revision as of 20:53, 7 November 2018
This function returns the caret (the text cursor) position within the editbox.
Syntax
int guiEditGetCaretIndex ( element theElement )
OOP Syntax Help! I don't understand this!
- Method: GuiEdit:getCaretIndex(...)
- Variable: .caretIndex
- Counterpart: guiEditSetCaretIndex
Required Arguments
- theElement: The edit box you want to get the caret position from
Returns
Returns the caret index on success, false otherwise.
Example
This example outputs the caret position of the edit field to the chat
local edit = guiCreateEdit(0.4,0.4,0.3,0.1,"",true)
addEventHandler("onClientGUIChanged",edit,function()
outputChatBox("Caret index is: "..guiEditGetCaretIndex(edit)) -- output index to chat
end)
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
Windows
Input
GUI
- onClientGUIAccepted
- onClientGUIBlur
- onClientGUIChanged
- onClientGUIClick
- onClientGUIComboBoxAccepted
- onClientGUIDoubleClick
- onClientGUIFocus
- onClientGUIMouseDown
- onClientGUIMouseUp
- onClientGUIMove
- onClientGUIScroll
- onClientGUISize
- onClientGUITabSwitched
- onClientMouseEnter
- onClientMouseLeave
- onClientMouseMove
- onClientMouseWheel