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

FX::FXText

FX::FXText Class Reference

The text widget supports editing of multiple lines of text. More...

#include <FXText.h>

Inheritance diagram for FX::FXText:

FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject List of all members.

Public Types

enum  {
  STYLE_UNDERLINE = 0x0001,
  STYLE_STRIKEOUT = 0x0002,
  STYLE_BOLD = 0x0004
}

Public Member Functions

 FXText (FXComposite *p, FXObject *tgt=NULL, FXSelector sel=0, FXuint opts=0, FXint x=0, FXint y=0, FXint w=0, FXint h=0, FXint pl=3, FXint pr=3, FXint pt=2, FXint pb=2)
virtual void create ()
virtual void detach ()
virtual void layout ()
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual void enable ()
virtual void disable ()
virtual void recalc ()
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()
virtual bool canFocus () const
virtual void setFocus ()
virtual void killFocus ()
void setMarginTop (FXint pt)
FXint getMarginTop () const
void setMarginBottom (FXint pb)
FXint getMarginBottom () const
void setMarginLeft (FXint pl)
FXint getMarginLeft () const
void setMarginRight (FXint pr)
FXint getMarginRight () const
FXint getWrapColumns () const
void setWrapColumns (FXint cols)
FXint getTabColumns () const
void setTabColumns (FXint cols)
FXint getBarColumns () const
void setBarColumns (FXint cols)
FXbool isModified () const
void setModified (FXbool mod=TRUE)
void setEditable (FXbool edit=TRUE)
FXbool isEditable () const
void setOverstrike (FXbool over=TRUE)
FXbool isOverstrike () const
void setStyled (FXbool styled=TRUE)
FXbool isStyled () const
void setDelimiters (const FXchar *delims=textDelimiters)
const FXchar * getDelimiters () const
void setFont (FXFont *fnt)
FXFont * getFont () const
void setTextColor (FXColor clr)
FXColor getTextColor () const
void setSelBackColor (FXColor clr)
FXColor getSelBackColor () const
void setSelTextColor (FXColor clr)
FXColor getSelTextColor () const
void setHiliteTextColor (FXColor clr)
FXColor getHiliteTextColor () const
void setHiliteBackColor (FXColor clr)
FXColor getHiliteBackColor () const
void setActiveBackColor (FXColor clr)
FXColor getActiveBackColor () const
void setCursorColor (FXColor clr)
FXColor getCursorColor () const
void setNumberColor (FXColor clr)
FXColor getNumberColor () const
void setBarColor (FXColor clr)
FXColor getBarColor () const
void setHelpText (const FXString &text)
FXString getHelpText () const
void setTipText (const FXString &text)
FXString getTipText () const
FXint getByte (FXint pos) const
FXwchar getChar (FXint pos) const
FXint getCharLen (FXint pos) const
FXint getStyle (FXint pos) const
void extractText (FXchar *text, FXint pos, FXint n) const
void extractText (FXString &text, FXint pos, FXint n) const
void extractStyle (FXString &text, FXint pos, FXint n) const
void extractStyle (FXchar *style, FXint pos, FXint n) const
virtual void replaceText (FXint pos, FXint m, const FXchar *text, FXint n, FXbool notify=FALSE)
virtual void replaceText (FXint pos, FXint m, const FXString &text, FXbool notify=FALSE)
virtual void replaceStyledText (FXint pos, FXint m, const FXchar *text, FXint n, FXint style=0, FXbool notify=FALSE)
virtual void replaceStyledText (FXint pos, FXint m, const FXString &text, FXint style=0, FXbool notify=FALSE)
virtual void appendText (const FXchar *text, FXint n, FXbool notify=FALSE)
virtual void appendText (const FXString &text, FXbool notify=FALSE)
virtual void appendStyledText (const FXchar *text, FXint n, FXint style=0, FXbool notify=FALSE)
virtual void appendStyledText (const FXString &text, FXint style=0, FXbool notify=FALSE)
virtual void insertText (FXint pos, const FXchar *text, FXint n, FXbool notify=FALSE)
virtual void insertText (FXint pos, const FXString &text, FXbool notify=FALSE)
virtual void insertStyledText (FXint pos, const FXchar *text, FXint n, FXint style=0, FXbool notify=FALSE)
virtual void insertStyledText (FXint pos, const FXString &text, FXint style=0, FXbool notify=FALSE)
virtual void removeText (FXint pos, FXint n, FXbool notify=FALSE)
virtual void changeStyle (FXint pos, FXint n, FXint style)
virtual void changeStyle (FXint pos, const FXchar *style, FXint n)
virtual void changeStyle (FXint pos, const FXString &style)
virtual void setText (const FXchar *text, FXint n, FXbool notify=FALSE)
virtual void setText (const FXString &text, FXbool notify=FALSE)
virtual void setStyledText (const FXchar *text, FXint n, FXint style=0, FXbool notify=FALSE)
virtual void setStyledText (const FXString &text, FXint style=0, FXbool notify=FALSE)
void getText (FXchar *text, FXint n) const
void getText (FXString &text) const
FXString getText () const
FXint getLength () const
FXint getNumRows () const
FXint shiftText (FXint start, FXint end, FXint amount, FXbool notify=FALSE)
FXbool findText (const FXString &string, FXint *beg=NULL, FXint *end=NULL, FXint start=0, FXuint flags=SEARCH_FORWARD|SEARCH_WRAP|SEARCH_EXACT, FXint npar=1)
FXbool isPosSelected (FXint pos) const
FXbool isPosVisible (FXint pos) const
FXint getPosAt (FXint x, FXint y) const
FXint countRows (FXint start, FXint end) const
FXint countCols (FXint start, FXint end) const
FXint countLines (FXint start, FXint end) const
FXint lineStart (FXint pos) const
FXint lineEnd (FXint pos) const
FXint nextLine (FXint pos, FXint nl=1) const
FXint prevLine (FXint pos, FXint nl=1) const
FXint rowStart (FXint pos) const
FXint rowEnd (FXint pos) const
FXint nextRow (FXint pos, FXint nr=1) const
FXint prevRow (FXint pos, FXint nr=1) const
FXint leftWord (FXint pos) const
FXint rightWord (FXint pos) const
FXint wordStart (FXint pos) const
FXint wordEnd (FXint pos) const
FXint validPos (FXint pos) const
FXint dec (FXint pos) const
FXint inc (FXint pos) const
void setTopLine (FXint pos)
FXint getTopLine () const
void setBottomLine (FXint pos)
FXint getBottomLine () const
void setCenterLine (FXint pos)
void setAnchorPos (FXint pos)
FXint getAnchorPos () const
virtual void setCursorPos (FXint pos, FXbool notify=FALSE)
void setCursorRow (FXint row, FXbool notify=FALSE)
FXint getCursorRow () const
void setCursorColumn (FXint col, FXbool notify=FALSE)
FXint getCursorColumn () const
FXint getCursorPos () const
FXint getSelStartPos () const
FXint getSelEndPos () const
FXbool selectAll (FXbool notify=FALSE)
virtual FXbool extendSelection (FXint pos, FXTextSelectionMode select=SELECT_CHARS, FXbool notify=FALSE)
FXbool setSelection (FXint pos, FXint len, FXbool notify=FALSE)
virtual FXbool killSelection (FXbool notify=FALSE)
FXbool setHighlight (FXint start, FXint len)
FXbool killHighlight ()
void makePositionVisible (FXint pos)
void setTextStyle (FXuint style)
FXuint getTextStyle () const
void setVisibleRows (FXint rows)
FXint getVisibleRows () const
void setVisibleColumns (FXint cols)
FXint getVisibleColumns () const
void setHiliteMatchTime (FXuint t)
FXuint getHiliteMatchTime () const
void setHiliteStyles (const FXHiliteStyle *styles)
const FXHiliteStyle * getHiliteStyles () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXText ()

Static Public Attributes

static const FXchar textDelimiters []

Detailed Description

The text widget supports editing of multiple lines of text.

An optional style table can provide text coloring based on the contents of an optional parallel style buffer, which is maintained as text is edited. In a typical scenario, the contents of the style buffer is either directly written when the text is added to the widget, or is continually modified by editing the text via syntax-based highlighting engine which colors the text based on syntactical patterns.

See also:

Member Enumeration Documentation

anonymous enum
 

Enumeration values:
STYLE_UNDERLINE  Underline text.
STYLE_STRIKEOUT  Strike out text.
STYLE_BOLD  Bold text.

Constructor & Destructor Documentation

FX::FXText::FXText (  FXComposite *  p,
FXObject *  tgt = NULL,
FXSelector  sel = 0,
FXuint  opts = 0,
FXint  x = 0,
FXint  y = 0,
FXint  w = 0,
FXint  h = 0,
FXint  pl = 3,
FXint  pr = 3,
FXint  pt = 2,
FXint  pb = 2
) 
 

Construct multi-line text widget.

virtual FX::FXText::~FXText (   )  [virtual]
 

Destructor.

Member Function Documentation

virtual void FX::FXText::create (   )  [virtual]
 

Create server-side resources.

Reimplemented from FX::FXComposite.

virtual void FX::FXText::detach (   )  [virtual]
 

Detach server-side resources.

Reimplemented from FX::FXComposite.

virtual void FX::FXText::layout (   )  [virtual]
 

Perform layout.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXText::getDefaultWidth (   )  [virtual]
 

Return default width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXText::getDefaultHeight (   )  [virtual]
 

Return default height.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXText::enable (   )  [virtual]
 

Enable the text widget.

Reimplemented from FX::FXWindow.

virtual void FX::FXText::disable (   )  [virtual]
 

Disable the text widget.

Reimplemented from FX::FXWindow.

virtual void FX::FXText::recalc (   )  [virtual]
 

Need to recalculate size.

Reimplemented from FX::FXWindow.

virtual FXint FX::FXText::getContentWidth (   )  [virtual]
 

Get default width.

Reimplemented from FX::FXScrollArea.

virtual FXint FX::FXText::getContentHeight (   )  [virtual]
 

Get default height.

Reimplemented from FX::FXScrollArea.

virtual bool FX::FXText::canFocus (   )  const [virtual]
 

Returns true because a text widget can receive focus.

Reimplemented from FX::FXWindow.

virtual void FX::FXText::setFocus (   )  [virtual]
 

Move the focus to this window.

Reimplemented from FX::FXWindow.

virtual void FX::FXText::killFocus (   )  [virtual]
 

Remove the focus from this window.

Reimplemented from FX::FXWindow.

void FX::FXText::setMarginTop (  FXint  pt  ) 
 

Change top margin.

FXint FX::FXText::getMarginTop (   )  const [inline]
 

Return top margin.

void FX::FXText::setMarginBottom (  FXint  pb  ) 
 

Change bottom margin.

FXint FX::FXText::getMarginBottom (   )  const [inline]
 

Return bottom margin.

void FX::FXText::setMarginLeft (  FXint  pl  ) 
 

Change left margin.

FXint FX::FXText::getMarginLeft (   )  const [inline]
 

Return left margin.

void FX::FXText::setMarginRight (  FXint  pr  ) 
 

Change right margin.

FXint FX::FXText::getMarginRight (   )  const [inline]
 

Return right margin.

FXint FX::FXText::getWrapColumns (   )  const [inline]
 

Return wrap columns.

void FX::FXText::setWrapColumns (  FXint  cols  ) 
 

Set wrap columns.

FXint FX::FXText::getTabColumns (   )  const [inline]
 

Return tab columns.

void FX::FXText::setTabColumns (  FXint  cols  ) 
 

Change tab columns.

FXint FX::FXText::getBarColumns (   )  const [inline]
 

Return number of columns used for line numbers.

void FX::FXText::setBarColumns (  FXint  cols  ) 
 

Change number of columns used for line numbers.

FXbool FX::FXText::isModified (   )  const [inline]
 

Return TRUE if text was modified.

void FX::FXText::setModified (  FXbool  mod = TRUE  )  [inline]
 

Set modified flag.

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

Set editable mode.

FXbool FX::FXText::isEditable (   )  const
 

Return TRUE if text is editable.

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

Set overstrike mode.

FXbool FX::FXText::isOverstrike (   )  const
 

Return TRUE if overstrike mode in effect.

void FX::FXText::setStyled (  FXbool  styled = TRUE  ) 
 

Set styled text mode.

FXbool FX::FXText::isStyled (   )  const [inline]
 

Return TRUE if style buffer.

void FX::FXText::setDelimiters (  const FXchar *  delims = textDelimiters  )  [inline]
 

Change delimiters of words.

const FXchar* FX::FXText::getDelimiters (   )  const [inline]
 

Return word delimiters.

void FX::FXText::setFont (  FXFont *  fnt  ) 
 

Change text font.

FXFont* FX::FXText::getFont (   )  const [inline]
 

Return text font.

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

Change text color.

FXColor FX::FXText::getTextColor (   )  const [inline]
 

Return text color.

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

Change selected background color.

FXColor FX::FXText::getSelBackColor (   )  const [inline]
 

Return selected background color.

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

Change selected text color.

FXColor FX::FXText::getSelTextColor (   )  const [inline]
 

Return selected text color.

void FX::FXText::setHiliteTextColor (  FXColor  clr  ) 
 

Change highlighted text color.

FXColor FX::FXText::getHiliteTextColor (   )  const [inline]
 

Return highlighted text color.

void FX::FXText::setHiliteBackColor (  FXColor  clr  ) 
 

Change highlighted background color.

FXColor FX::FXText::getHiliteBackColor (   )  const [inline]
 

Return highlighted background color.

void FX::FXText::setActiveBackColor (  FXColor  clr  ) 
 

Change active background color.

FXColor FX::FXText::getActiveBackColor (   )  const [inline]
 

Return active background color.

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

Change cursor color.

FXColor FX::FXText::getCursorColor (   )  const [inline]
 

Return cursor color.

void FX::FXText::setNumberColor (  FXColor  clr  ) 
 

Change line number color.

FXColor FX::FXText::getNumberColor (   )  const [inline]
 

Return line number color.

void FX::FXText::setBarColor (  FXColor  clr  ) 
 

Change bar color.

FXColor FX::FXText::getBarColor (   )  const [inline]
 

Return bar color.

void FX::FXText::setHelpText (  const FXString &  text  )  [inline]
 

Set help text.

FXString FX::FXText::getHelpText (   )  const [inline]
 

Return help text.

void FX::FXText::setTipText (  const FXString &  text  )  [inline]
 

Set the tool tip message for this text widget.

FXString FX::FXText::getTipText (   )  const [inline]
 

Get the tool tip message for this text widget.

FXint FX::FXText::getByte (  FXint  pos  )  const
 

Get character at position in text buffer.

FXwchar FX::FXText::getChar (  FXint  pos  )  const
 

Get wide character at position pos.

FXint FX::FXText::getCharLen (  FXint  pos  )  const
 

Get length of wide character at position pos.

FXint FX::FXText::getStyle (  FXint  pos  )  const
 

Get style at position pos.

void FX::FXText::extractText (  FXchar *  text,
FXint  pos,
FXint  n
)  const
 

Extract n bytes of text from position pos.

void FX::FXText::extractText (  FXString &  text,
FXint  pos,
FXint  n
)  const
 

void FX::FXText::extractStyle (  FXString &  text,
FXint  pos,
FXint  n
)  const
 

Extract n bytes of style info from position pos.

void FX::FXText::extractStyle (  FXchar *  style,
FXint  pos,
FXint  n
)  const
 

virtual void FX::FXText::replaceText (  FXint  pos,
FXint  m,
const FXchar *  text,
FXint  n,
FXbool  notify = FALSE
)  [virtual]
 

Replace m bytes at pos by n characters.

virtual void FX::FXText::replaceText (  FXint  pos,
FXint  m,
const FXString &  text,
FXbool  notify = FALSE
)  [virtual]
 

virtual void FX::FXText::replaceStyledText (  FXint  pos,
FXint  m,
const FXchar *  text,
FXint  n,
FXint  style = 0,
FXbool  notify = FALSE
)  [virtual]
 

Replace m bytes at pos by n characters.

virtual void FX::FXText::replaceStyledText (  FXint  pos,
FXint  m,
const FXString &  text,
FXint  style = 0,
FXbool  notify = FALSE
)  [virtual]
 

virtual void FX::FXText::appendText (  const FXchar *  text,
FXint  n,
FXbool  notify = FALSE
)  [virtual]
 

Append n bytes of text at the end of the buffer.

virtual void FX::FXText::appendText (  const FXString &  text,
FXbool  notify = FALSE
)  [virtual]
 

virtual void FX::FXText::appendStyledText (  const FXchar *  text,
FXint  n,
FXint  style = 0,
FXbool  notify = FALSE
)  [virtual]