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

FX::FXTextField Class Reference

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

#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_CURSOR_WORD_LEFT,
  ID_CURSOR_WORD_RIGHT,
  ID_CURSOR_SHIFT_HOME,
  ID_CURSOR_SHIFT_END,
  ID_CURSOR_SHIFT_LEFT,
  ID_CURSOR_SHIFT_RIGHT,
  ID_CURSOR_SHIFT_WORD_LEFT,
  ID_CURSOR_SHIFT_WORD_RIGHT,
  ID_SELECT_ALL,
  ID_DESELECT_ALL,
  ID_CUT_SEL,
  ID_COPY_SEL,
  ID_DELETE_SEL,
  ID_REPLACE_SEL,
  ID_PASTE_SEL,
  ID_PASTE_MIDDLE,
  ID_INSERT_STRING,
  ID_BACKSPACE,
  ID_BACKSPACE_WORD,
  ID_BACKSPACE_BOL,
  ID_DELETE,
  ID_DELETE_WORD,
  ID_DELETE_EOL,
  ID_DELETE_ALL,
  ID_TOGGLE_EDITABLE,
  ID_TOGGLE_OVERSTRIKE,
  ID_BLINK,
  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 FXbool canFocus () const
virtual void setFocus ()
virtual void killFocus ()
void setNumColumns (FXint cols)
FXint getNumColumns () const
FXString getText () const
FXString getSelectedText () const
void setText (const FXString &text, FXbool notify=false)
void replaceText (FXint pos, FXint m, const FXString &text, FXbool notify=false)
void appendText (const FXString &text, FXbool notify=false)
void insertText (FXint pos, const FXString &text, FXbool notify=false)
void removeText (FXint pos, FXint m, FXbool notify=false)
FXbool selectAll ()
FXbool setSelection (FXint pos, FXint len)
FXbool extendSelection (FXint pos)
FXbool copySelection ()
FXbool cutSelection (FXbool notify=false)
FXbool deleteSelection (FXbool notify=false)
FXbool replaceSelection (const FXString &text, FXbool notify=false)
FXbool pasteSelection (FXbool notify=false)
FXbool pasteClipboard (FXbool notify=false)
FXbool killSelection ()
FXbool isPosSelected (FXint pos) const
FXbool isPosVisible (FXint pos) const
void makePositionVisible (FXint pos)
void setCursorPos (FXint pos)
FXint getCursorPos () const
void setAnchorPos (FXint pos)
FXint getAnchorPos () const
void setEditable (FXbool edit=true)
FXbool isEditable () const
void setOverstrike (FXbool over=true)
FXbool isOverstrike () const
void setJustify (FXuint mode)
FXuint getJustify () const
void setDelimiters (const FXchar *delims=textDelimiters)
const FXchargetDelimiters () const
void setTextStyle (FXuint style)
FXuint getTextStyle () 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 setHelpText (const FXString &text)
const FXStringgetHelpText () const
void setTipText (const FXString &text)
const FXStringgetTipText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXTextField ()

Static Public Attributes

static const FXchar textDelimiters []


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_SHIFT_HOME 
ID_CURSOR_SHIFT_END 
ID_CURSOR_SHIFT_LEFT 
ID_CURSOR_SHIFT_RIGHT 
ID_CURSOR_SHIFT_WORD_LEFT 
ID_CURSOR_SHIFT_WORD_RIGHT 
ID_SELECT_ALL 
ID_DESELECT_ALL 
ID_CUT_SEL 
ID_COPY_SEL 
ID_DELETE_SEL 
ID_REPLACE_SEL 
ID_PASTE_SEL 
ID_PASTE_MIDDLE 
ID_INSERT_STRING 
ID_BACKSPACE 
ID_BACKSPACE_WORD 
ID_BACKSPACE_BOL 
ID_DELETE 
ID_DELETE_WORD 
ID_DELETE_EOL 
ID_DELETE_ALL 
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 FXbool 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::setNumColumns ( FXint  cols  ) 

Change the default width in terms of visible columns.

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

Return number of visible columns.

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

Get entire text.

FXString FX::FXTextField::getSelectedText (  )  const

Get selected text.

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

Change the text and move cursor to end.

void FX::FXTextField::replaceText ( FXint  pos,
FXint  m,
const FXString text,
FXbool  notify = false 
)

Replace range of bytes with text.

void FX::FXTextField::appendText ( const FXString text,
FXbool  notify = false 
)

Append text at the end.

void FX::FXTextField::insertText ( FXint  pos,
const FXString text,
FXbool  notify = false 
)

Insert text at position.

void FX::FXTextField::removeText ( FXint  pos,
FXint  m,
FXbool  notify = false 
)

Remove range of text.

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::copySelection (  ) 

Copy primary selection to clipboard.

FXbool FX::FXTextField::cutSelection ( FXbool  notify = false  ) 

Cut primary selection to clipboard.

FXbool FX::FXTextField::deleteSelection ( FXbool  notify = false  ) 

Delete primary selection.

FXbool FX::FXTextField::replaceSelection ( const FXString text,
FXbool  notify = false 
)

Replace primary selection by other text.

FXbool FX::FXTextField::pasteSelection ( FXbool  notify = false  ) 

Paste primary selection.

FXbool FX::FXTextField::pasteClipboard ( FXbool  notify = false  ) 

Paste clipboard.

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.

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::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::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::setTextStyle ( FXuint  style  ) 

Change text style.

FXuint FX::FXTextField::getTextStyle (  )  const

Return text style.

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::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.

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

Default text delimiters.

Copyright © 1997-2009 Jeroen van der Zijp