Main Page | Modules | Directories | Namespace List | Class Hierarchy | Alphabetical List | Class List | File List | Namespace Members | Class Members | File Members | Related Pages | Search for 

MGUI::CTRL_STATUSBAR Class Reference

StatusBar control (MFC only). More...

#include <mgui/ctrl.h>

Inheritance diagram for MGUI::CTRL_STATUSBAR:

Inheritance graph
[legend]
List of all members.

Public Types

enum  PANESTYLE {
  PANESTYLE_NoBorders = SBPS_NOBORDERS, PANESTYLE_Popout = SBPS_POPOUT, PANESTYLE_Disabled = SBPS_DISABLED, PANESTYLE_Stretch = SBPS_STRETCH,
  PANESTYLE_Normal = SBPS_NORMAL
}
enum  STYLE { STYLE_Default = 0, STYLE_ToolTips = SBT_TOOLTIPS }

Public Member Functions

void ClearPane (int nIndex, bool update=true)
void ClearText ()
int CommandToIndex (UINT nID) const
void Create (MGUI::LAYOUT_PANE_BASE &ParentPane, int numpanes=1, STYLE style=STYLE_Default)
 CTRL_STATUSBAR ()
CStatusBar & GetCtrl ()
UINT GetItemID (int nIndex) const
void GetItemRect (int nIndex, LPRECT lpRect) const
void GetPaneInfo (int nIndex, UINT &nID, PANESTYLE &style, int &cxWidth)
PANESTYLE GetPaneStyle (int nIndex) const
CString GetPaneText (int nIndex) const
CStatusBar & GetStatusBar ()
CStatusBarCtrl & GetStatusBarCtrl () const
void SetIndicators (const UINT *lpIDArray, int nIDCount)
void SetPaneInfo (int nIndex, UINT nID, PANESTYLE style, int cxWidth)
void SetPaneStyle (int nIndex, PANESTYLE style)
void SetPaneText (int nIndex, const MIUNICODE *string, bool update=true)
void SetPaneText (int nIndex, LPCTSTR lpszNewText, bool bUpdate=true)
void SetText (const MIUNICODE *string)
void SetTextError (ERRVALUE err)
virtual ~CTRL_STATUSBAR ()

Protected Member Functions

virtual void OnClick (const NMMOUSE *lpnm)
virtual void OnDoubleClick (const NMMOUSE *lpnm)
virtual void OnRightClick (const NMMOUSE *lpnm)

Detailed Description

StatusBar control (MFC only).

This control is not dynamically positioned the same as other MGUI::CTRLs because the underlying CStatusBar does its own positioning via MFC. When adding a status bar to a MGUI::DIALOG you must use MGUI::DIALOG::SetStatusBar() in the dialog subclass's implementation of OnInitDialog() to allow for the status bar in dynamic layout.

Definition at line 2713 of file ctrl.h.

Member Enumeration Documentation

enum MGUI::CTRL_STATUSBAR::PANESTYLE
 

Enumeration values:
PANESTYLE_NoBorders 
PANESTYLE_Popout 
PANESTYLE_Disabled 
PANESTYLE_Stretch 
PANESTYLE_Normal 

Definition at line 2721 of file ctrl.h.

enum MGUI::CTRL_STATUSBAR::STYLE
 

Enumeration values:
STYLE_Default 
STYLE_ToolTips 

Definition at line 2716 of file ctrl.h.

Constructor & Destructor Documentation

MGUI::CTRL_STATUSBAR::CTRL_STATUSBAR (   )  [inline]
 

Constructor.

Definition at line 2730 of file ctrl.h.

virtual MGUI::CTRL_STATUSBAR::~CTRL_STATUSBAR (   )  [virtual]
 

Destructor.

Member Function Documentation

void MGUI::CTRL_STATUSBAR::ClearPane (  int  nIndex,
bool  update = true
)  [inline]
 

Clear text in specified pane.

Definition at line 2741 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::ClearText (   )  [inline]
 

Clear text in first pane.

Definition at line 2747 of file ctrl.h.

int MGUI::CTRL_STATUSBAR::CommandToIndex (  UINT  nID  )  const [inline]
 

Definition at line 2757 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::Create (  MGUI::LAYOUT_PANE_BASE &  ParentPane,
int  numpanes = 1,
STYLE  style = STYLE_Default
) 
 

Create control.

Parameters:
ParentPane  Parent pane
numpanes  Number of indicator panes

CStatusBar& MGUI::CTRL_STATUSBAR::GetCtrl (   )  [inline]
 

Get the actual control.

Definition at line 2762 of file ctrl.h.

UINT MGUI::CTRL_STATUSBAR::GetItemID (  int  nIndex  )  const [inline]
 

Definition at line 2765 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::GetItemRect (  int  nIndex,
LPRECT  lpRect
)  const [inline]
 

Definition at line 2769 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::GetPaneInfo (  int  nIndex,
UINT &  nID,
PANESTYLE &  style,
int &  cxWidth
)  [inline]
 

< Wants ref to UINT, not enum

Definition at line 2774 of file ctrl.h.

PANESTYLE MGUI::CTRL_STATUSBAR::GetPaneStyle (  int  nIndex  )  const [inline]
 

Definition at line 2786 of file ctrl.h.

CString MGUI::CTRL_STATUSBAR::GetPaneText (  int  nIndex  )  const [inline]
 

Definition at line 2790 of file ctrl.h.

CStatusBar& MGUI::CTRL_STATUSBAR::GetStatusBar (   )  [inline]
 

Get reference to CStatusBar.

Definition at line 2795 of file ctrl.h.

CStatusBarCtrl& MGUI::CTRL_STATUSBAR::GetStatusBarCtrl (   )  const [inline]
 

Get reference to CStatusBarCtrl.

Definition at line 2799 of file ctrl.h.

virtual void MGUI::CTRL_STATUSBAR::OnClick (  const NMMOUSE *  lpnm  )  [protected, virtual]
 

virtual void MGUI::CTRL_STATUSBAR::OnDoubleClick (  const NMMOUSE *  lpnm  )  [protected, virtual]
 

virtual void MGUI::CTRL_STATUSBAR::OnRightClick (  const NMMOUSE *  lpnm  )  [protected, virtual]
 

void MGUI::CTRL_STATUSBAR::SetIndicators (  const UINT *  lpIDArray,
int  nIDCount
)  [inline]
 

Definition at line 2802 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::SetPaneInfo (  int  nIndex,
UINT  nID,
PANESTYLE  style,
int  cxWidth
)  [inline]
 

Definition at line 2825 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::SetPaneStyle (  int  nIndex,
PANESTYLE  style
)  [inline]
 

Definition at line 2807 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::SetPaneText (  int  nIndex,
const MIUNICODE *  string,
bool  update = true
) 
 

Set text for specified pane using Unicode string.

void MGUI::CTRL_STATUSBAR::SetPaneText (  int  nIndex,
LPCTSTR  lpszNewText,
bool  bUpdate = true
)  [inline]
 

Definition at line 2812 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::SetText (  const MIUNICODE *  string  )  [inline]
 

Set text for first pane from Unicode string.

Definition at line 2833 of file ctrl.h.

void MGUI::CTRL_STATUSBAR::SetTextError (  ERRVALUE  err  ) 
 

Set text for first pane to error message.

The documentation for this class was generated from the following file:
Generated on Wed May 31 15:29:50 2006 for TNTsdk by  doxygen 1.3.8-20040913