iWidgetEditBox Struct Reference

Inheritance diagram for iWidgetEditBox:

Detailed Description

Simple editbox widget interface.

Public Member Functions
virtual void	AddText (const achar *aaszText)=0
	Add the specified text at the end of the edit box. More...
virtual void	SetReplaceChar (tU32 anChar)=0
	Set the replacement character for all text displayed. More...
virtual tU32	GetReplaceChar () const =0
	Get the replacement character for all text displayed. {Property}. More...
virtual void	MoveCursorHome (tBool abLine)=0
	Move the cursor to the begining of the line or the text. More...
virtual void	MoveCursorEnd (tBool abLine)=0
	Move the cursor at the end of the line or the text. More...
virtual void	MoveCursor (const sVec2i &pos, tBool abForceLogicalCol)=0
	Move the cursor to the specified position (line,column) More...
virtual void	MoveCursorLineDelta (tI32 line)=0
	Move the current cursor line. More...
virtual void	MoveCursorColumnDelta (tI32 line)=0
	Move the current cursor column. More...
virtual sVec2i	GetCursorPosition () const =0
	Get the cursor's position. {Property}. More...
virtual tU32	GetCursorLine () const =0
	Get the cursor's current line. {Property}. More...
virtual tU32	GetCursorColumn () const =0
	Get the cursor's current column. {Property}. More...
virtual void	AutoScroll ()=0
	Scroll to the current cursor position. More...
virtual cString	GetTextInRange (const sVec4i &aRange) const =0
	Get the text in the specified range, Vec4(startLine,startCol,endLine,endCol). More...
virtual sVec4i	GetAllTextRange () const =0
	Get the text range which includes the whole text. {Property}. More...
virtual void	SetSelection (const sVec4i &aSelection)=0
	Set the selection to the specified range, Vec4(startLine,startCol,endLine,endCol) {Property}. More...
virtual sVec4i	GetSelection () const =0
	Get the current selection range, Vec4(startLine,startCol,endLine,endCol). {Property}. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Member Function Documentation

virtual void AddText ( const achar *  aaszText )

pure virtual

Add the specified text at the end of the edit box.

virtual void SetReplaceChar ( tU32  anChar )

pure virtual

Set the replacement character for all text displayed.

Remarks

0 will disable the feature {Property}

virtual tU32 GetReplaceChar ( ) const

pure virtual

Get the replacement character for all text displayed. {Property}.

virtual void MoveCursorHome ( tBool  abLine )

pure virtual

Move the cursor to the begining of the line or the text.

virtual void MoveCursorEnd ( tBool  abLine )

pure virtual

Move the cursor at the end of the line or the text.

virtual void MoveCursor ( const sVec2i &  pos, tBool  abForceLogicalCol  )

pure virtual

Move the cursor to the specified position (line,column)

virtual void MoveCursorLineDelta ( tI32  line )

pure virtual

Move the current cursor line.

virtual void MoveCursorColumnDelta ( tI32  line )

pure virtual

Move the current cursor column.

virtual sVec2i GetCursorPosition ( ) const

pure virtual

Get the cursor's position. {Property}.

Remarks

Vec2(line,column)

virtual tU32 GetCursorLine ( ) const

pure virtual

Get the cursor's current line. {Property}.

virtual tU32 GetCursorColumn ( ) const

pure virtual

Get the cursor's current column. {Property}.

virtual void AutoScroll ( )

pure virtual

Scroll to the current cursor position.

virtual cString GetTextInRange ( const sVec4i &  aRange ) const

pure virtual

Get the text in the specified range, Vec4(startLine,startCol,endLine,endCol).

virtual sVec4i GetAllTextRange ( ) const

pure virtual

Get the text range which includes the whole text. {Property}.

virtual void SetSelection ( const sVec4i &  aSelection )

pure virtual

Set the selection to the specified range, Vec4(startLine,startCol,endLine,endCol) {Property}.

virtual sVec4i GetSelection ( ) const

pure virtual

Get the current selection range, Vec4(startLine,startCol,endLine,endCol). {Property}.