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 Member Functions

 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)
virtual void create ()
virtual void detach ()
virtual void layout ()
virtual FXint getDefaultWidth ()
virtual FXint getDefaultHeight ()
virtual FXbool canFocus () const
virtual FXint getContentWidth ()
virtual FXint getContentHeight ()
void setFont (FXFont *fnt)
FXFontgetFont () const
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
void setHistoryLines (FXint hl)
FXint getHistoryLines () const
void setVisibleRows (FXint rows)
FXint getVisibleRows () const
void setVisibleColumns (FXint cols)
FXint getVisibleColumns () const
void setHelpText (const FXString &text)
FXString getHelpText () const
void setTipText (const FXString &text)
FXString getTipText () const
virtual void save (FXStream &store) const
virtual void load (FXStream &store)
virtual ~FXConsole ()


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.

See also:


Constructor & Destructor Documentation

FX::FXConsole::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 FX::FXConsole::~FXConsole (  )  [virtual]

Destructor.


Member Function Documentation

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

Create server-side resources.

Reimplemented from FX::FXComposite.

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

Detach server-side resources.

Reimplemented from FX::FXComposite.

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

Perform layout.

Reimplemented from FX::FXScrollArea.

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

Return default width.

Reimplemented from FX::FXScrollArea.

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

Return default height.

Reimplemented from FX::FXScrollArea.

virtual FXbool FX::FXConsole::canFocus (  )  const [virtual]

Returns true because a text widget can receive focus.

Reimplemented from FX::FXWindow.

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

Return content width.

Reimplemented from FX::FXScrollArea.

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

Return content height.

Reimplemented from FX::FXScrollArea.

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

Change text font.

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

Return text font.

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

Change top margin.

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

Return top margin.

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

Change bottom margin.

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

Return bottom margin.

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

Change left margin.

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

Return left margin.

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

Change right margin.

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

Return right margin.

void FX::FXConsole::setHistoryLines ( FXint  hl  ) 

Change history lines.

FXint FX::FXConsole::getHistoryLines (  )  const [inline]

Return history lines.

void FX::FXConsole::setVisibleRows ( FXint  rows  ) 

Change number of visible rows.

FXint FX::FXConsole::getVisibleRows (  )  const [inline]

Return number of visible rows.

void FX::FXConsole::setVisibleColumns ( FXint  cols  ) 

Change number of visible columns.

FXint FX::FXConsole::getVisibleColumns (  )  const [inline]

Return number of visible columns.

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

Set help text.

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

Return help text.

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

Set the tool tip message for this widget.

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

Get the tool tip message for this widget.

virtual void FX::FXConsole::save ( FXStream store  )  const [virtual]

Save to a stream.

Reimplemented from FX::FXScrollArea.

virtual void FX::FXConsole::load ( FXStream store  )  [virtual]

Load from a stream.

Reimplemented from FX::FXScrollArea.

Copyright © 1997-2009 Jeroen van der Zijp