os::StatusBar Class Reference
[The Syllable Graphical User Interface API]

Status bar. More...

Inheritance diagram for os::StatusBar:

os::LayoutView os::View os::Handler List of all members.

Public Member Functions

 StatusBar (const Rect &cFrame, const String &cTitle, uint32 nResizeMask=CF_FOLLOW_LEFT|CF_FOLLOW_TOP, uint32 nFlags=WID_WILL_DRAW|WID_FULL_UPDATE_ON_RESIZE)
 Constructor.
virtual ~StatusBar ()
LayoutNodeAddPanel (const String &cName, const String &cText, double vSize=0.0, uint32 nFlags=0)
 Add Panel to StatusBar.
LayoutNodeAddPanel (StatusPanel *pcPanel)
void SetText (const String &cName, const String &cText)
 Set a Panel's text.

Classes

class  Private

Detailed Description

Description:
Example:
        pcPanel->AddPanel( "statuspanel", "Status: OK" );
        pcPanel->SetText( "statuspanel", "Status: ERROR" );
See also:
StatusPanel
Author:
Henrik Isaksson ([email protected])


Constructor & Destructor Documentation

StatusBar::StatusBar ( const Rect cFrame,
const String cName,
uint32  nResizeMask = CF_FOLLOW_LEFT | CF_FOLLOW_TOP,
uint32  nFlags = WID_WILL_DRAW | WID_FULL_UPDATE_ON_RESIZE 
)

Description:
Parameters:
cFrame The frame rectangle in the parents coordinate system.
pzName The logical name of the view. This parameter is newer rendered anywhere, but is passed to the Handler::Handler() constructor to identify the view.
nResizeMask Flags defining how the view's frame rectangle is affected if the parent view is resized.
nFlags Various flags to control the view's behaviour.
See also:
AddPanel, StatusPanel
Author:
Henrik Isaksson ([email protected])

StatusBar::~StatusBar (  )  [virtual]


Member Function Documentation

LayoutNode * StatusBar::AddPanel ( const String cName,
const String cText,
double  vSize = 0.0,
uint32  nFlags = 0 
)

Description:
Parameters:
cName A name that can be used to find this panel.
cText The text to display in the panel, the minimum width of the panel will be set to match the width of this text.
vSize Size (optional), normally specified in number of characters of the width of m. Certain flags may result in other units being used.
nFlags (optionnal) Use F_FIXED to fix the width to the value passed in vSize.
See also:
StatusPanel
Author:
Henrik Isaksson ([email protected])

LayoutNode * StatusBar::AddPanel ( StatusPanel pcPanel  ) 

void StatusBar::SetText ( const String cName,
const String cText 
)

Description:
Parameters:
cName Identier that was used when the panel was created.
cText The text to display in the panel, the minimum width of the panel will be set to match the width of this text.
See also:
AddPanel
Author:
Henrik Isaksson ([email protected])


Generated on Sat May 9 22:51:45 2009 for Syllable higlevel API by  doxygen 1.5.1