→ home
 
→ index of namespace ui
 
→ index of project tkui
 
→ index of module MTextField

Class MTextField.ui::TextField

Synopsis: 

  Base classes:
  Derived classes:
  Functions:
  Methods:
  Constants:
Function New
Signature
New(Stringtext)
Arguments
Stringtext–

 
→ top of page
Method anchorSelection
Signature
anchorSelection(intidx)
Arguments
intidx–

 
→ top of page
Method beginXFMTag
Signature
beginXFMTag(ui::AbstractXMLFormform,
  HashTableattributes 
  )  
 :int
Arguments
ui::AbstractXMLFormform–
HashTableattributes–
Returns
int–

 
→ top of page
Method blockMouseDrag
Signature
blockMouseDrag():int
Returns
int–

 
→ top of page
Method calcSizeX
Signature
calcSizeX():float
Returns
float–

 
→ top of page
Method calcSizeY
Signature
calcSizeY():float
Returns
float–

 
→ top of page
Method consumeAction
Signature
consumeAction(ui::Actionac)
 :int
Arguments
ui::Actionac–
Returns
int–

 
→ top of page
Method copySelection
Signature
copySelection()

 
→ top of page
Method cutSelection
Signature
cutSelection()

 
→ top of page
Method deleteChar
Signature
deleteChar()

 
→ top of page
Method deleteSelection
Signature
deleteSelection()

 
→ top of page
Method expandSelectionToEnd
Signature
expandSelectionToEnd()

 
→ top of page
Method expandSelectionToHome
Signature
expandSelectionToHome()

 
→ top of page
Method expandSelectionToNextChar
Signature
expandSelectionToNextChar()

 
→ top of page
Method expandSelectionToNextWord
Signature
expandSelectionToNextWord()

 
→ top of page
Method expandSelectionToPreviousChar
Signature
expandSelectionToPreviousChar()

 
→ top of page
Method expandSelectionToPreviousWord
Signature
expandSelectionToPreviousWord()

 
→ top of page
Method getDisplayedText
Signature
getDisplayedText():String
Returns
String–

 
→ top of page
Method getEnableRightAlign
Signature
getEnableRightAlign():int
Returns
int–

 
→ top of page
Method getFloatFraction
Interpret string as single float or float fraction (e.g. 1/3) and return float value
Signature
getFloatFraction():float
Returns
float–

 
→ top of page
Method getFloatValue
Signature
getFloatValue():float
Returns
float–

 
→ top of page
Method getFont
Signature
getFont():ui::Font
Returns
ui::Font–

 
→ top of page
Method getIntValue
Signature
getIntValue():int
Returns
int–

 
→ top of page
Method getMaxTextLength
Query the maximum text length (in chars)
Signature
getMaxTextLength():int
Returns
int–

 
→ top of page
Method getProvidedActionNames
Signature
getProvidedActionNames():StringArray
Returns
StringArray–

 
→ top of page
Method getSelectionEnd
Query the index of the last char in the current selection.
Signature
getSelectionEnd():int
Returns
int–
Description
Returns -1 if nothing has been selected.

 
→ top of page
Method getSelectionStart
Query the index of the first char in the current selection.
Signature
getSelectionStart():int
Returns
int–
Description
Returns -1 if nothing has been selected.

 
→ top of page
Method getText
Returns a copy of the current text value.
Signature
getText():String
Returns
String–

 
→ top of page
Method getTextReference
Return reference to text String.
Signature
getTextReference():String
Returns
String–
Description
Please notice that the reference is only valid until this TextField control is deleted.

 
→ top of page
Method getVisibleTextLength
Signature
getVisibleTextLength():int
Returns
int–

 
→ top of page
Method handleTextChanged
Signature
handleTextChanged()

 
→ top of page
Method handleTextEdited
Signature
handleTextEdited()

 
→ top of page
Method handleTextEntered
Signature
handleTextEntered()

 
→ top of page
Method handleTextUnchanged
Signature
handleTextUnchanged()

 
→ top of page
Method haveSelection
Signature
haveSelection():int
Returns
int–

 
→ top of page
Method initTextField
Signature
initTextField()

 
→ top of page
Method insertChar
Signature
insertChar(intc)
Arguments
intc–

 
→ top of page
Method isMouseFocusLocked
Signature
isMouseFocusLocked():int
Returns
int–

 
→ top of page
Method isTabCycleMember
Signature
isTabCycleMember():int
Returns
int–

 
→ top of page
Method killUntilEnd
Signature
killUntilEnd()

 
→ top of page
Method lazyInitFont
Signature
lazyInitFont()

 
→ top of page
Method lazyStartEditing
Signature
lazyStartEditing()

 
→ top of page
Method moveCursorEnd
Signature
moveCursorEnd()

 
→ top of page
Method moveCursorEndOfWord
Signature
moveCursorEndOfWord()

 
→ top of page
Method moveCursorHome
Signature
moveCursorHome()

 
→ top of page
Method moveCursorLeft
Signature
moveCursorLeft()

 
→ top of page
Method moveCursorPageLeft
Signature
moveCursorPageLeft()

 
→ top of page
Method moveCursorPageRight
Signature
moveCursorPageRight()

 
→ top of page
Method moveCursorRight
Signature
moveCursorRight()

 
→ top of page
Method moveCursorStartOfWord
Signature
moveCursorStartOfWord()

 
→ top of page
Method moveCursorTo
Signature
moveCursorTo(intindex)
Arguments
intindex–

 
→ top of page
Method onDraw
Signature
onDraw()

 
→ top of page
Method onKey
Signature
onKey(Keyk)
 :int
Arguments
Keyk–
Returns
int–

 
→ top of page
Method onKeyboardFocus
Signature
onKeyboardFocus()

 
→ top of page
Method onKeyboardFocusLost
Signature
onKeyboardFocusLost(intbQuiet)
Arguments
intbQuiet–

 
→ top of page
Method onLookAndFeelChanged
Signature
onLookAndFeelChanged()

 
→ top of page
Method onMouse
Signature
onMouse(ui::MouseEventev)
 :int
Arguments
ui::MouseEventev–
Returns
int–

 
→ top of page
Method onMouseClick
Signature
onMouseClick(ui::MouseEventev)
 :int
Arguments
ui::MouseEventev–
Returns
int–

 
→ top of page
Method onMouseDoubleClick
Signature
onMouseDoubleClick(ui::MouseEventev)
 :int
Arguments
ui::MouseEventev–
Returns
int–

 
→ top of page
Method onMouseEnter
Signature
onMouseEnter(ui::MouseEventev)
Arguments
ui::MouseEventev–

 
→ top of page
Method onMouseFocus
Signature
onMouseFocus()

 
→ top of page
Method onMouseHold
Signature
onMouseHold(ui::MouseEventev)
 :int
Arguments
ui::MouseEventev–
Returns
int–

 
→ top of page
Method onMouseLeave
Signature
onMouseLeave(ui::MouseEventev)
Arguments
ui::MouseEventev–

 
→ top of page
Method onMouseUnfocus
Signature
onMouseUnfocus()

 
→ top of page
Method onTabFocus
Signature
onTabFocus()

 
→ top of page
Method pasteMouseSelection
Signature
pasteMouseSelection()

 
→ top of page
Method pasteSelection
Signature
pasteSelection()

 
→ top of page
Method pasteString
Signature
pasteString(Strings)
Arguments
Strings–

 
→ top of page
Method restartCaretTimer
Signature
restartCaretTimer()

 
→ top of page
Method selectAll
Signature
selectAll()

 
→ top of page
Method selectNone
Signature
selectNone()

 
→ top of page
Method selectWord
Signature
selectWord():int
Returns
int–

 
→ top of page
Method setBackgroundColor
Signature
setBackgroundColor(intbgColor)
Arguments
intbgColor–

 
→ top of page
Method setBackgroundTint
Signature
setBackgroundTint(intbgColor)
Arguments
intbgColor–

 
→ top of page
Method setCharFilter
Set unicode character filter (or null to disable filtering)
Signature
setCharFilter(Objectfilter)
Arguments
Objectfilter–

 
→ top of page
Method setCursorAndSelectionStartByPixel
Signature
setCursorAndSelectionStartByPixel(floatmouseX)
Arguments
floatmouseX–

 
→ top of page
Method setCursorByPixel
Signature
setCursorByPixel(floatmouseX)
Arguments
floatmouseX–

 
→ top of page
Method setDefaultInnerPadding
Signature
setDefaultInnerPadding()

 
→ top of page
Method setEditable
Signature
setEditable(intbEditable)
Arguments
intbEditable–

 
→ top of page
Method setEnableRightAlign
Signature
setEnableRightAlign(intbRightAlign)
Arguments
intbRightAlign–

 
→ top of page
Method setFont
Signature
setFont(ui::Fontfont)
Arguments
ui::Fontfont–

 
→ top of page
Method setFontByName
Signature
setFontByName(StringfontName)
Arguments
StringfontName–

 
→ top of page
Method setForegroundColor
Signature
setForegroundColor(intfgColor)
Arguments
intfgColor–

 
→ top of page
Method setHexValue
Signature
setHexValue(intval)
Arguments
intval–

 
→ top of page
Method setInnerPadBottom
Signature
setInnerPadBottom(floatbottom)
Arguments
floatbottom–

 
→ top of page
Method setInnerPadding4f
Set the distance between borders and the actual text area
Signature
setInnerPadding4f(floattop,
  floatleft,
  floatbottom,
  floatright 
  )  
Arguments
floattop–
floatleft–
floatbottom–
floatright–

 
→ top of page
Method setInnerPadLeft
Signature
setInnerPadLeft(floatleft)
Arguments
floatleft–

 
→ top of page
Method setInnerPadRight
Signature
setInnerPadRight(floatright)
Arguments
floatright–

 
→ top of page
Method setInnerPadTop
Signature
setInnerPadTop(floattop)
Arguments
floattop–

 
→ top of page
Method setMaxTextLength
Set the maximum text length (in chars)
Signature
setMaxTextLength(intlength)
Arguments
intlength–

 
→ top of page
Method setSelection
Set the current selection.
Signature
setSelection(intstartIndex,
  intendIndex 
  )  
Arguments
intstartIndex–
intendIndex–
Description
The indices will be clipped to the available string length.

 
→ top of page
Method setSelectionEndByPixel
Signature
setSelectionEndByPixel(floatmouseX)
Arguments
floatmouseX–

 
→ top of page
Method setText
Set the current text value. This will create a copy of the given _text String.
Signature
setText(Stringtext)
Arguments
Stringtext–

 
→ top of page
Method setTextReference
Set text string by reference.
Signature
setTextReference(StringtextRef)
Arguments
StringtextRef–
Description
This should be used with care since the _textReference is only valid as long as the variable which owns it is valid. It is useful to directly link fields of arbitrary datastructures to TextFields.

 
→ top of page
Method setToolTipCaption
Signature
setToolTipCaption(Stringtext)
Arguments
Stringtext–

 
→ top of page
Method setVisibleTextLength
Signature
setVisibleTextLength(intlength)
Arguments
intlength–

 
→ top of page
Method startCaretTimer
Signature
startCaretTimer()

 
→ top of page
Method startEditing
Signature
startEditing()

 
→ top of page
Method stopEditing
Signature
stopEditing(intbProvideAction,
  intbReturnKey,
  intbQuiet 
  )  
Arguments
intbProvideAction–
intbReturnKey–
intbQuiet–

 
→ top of page
Method undo
Signature
undo()

 
→ top of page
Method updateInnerLayout
Signature
updateInnerLayout()

 
→ top of page
Method wantTriadKeyMode
Signature
wantTriadKeyMode():int
Returns
int–

 
→ top of page
Method wasEdited
Signature
wasEdited():int
Returns
int–

 
→ top of page
Constant ACTION_STARTEDITING (String)
Constant ACTION_STOPEDITING (String)
Constant ACTION_TEXTCHANGED (String)
Constant ACTION_TEXTEDITED (String)
Constant ACTION_TEXTENTERED (String)
Constant ACTION_TEXTUNCHANGED (String)
Constant DEFAULT_MAX_TEXT_LENGTH (int)
Constant DEFAULT_VISIBLE_TEXT_LENGTH (int)
Constant DELEGATE_ONMOUSERIGHTCLICK (String)
Constant DELEGATE_ONMOUSEWHEELDOWN (String)
Constant DELEGATE_ONMOUSEWHEELUP (String)
Constant MAX_SIZE_X (int)
Constant MIN_SIZE_X (int)
Constant MIN_SIZE_Y (int)
Constant MIN_WIDTH_FOR_PAGING (int)
Constant MOUSE_TO_CURSOR_H_CORRECT (int)
Constant NO_ANCHOR (int)
Constant PAGING_AMOUNT (int)

 
Project Modules:MAbstractXMLForm , MAcceleratorKey , MAcceleratorList , MAction , MActionConsumer , MActionProvider , MBezierEdit , MButton , MCharFilter , MCharFilterFloat , MCharFilterFloatExpr , MCharFilterHex , MCharFilterHexExpr , MCheckBox , MChoiceDialog , MColorBox , MColorButton , MComboBox , MComboBoxTM , MComposite , MControl , MCursorShapes , MDial , MDialog , MDynamicPopupMenuAction , MFBO , MFloatAction , MFloatField , MFloatingLayer , MFloatParam , MFloatParamEditor , MFont , MFontResource , MForm , MFT2Face , MFT2FontCache , MFT2Glyph , MGeometry4f , MHiddenPanel , MHSVColorPicker , MIcon , MIconCache , MInfoDialog , MIntAction , MKeyAction , MLabel , MLayer , MLayerSwitch , MLayout , MLookAndFeel , MLookAndFeel_DarkFawn , MLookAndFeel_Gray , MLookAndFeel_LightFawn , MLookAndFeel_LightGray , MMouseEvent , MOpaquePanel , MPanel , MPNGIcon , MPoint2f , MPopupMenu , MPopupMenuBar , MPopupMenuBarButton , MPopupMenuButton , MPopupMenuCheckButton , MPopupMenuFolderButton , MPopupMenuSeparator , MPopupMenuWindowDock , MRadioButton , MRadioButtonGroup , MRectangle2f , MRepeatButton , MScroller , MScrollPane , MSize2f , MSizeGroup , MSizeGroupX , MSizeGroupXY , MSizeGroupY , MSlider , MSpacer , MSplitPane , MStatusBar , MStringAction , MStringDialog , MSuperBorderLayout , MTabbedView , MTableCellEditor , MTableCellEditorCheckBox , MTableCellEditorComboBox , MTableCellEditorFloatParam , MTableModel , MTableView , MTableViewData , MTableViewHeader , MTabSwitch , MTextEdit , MTextEditDialog , MTextField , MTextFieldIncDec , MTextInputDialog , MTextView , MTimerAction , MTitledPanel , MToolTip , MTransparentPanel , MTreeTableModel , MTreeTableNode , MUI , MUIConstants , MUIPluginLoader , MUIRenderer , MValueAction , MVector2f , MView , MViewPane , MWindow , MWindowDock , MWindowTitleBar , MXFMObject , MXMLForm 
Project Classes:ColorBox , HSVColorPicker , ui::AbstractXMLForm , ui::AcceleratorKey , ui::AcceleratorList , ui::Action , ui::ActionConsumer , ui::ActionProvider , ui::BezierEdit , ui::BezierEditState , ui::BezierHistory , ui::BorderLayout , ui::Button , ui::CharFilter , ui::CharFilterFloat , ui::CharFilterFloatExpr , ui::CharFilterHex , ui::CharFilterHexExpr , ui::CheckBox , ui::ChoiceDialog , ui::ColorButton , ui::ComboBox , ui::ComboBoxPopup , ui::ComboBoxTM , ui::Composite , ui::Control , ui::CursorShapes , ui::Dial , ui::Dialog , ui::DynamicPopupMenuAction , ui::FBO , ui::FloatAction , ui::FloatField , ui::FloatingLayer , ui::FloatParam , ui::FloatParamEditor , ui::Font , ui::FontResource , ui::Form , ui::FT2Face , ui::FT2FontCache , ui::FT2FontResource , ui::FT2Glyph , ui::FT2LocalFileFontResource , ui::FT2PakFileFontResource , ui::Geometry4f , ui::HiddenPanel , ui::Icon , ui::IconCache , ui::InfoDialog , ui::IntAction , ui::KeyAction , ui::KeyRepeatAction , ui::KeyRepeatConsumer , ui::Label , ui::Layer , ui::LayerSwitch , ui::Layout , ui::LookAndFeel , ui::LookAndFeel_DarkFawn , ui::LookAndFeel_Gray , ui::LookAndFeel_LightFawn , ui::LookAndFeel_LightGray , ui::MouseEvent , ui::MouseHoldAction , ui::MouseHoldConsumer , ui::OpaquePanel , ui::Panel , ui::PNGIcon , ui::Point2f , ui::PopupMenu , ui::PopupMenuBar , ui::PopupMenuBarButton , ui::PopupMenuButton , ui::PopupMenuCheckButton , ui::PopupMenuFolderButton , ui::PopupMenuRadioButton , ui::PopupMenuSeparator , ui::PopupMenuWindowDock , ui::RadioButton , ui::RadioButtonGroup , ui::Rectangle2f , ui::RepeatButton , ui::Scroller , ui::ScrollPane , ui::Size2f , ui::SizeGroup , ui::SizeGroupX , ui::SizeGroupXY , ui::SizeGroupY , ui::Slider , ui::Spacer , ui::SplitPane , ui::StatusBar , ui::StatusBarListener , ui::StatusBarMessage , ui::StringAction , ui::StringDialog , ui::StringDialogTextField , ui::SuperBorderLayout , ui::TabbedView , ui::TableCellEditor , ui::TableCellEditorCheckBox , ui::TableCellEditorComboBox , ui::TableCellEditorFloatParam , ui::TableModel , ui::TableView , ui::TableViewData , ui::TableViewHeader , ui::TabSwitch , ui::TabSwitchLabelPanel , ui::TextEdit , ui::TextEditDialog , ui::TextField , ui::TextFieldIncDec , ui::TextInputDialog , ui::TextView , ui::TimerAction , ui::TitledPanel , ui::ToolTip , ui::TransparentPanel , ui::TreeTableModel , ui::TreeTableNode , ui::TriadKeyConsumer , ui::UI , ui::UIConstants , ui::UIRenderer , ui::ValueAction , ui::Vector2f , ui::View , ui::ViewPane , ui::Window , ui::WindowDock , ui::WindowTitleBar , ui::XFMObject , ui::XMLForm 
Project Functions:getTableViewStepSizeDec , getTableViewStepSizeInc , Screen_onApplicationActive , Screen_onClose , Screen_onDraw , Screen_onDropFiles , Screen_onExpose , Screen_onInputFocusActive , Screen_onKeyboard , Screen_onMouse , Screen_onMouseFocusActive , Screen_onOpen , Screen_onResize , Screen_onTimer 
All Namespaces:default , ui 
All Projects:core , debugtext , tkfreetype2 , tkmath , tkmidi , tkopengl , tkportaudio , tksdl , tkui , tkunit 

auto-generated by "DOG", the TkScript document generator. Mon, 28/Dec/2015 14:27:06