Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members

FX::FXTextField Class Reference

#include <FXTextField.h>

Inheritance diagram for FX::FXTextField:
FX::FXFrame FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

Public Types

enum  {
  ID_CURSOR_HOME =FXFrame::ID_LAST,
  ID_CURSOR_END,
  ID_CURSOR_RIGHT,
  ID_CURSOR_LEFT,
  ID_CURSOR_WORD_LEFT,
  ID_CURSOR_WORD_RIGHT,
  ID_CURSOR_WORD_START,
  ID_CURSOR_WORD_END,
  ID_MARK,
  ID_EXTEND,
  ID_SELECT_ALL,
  ID_DESELECT_ALL,
  ID_CUT_SEL,
  ID_COPY_SEL,
  ID_PASTE_SEL,
  ID_PASTE_MIDDLE,
  ID_DELETE_SEL,
  ID_DELETE_ALL,
  ID_OVERST_STRING,
  ID_INSERT_STRING,
  ID_BACKSPACE,
  ID_DELETE,
  ID_TOGGLE_EDITABLE,
  ID_TOGGLE_OVERSTRIKE,
  ID_BLINK,
  ID_LAST
}
 
- Public Types inherited from FX::FXWindow
enum  {
  ID_NONE,
  ID_HIDE,
  ID_SHOW,
  ID_TOGGLESHOWN,
  ID_LOWER,
  ID_RAISE,
  ID_DELETE,
  ID_DISABLE,
  ID_ENABLE,
  ID_TOGGLEENABLED,
  ID_UNCHECK,
  ID_CHECK,
  ID_UNKNOWN,
  ID_UPDATE,
  ID_AUTOSCROLL,
  ID_TIPTIMER,
  ID_HSCROLLED,
  ID_VSCROLLED,
  ID_SETVALUE,
  ID_SETINTVALUE,
  ID_SETREALVALUE,
  ID_SETSTRINGVALUE,
  ID_SETICONVALUE,
  ID_SETINTRANGE,
  ID_SETREALRANGE,
  ID_GETINTVALUE,
  ID_GETREALVALUE,
  ID_GETSTRINGVALUE,
  ID_GETICONVALUE,
  ID_GETINTRANGE,
  ID_GETREALRANGE,
  ID_SETHELPSTRING,
  ID_GETHELPSTRING,
  ID_SETTIPSTRING,
  ID_GETTIPSTRING,
  ID_QUERY_MENU,
  ID_HOTKEY,
  ID_ACCEL,
  ID_UNPOST,
  ID_POST,
  ID_MDI_TILEHORIZONTAL,
  ID_MDI_TILEVERTICAL,
  ID_MDI_CASCADE,
  ID_MDI_MAXIMIZE,
  ID_MDI_MINIMIZE,
  ID_MDI_RESTORE,
  ID_MDI_CLOSE,
  ID_MDI_WINDOW,
  ID_MDI_MENUWINDOW,
  ID_MDI_MENUMINIMIZE,
  ID_MDI_MENURESTORE,
  ID_MDI_MENUCLOSE,
  ID_MDI_NEXT,
  ID_MDI_PREV,
  ID_LAST
}
 

Public Member Functions

 FXTextField (FXComposite *p, FXint ncols, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=TEXTFIELD_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)
 
virtual void create ()
 
virtual void layout ()
 
virtual void enable ()
 
virtual void disable ()
 
virtual FXint getDefaultWidth ()
 
virtual FXint getDefaultHeight ()
 
virtual bool canFocus () const
 
virtual void setFocus ()
 
virtual void killFocus ()
 
void setEditable (FXbool edit=TRUE)
 
FXbool isEditable () const
 
void setOverstrike (FXbool over=TRUE)
 
FXbool isOverstrike () const
 
void setCursorPos (FXint pos)
 
FXint getCursorPos () const
 
void setAnchorPos (FXint pos)
 
FXint getAnchorPos () const
 
void setText (const FXString &text, FXbool notify=FALSE)
 
FXString getText () const
 
void setFont (FXFont *fnt)
 
FXFontgetFont () const
 
void setTextColor (FXColor clr)
 
FXColor getTextColor () const
 
void setSelBackColor (FXColor clr)
 
FXColor getSelBackColor () const
 
void setSelTextColor (FXColor clr)
 
FXColor getSelTextColor () const
 
void setCursorColor (FXColor clr)
 
FXColor getCursorColor () const
 
void setNumColumns (FXint cols)
 
FXint getNumColumns () const
 
void setJustify (FXuint mode)
 
FXuint getJustify () const
 
void setDelimiters (const FXchar *delims=textDelimiters)
 
const FXchargetDelimiters () const
 
void setHelpText (const FXString &text)
 
const FXStringgetHelpText () const
 
void setTipText (const FXString &text)
 
const FXStringgetTipText () const
 
void setTextStyle (FXuint style)
 
FXuint getTextStyle () const
 
FXbool selectAll ()
 
FXbool setSelection (FXint pos, FXint len)
 
FXbool extendSelection (FXint pos)
 
FXbool killSelection ()
 
FXbool isPosSelected (FXint pos) const
 
FXbool isPosVisible (FXint pos) const
 
void makePositionVisible (FXint pos)
 
virtual void save (FXStream &store) const
 
virtual void load (FXStream &store)
 
virtual ~FXTextField ()
 
- Public Member Functions inherited from FX::FXFrame
 FXFrame (FXComposite *p, FXuint opts=FRAME_NORMAL, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=DEFAULT_PAD, FXint pr=DEFAULT_PAD, FXint pt=DEFAULT_PAD, FXint pb=DEFAULT_PAD)
 
void setFrameStyle (FXuint style)
 
FXuint getFrameStyle () const
 
FXint getBorderWidth () const
 
void setPadTop (FXint pt)
 
FXint getPadTop () const
 
void setPadBottom (FXint pb)
 
FXint getPadBottom () const
 
void setPadLeft (FXint pl)
 
FXint getPadLeft () const
 
void setPadRight (FXint pr)
 
FXint getPadRight () const
 
void setHiliteColor (FXColor clr)
 
FXColor getHiliteColor () const
 
void setShadowColor (FXColor clr)
 
FXColor getShadowColor () const
 
void setBorderColor (FXColor clr)
 
FXColor getBorderColor () const
 
void setBaseColor (FXColor clr)
 
FXColor getBaseColor () const
 
- Public Member Functions inherited from FX::FXWindow
 FXWindow (FXComposite *p, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0)
 
FXWindowgetParent () const
 
FXWindowgetOwner () const
 
FXWindowgetShell () const
 
FXWindowgetRoot () const
 
FXWindowgetNext () const
 
FXWindowgetPrev () const
 
FXWindowgetFirst () const
 
FXWindowgetLast () const
 
FXWindowgetFocus () const
 
void setKey (FXuint k)
 
FXuint getKey () const
 
void setTarget (FXObject *t)
 
FXObjectgetTarget () const
 
void setSelector (FXSelector sel)
 
FXSelector getSelector () const
 
FXint getX () const
 
FXint getY () const
 
virtual FXint getWidthForHeight (FXint givenheight)
 
virtual FXint getHeightForWidth (FXint givenwidth)
 
void setX (FXint x)
 
void setY (FXint y)
 
void setWidth (FXint w)
 
void setHeight (FXint h)
 
void setLayoutHints (FXuint lout)
 
FXuint getLayoutHints () const
 
FXAccelTablegetAccelTable () const
 
void setAccelTable (FXAccelTable *acceltable)
 
void addHotKey (FXHotKey code)
 
void remHotKey (FXHotKey code)
 
void setHelpTag (const FXString &text)
 
const FXStringgetHelpTag () const
 
bool isShell () const
 
bool isOwnerOf (const FXWindow *window) const
 
bool isChildOf (const FXWindow *window) const
 
bool containsChild (const FXWindow *child) const
 
FXWindowgetChildAt (FXint x, FXint y) const
 
FXint numChildren () const
 
FXint indexOfChild (const FXWindow *window) const
 
FXWindowchildAtIndex (FXint index) const
 
FXComposeContextgetComposeContext () const
 
void createComposeContext ()
 
void destroyComposeContext ()
 
void setDefaultCursor (FXCursor *cur)
 
FXCursorgetDefaultCursor () const
 
void setDragCursor (FXCursor *cur)
 
FXCursorgetDragCursor () const
 
FXint getCursorPosition (FXint &x, FXint &y, FXuint &buttons) const
 
FXint setCursorPosition (FXint x, FXint y)
 
bool isEnabled () const
 
bool isActive () const
 
bool hasFocus () const
 
bool inFocusChain () const
 
virtual void changeFocus (FXWindow *child)
 
virtual void setDefault (FXbool enable=TRUE)
 
bool isDefault () const
 
void setInitial (bool enable=true)
 
bool isInitial () const
 
virtual void attach (FXID w)
 
virtual void detach ()
 
virtual void destroy ()
 
virtual void setShape (const FXRegion &region)
 
virtual void setShape (FXBitmap *bitmap)
 
virtual void setShape (FXIcon *icon)
 
virtual void clearShape ()
 
virtual void raise ()
 
virtual void lower ()
 
virtual void move (FXint x, FXint y)
 
virtual void resize (FXint w, FXint h)
 
virtual void position (FXint x, FXint y, FXint w, FXint h)
 
virtual void recalc ()
 
void forceRefresh ()
 
virtual void reparent (FXWindow *father, FXWindow *other=NULL)
 
void scroll (FXint x, FXint y, FXint w, FXint h, FXint dx, FXint dy) const
 
void update (FXint x, FXint y, FXint w, FXint h) const
 
void update () const
 
void repaint (FXint x, FXint y, FXint w, FXint h) const
 
void repaint () const
 
void grab ()
 
void ungrab ()
 
bool grabbed () const
 
void grabKeyboard ()
 
void ungrabKeyboard ()
 
bool grabbedKeyboard () const
 
virtual void show ()
 
virtual void hide ()
 
bool shown () const
 
virtual bool isComposite () const
 
bool underCursor () const
 
bool hasSelection () const
 
bool acquireSelection (const FXDragType *types, FXuint numtypes)
 
bool releaseSelection ()
 
bool hasClipboard () const
 
bool acquireClipboard (const FXDragType *types, FXuint numtypes)
 
bool releaseClipboard ()
 
virtual void dropEnable ()
 
virtual void dropDisable ()
 
bool isDropEnabled () const
 
bool isDragging () const
 
bool beginDrag (const FXDragType *types, FXuint numtypes)
 
bool handleDrag (FXint x, FXint y, FXDragAction action=DRAG_COPY)
 
FXDragAction endDrag (bool drop=true)
 
bool isDropTarget () const
 
void setDragRectangle (FXint x, FXint y, FXint w, FXint h, bool wantupdates=true) const
 
void clearDragRectangle () const
 
void acceptDrop (FXDragAction action=DRAG_ACCEPT) const
 
FXDragAction didAccept () const
 
void dropFinished (FXDragAction action=DRAG_REJECT) const
 
bool inquireDNDTypes (FXDNDOrigin origin, FXDragType *&types, FXuint &numtypes) const
 
bool offeredDNDType (FXDNDOrigin origin, FXDragType type) const
 
FXDragAction inquireDNDAction () const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *data, FXuint size) const
 
bool setDNDData (FXDNDOrigin origin, FXDragType type, const FXString &string) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXuchar *&data, FXuint &size) const
 
bool getDNDData (FXDNDOrigin origin, FXDragType type, FXString &string) const
 
virtual bool contains (FXint parentx, FXint parenty) const
 
void translateCoordinatesFrom (FXint &tox, FXint &toy, const FXWindow *fromwindow, FXint fromx, FXint fromy) const
 
void translateCoordinatesTo (FXint &tox, FXint &toy, const FXWindow *towindow, FXint fromx, FXint fromy) const
 
virtual void setBackColor (FXColor clr)
 
FXColor getBackColor () const
 
virtual bool doesSaveUnder () const
 
virtual const FXchartr (const FXchar *message, const FXchar *hint=NULL) const
 
virtual ~FXWindow ()
 
- Public Member Functions inherited from FX::FXDrawable
FXint getWidth () const
 
FXint getHeight () const
 
FXVisualgetVisual () const
 
void setVisual (FXVisual *vis)
 
virtual ~FXDrawable ()
 
- Public Member Functions inherited from FX::FXId
FXAppgetApp () const
 
FXID id () const
 
void setUserData (void *ptr)
 
void * getUserData () const
 
virtual ~FXId ()
 
- Public Member Functions inherited from FX::FXObject
virtual long onDefault (FXObject *, FXSelector, void *)
 
const FXchargetClassName () const
 
bool isMemberOf (const FXMetaClass *metaclass) const
 
virtual long tryHandle (FXObject *sender, FXSelector sel, void *ptr)
 
virtual ~FXObject ()
 

Static Public Attributes

static const FXchar textDelimiters []
 
- Static Public Attributes inherited from FX::FXWindow
static FXDragType octetType
 
static FXDragType deleteType
 
static FXDragType textType
 
static FXDragType utf8Type
 
static FXDragType utf16Type
 
static FXDragType colorType
 
static FXDragType urilistType
 
static const FXDragType stringType
 
static const FXDragType imageType
 
static const FXchar octetTypeName []
 
static const FXchar deleteTypeName []
 
static const FXchar textTypeName []
 
static const FXchar colorTypeName []
 
static const FXchar urilistTypeName []
 
static const FXchar utf8TypeName []
 
static const FXchar utf16TypeName []
 

Additional Inherited Members

- Static Public Member Functions inherited from FX::FXWindow
static FXWindowcommonAncestor (FXWindow *a, FXWindow *b)
 
static bool before (const FXWindow *a, const FXWindow *b)
 
static bool after (const FXWindow *a, const FXWindow *b)
 

Detailed Description

A text field is a single-line text entry widget.

The text field widget supports clipboard for cut-and-paste operations. Text input may be constrained to a certain format; the built-in capabilities support integer and real number entry constraints; additional constraints on the input may be implemented by intercepting the SEL_VERIFY message; a custom handler should examine the tentative input string passed as type const FXchar* in the message data, and return a value of "0" if the new input is accepted. During text entry, the text field sends a SEL_CHANGED message to its target, with the message data set to the current text value of type const FXchar*. When the text is accepted by hitting ENTER, the SEL_COMMAND message is sent. The text field also sends SEL_COMMAND when the focus moves to another control. TEXTFIELD_ENTER_ONLY can be passed to suppress this feature. Typically, this flag is used in dialogs that close when ENTER is hit in a text field.

See also:

Member Enumeration Documentation

anonymous enum
Enumerator
ID_CURSOR_HOME 
ID_CURSOR_END 
ID_CURSOR_RIGHT 
ID_CURSOR_LEFT 
ID_CURSOR_WORD_LEFT 
ID_CURSOR_WORD_RIGHT 
ID_CURSOR_WORD_START 
ID_CURSOR_WORD_END 
ID_MARK 
ID_EXTEND 
ID_SELECT_ALL 
ID_DESELECT_ALL 
ID_CUT_SEL 
ID_COPY_SEL 
ID_PASTE_SEL 
ID_PASTE_MIDDLE 
ID_DELETE_SEL 
ID_DELETE_ALL 
ID_OVERST_STRING 
ID_INSERT_STRING 
ID_BACKSPACE 
ID_DELETE 
ID_TOGGLE_EDITABLE 
ID_TOGGLE_OVERSTRIKE 
ID_BLINK 
ID_LAST 

Constructor & Destructor Documentation

FX::FXTextField::FXTextField ( FXComposite p,
FXint  ncols,
FXObject tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = TEXTFIELD_NORMAL,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0,
FXint  pl = DEFAULT_PAD,
FXint  pr = DEFAULT_PAD,
FXint  pt = DEFAULT_PAD,
FXint  pb = DEFAULT_PAD 
)

Construct text field wide enough to display ncols columns.

virtual FX::FXTextField::~FXTextField ( )
virtual

Destructor.

Member Function Documentation

virtual void FX::FXTextField::create ( )
virtual

Create server-side resources.

Reimplemented from FX::FXWindow.

virtual void FX::FXTextField::layout ( )
virtual

Perform layout.

Reimplemented from FX::FXWindow.

virtual void FX::FXTextField::enable ( )
virtual

Enable text field.

Reimplemented from FX::FXWindow.

virtual void FX::FXTextField::disable ( )
virtual

Disable text field.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXTextField::getDefaultWidth ( )
virtual

Return default width.

Reimplemented from FX::FXFrame.

virtual FXint FX::FXTextField::getDefaultHeight ( )
virtual

Return default height.

Reimplemented from FX::FXFrame.

virtual bool FX::FXTextField::canFocus ( ) const
virtual

Yes, text field may receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXTextField::setFocus ( )
virtual

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXTextField::killFocus ( )
virtual

Remove the focus from this window.

Reimplemented from FX::FXWindow.

void FX::FXTextField::setEditable ( FXbool  edit = TRUE)

Set editable mode.

FXbool FX::FXTextField::isEditable ( ) const

Return TRUE if text field may be edited.

void FX::FXTextField::setOverstrike ( FXbool  over = TRUE)

Set overstrike mode.

FXbool FX::FXTextField::isOverstrike ( ) const

Return TRUE if overstrike mode in effect.

void FX::FXTextField::setCursorPos ( FXint  pos)

Set cursor position.

FXint FX::FXTextField::getCursorPos ( ) const
inline

Return cursor position.

void FX::FXTextField::setAnchorPos ( FXint  pos)

Change anchor position.

FXint FX::FXTextField::getAnchorPos ( ) const
inline

Return anchor position.

void FX::FXTextField::setText ( const FXString text,
FXbool  notify = FALSE 
)

Change the text and move cursor to end.

FXString FX::FXTextField::getText ( ) const
inline

Get the text for this label.

void FX::FXTextField::setFont ( FXFont fnt)

Set the text font.

FXFont* FX::FXTextField::getFont ( ) const
inline

Get the text font.

void FX::FXTextField::setTextColor ( FXColor  clr)

Change text color.

FXColor FX::FXTextField::getTextColor ( ) const
inline

Return text color.

void FX::FXTextField::setSelBackColor ( FXColor  clr)

Change selected background color.

FXColor FX::FXTextField::getSelBackColor ( ) const
inline

Return selected background color.

void FX::FXTextField::setSelTextColor ( FXColor  clr)

Change selected text color.

FXColor FX::FXTextField::getSelTextColor ( ) const
inline

Return selected text color.

void FX::FXTextField::setCursorColor ( FXColor  clr)

Changes the cursor color.

FXColor FX::FXTextField::getCursorColor ( ) const
inline

Return the cursor color.

void FX::FXTextField::setNumColumns ( FXint  cols)

Change the default width of the text field in terms of a number of columns times the width of the numeral '8'.

FXint FX::FXTextField::getNumColumns ( ) const
inline

Return number of columns.

void FX::FXTextField::setJustify ( FXuint  mode)

Change text justification mode.

The justify mode is a combination of horizontal justification (JUSTIFY_LEFT, JUSTIFY_RIGHT, or JUSTIFY_CENTER_X), and vertical justification (JUSTIFY_TOP, JUSTIFY_BOTTOM, JUSTIFY_CENTER_Y). Note that JUSTIFY_CENTER_X can not be set from the constructor since by default text fields are left-justified.

FXuint FX::FXTextField::getJustify ( ) const

Return text justification mode.

void FX::FXTextField::setDelimiters ( const FXchar delims = textDelimiters)
inline

Change word delimiters.

const FXchar* FX::FXTextField::getDelimiters ( ) const
inline

Return word delimiters.

void FX::FXTextField::setHelpText ( const FXString text)
inline

Set the status line help text for this label.

const FXString& FX::FXTextField::getHelpText ( ) const
inline

Get the status line help text for this label.

void FX::FXTextField::setTipText ( const FXString text)
inline

Set the tool tip message for this text field.

const FXString& FX::FXTextField::getTipText ( ) const
inline

Get the tool tip message for this text field.

void FX::FXTextField::setTextStyle ( FXuint  style)

Change text style.

FXuint FX::FXTextField::getTextStyle ( ) const

Return text style.

FXbool FX::FXTextField::selectAll ( )

Select all text.

FXbool FX::FXTextField::setSelection ( FXint  pos,
FXint  len 
)

Select len characters starting at given position pos.

FXbool FX::FXTextField::extendSelection ( FXint  pos)

Extend the selection from the anchor to the given position.

FXbool FX::FXTextField::killSelection ( )

Unselect the text.

FXbool FX::FXTextField::isPosSelected ( FXint  pos) const

Return TRUE if position pos is selected.

FXbool FX::FXTextField::isPosVisible ( FXint  pos) const

Return TRUE if position is fully visible.

void FX::FXTextField::makePositionVisible ( FXint  pos)

Scroll text to make the given position visible.

virtual void FX::FXTextField::save ( FXStream store) const
virtual

Save text field to a stream.

Reimplemented from FX::FXFrame.

virtual void FX::FXTextField::load ( FXStream store)
virtual

Load text field from a stream.

Reimplemented from FX::FXFrame.

Member Data Documentation

const FXchar FX::FXTextField::textDelimiters[]
static

Default text delimiters.

Copyright © 1997-2005 Jeroen van der Zijp