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

FX::FXConsole Class Reference

The console widget is a scrolling text widget used primarily for logging purposes and "terminals" It is high-performance and features bounded but arbitrary scroll-back capability. More...

#include <FXConsole.h>

Inheritance diagram for FX::FXConsole:
FX::FXScrollArea FX::FXComposite FX::FXWindow FX::FXDrawable FX::FXId FX::FXObject

List of all members.

Public Types

enum  { ID_XXX = FXScrollArea::ID_LAST, ID_LAST }

Public Member Functions

long onPaint (FXObject *, FXSelector, void *)
long onXXX (FXObject *, FXSelector, void *)
 FXConsole (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 console window.
virtual void create ()
 Create server-side resources.
virtual void detach ()
 Detach server-side resources.
virtual void layout ()
 Perform layout.
virtual FXint getDefaultWidth ()
 Return default width.
virtual FXint getDefaultHeight ()
 Return default height.
virtual FXbool canFocus () const
 Returns true because a text widget can receive focus.
virtual FXint getContentWidth ()
 Return content width.
virtual FXint getContentHeight ()
 Return content height.
void setFont (FXFont *fnt)
 Change text font.
FXFontgetFont () const
 Return text font.
void setMarginTop (FXint pt)
 Change top margin.
FXint getMarginTop () const
 Return top margin.
void setMarginBottom (FXint pb)
 Change bottom margin.
FXint getMarginBottom () const
 Return bottom margin.
void setMarginLeft (FXint pl)
 Change left margin.
FXint getMarginLeft () const
 Return left margin.
void setMarginRight (FXint pr)
 Change right margin.
FXint getMarginRight () const
 Return right margin.
void setHistoryLines (FXint hl)
 Change history lines.
FXint getHistoryLines () const
 Return history lines.
void setVisibleRows (FXint rows)
 Change number of visible rows.
FXint getVisibleRows () const
 Return number of visible rows.
void setVisibleColumns (FXint cols)
 Change number of visible columns.
FXint getVisibleColumns () const
 Return number of visible columns.
void setHelpText (const FXString &text)
 Set help text.
FXString getHelpText () const
 Return help text.
void setTipText (const FXString &text)
 Set the tool tip message for this widget.
FXString getTipText () const
 Get the tool tip message for this widget.
virtual void save (FXStream &store) const
 Save to a stream.
virtual void load (FXStream &store)
 Load from a stream.
virtual ~FXConsole ()
 Destructor.

Protected Types

enum  {
  STYLE_MASK = 0x00FF, STYLE_TEXT = 0x0100, STYLE_SELECTED = 0x0200, STYLE_CONTROL = 0x0400,
  STYLE_HILITE = 0x0800, STYLE_ACTIVE = 0x1000
}

Protected Member Functions

FXint charWidth (FXwchar ch, FXint col) const
FXuint styleOf (FXint line, FXint index, FXint p, FXint c) const
virtual void moveContents (FXint x, FXint y)
void drawTextFragment (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h, const FXchar *text, FXint n, FXuint sty) const
void drawTextLine (FXDCWindow &dc, FXint line, FXint left, FXint right) const
void drawContents (FXDCWindow &dc, FXint x, FXint y, FXint w, FXint h) const

Protected Attributes

FXStringBuffer contents
FXStringBuffer style
FXFontfont
FXint margintop
FXint marginbottom
FXint marginleft
FXint marginright
FXint historylines
FXint visiblelines
FXint topline
FXint vrows
FXint vcols
FXColor textColor
FXColor selbackColor
FXColor seltextColor
FXColor cursorColor
FXString help
FXString tip

Detailed Description

The console widget is a scrolling text widget used primarily for logging purposes and "terminals" It is high-performance and features bounded but arbitrary scroll-back capability.


The documentation for this class was generated from the following file:

Copyright © 1997-2011 Jeroen van der Zijp