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 List of all members.

Public Types

enum  {
  ID_CURSOR_HOME = FXFrame::ID_LAST,
  ID_CURSOR_END,
  ID_CURSOR_RIGHT,
  ID_CURSOR_LEFT,
  ID_MARK,
  ID_EXTEND,
  ID_SELECT_ALL,
  ID_DESELECT_ALL,
  ID_CUT_SEL,
  ID_COPY_SEL,
  ID_PASTE_SEL,
  ID_DELETE_SEL,
  ID_OVERST_STRING,
  ID_INSERT_STRING,
  ID_BACKSPACE,
  ID_DELETE,
  ID_TOGGLE_EDITABLE,
  ID_TOGGLE_OVERSTRIKE,
  ID_BLINK,
  ID_LAST
}

Public Methods

 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 void create ()
 Create server-side resources.

virtual void enable ()
 Enable text field.

virtual void disable ()
 Disable text field.

virtual FXint getDefaultWidth ()
 Return default width.

virtual FXint getDefaultHeight ()
 Return default height.

virtual FXbool canFocus () const
 Yes, text field may receive focus.

virtual void setFocus ()
 Move the focus to this window.

virtual void killFocus ()
 Remove the focus from this window.

FXbool isEditable () const
 Return TRUE if text field may be edited.

void setEditable (FXbool edit=TRUE)
 Change text field editability.

void setCursorPos (FXint pos)
 Set cursor position.

FXint getCursorPos () const
 Return cursor position.

void setAnchorPos (FXint pos)
 Change anchor position.

FXint getAnchorPos () const
 Return anchor position.

void setText (const FXString &text)
 Set the text for this label.

FXString getText () const
 Get the text for this label.

void setFont (FXFont *fnt)
 Set the text font.

FXFontgetFont () const
 Get the text font.

void setTextColor (FXColor clr)
 Change text color.

FXColor getTextColor () const
 Return text color.

void setSelBackColor (FXColor clr)
 Change selected background color.

FXColor getSelBackColor () const
 Return selected background color.

void setSelTextColor (FXColor clr)
 Change selected text color.

FXColor getSelTextColor () const
 Return selected text color.

void setNumColumns (FXint cols)
 Change width of text field in terms of number of columns * `m'.

FXint getNumColumns () const
 Return number of columns.

void setJustify (FXuint mode)
 Change text justification mode.

FXuint getJustify () const
 Return text justification mode.

void setHelpText (const FXString &text)
 Set the status line help text for this label.

const FXStringgetHelpText () const
 Get the status line help text for this label.

void setTipText (const FXString &text)
 Set the tool tip message for this text field.

const FXStringgetTipText () const
 Get the tool tip message for this text field.

void setTextStyle (FXuint style)
 Change text style.

FXuint getTextStyle () const
 Return text style.

FXbool selectAll ()
 Select all text.

FXbool setSelection (FXint pos, FXint len)
 Select len characters starting at given position pos.

FXbool extendSelection (FXint pos)
 Extend the selection from the anchor to the given position.

FXbool killSelection ()
 Unselect the text.

FXbool isPosSelected (FXint pos) const
 Return TRUE if position pos is selected.

FXbool isPosVisible (FXint pos) const
 Return TRUE if position is fully visible.

void makePositionVisible (FXint pos)
 Scroll text to make the given position visible.

virtual void save (FXStream &store) const
 Save text field to a stream.

virtual void load (FXStream &store)
 Load text field from a stream.

virtual ~FXTextField ()
 Destructor.


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.

See also: