MGUI::TOPSHELL Class Reference

Base class for 'top level' application shells. More...

#include <mgui/topshell.h>

Inheritance diagram for MGUI::TOPSHELL:

[legend]List of all members.

Public Types
enum	STYLE {   STYLE_Default = 0x0000, STYLE_NoClose = 0x0001, STYLE_NoMinimize = 0x0002, STYLE_NoMaximize = 0x0004,   STYLE_NoResize = 0x0008 }
Public Member Functions
void	Create (const char *PlacementKey=0, TEXTID TitleID=TEXTID__None, STYLE style=TOPSHELL::STYLE_Default)
void	EnableDocking (DOCKEDGE dockedges=DOCKEDGE_Any)
void	SetVisible (bool visible=true)
	TOPSHELL (HELPID helpid)
virtual	~TOPSHELL ()
Private Member Functions
virtual int	v_CreateContent ()=0
virtual void	v_OnClose ()
virtual void	v_OnCloseRequest ()=0
virtual void	v_OnOpen ()

---

Detailed Description

Base class for 'top level' application shells.

Top-level shells are windows whose parent is the 'desktop'.

Definition at line 50 of file topshell.h.

---

Member Enumeration Documentation

enum MGUI::TOPSHELL::STYLE

Enumeration values: STYLE_Default  STYLE_NoClose  STYLE_NoMinimize  STYLE_NoMaximize  STYLE_NoResize  Don't allow resizing, implies NoMaximize also. Definition at line 53 of file topshell.h.

---

Constructor & Destructor Documentation

MGUI::TOPSHELL::TOPSHELL (  HELPID  helpid  )

Constructor.

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

Destructor.

---

Member Function Documentation

void MGUI::TOPSHELL::Create (  const char *  PlacementKey = 0, TEXTID  TitleID = TEXTID__None, STYLE  style = TOPSHELL::STYLE_Default )

Create the actual shell graphical object. Parameters: PlacementKey  Ini/Registry key for automatic placement management TitleID  Text ID for title style  Shell style

void MGUI::TOPSHELL::EnableDocking (  DOCKEDGE  dockedges = DOCKEDGE_Any  )

Enable edges of shell for control bar docking. If not specified and control bars are created for the shell then all edges are assumed to be enabled for docking. Parameters: dockedges  Sides of shell enabled for docking of control bars

void MGUI::TOPSHELL::SetVisible (  bool  visible = true  )

Set whether shell is visible or not.

virtual int MGUI::TOPSHELL::v_CreateContent (   )  [private, pure virtual]

Create shell contents. Derived class MUST implement this. Function must return TRUE to show shell immediately, FALSE to not show the shell, or an error code < 0. This will be called by the shell creation code and thus must not be called directly. This is normally overridden only by the specific shell implementation and not by the code that actually uses that shell implementation. The implementation should call GetMainPane() to determine the pane to create the controls in. Implements MGUI::SHELL.

virtual void MGUI::TOPSHELL::v_OnClose (   )  [private, virtual]

Called when shell gets hidden or closed.

virtual void MGUI::TOPSHELL::v_OnCloseRequest (   )  [private, pure virtual]

Called when user requests that shell be 'closed'. Usually results from an OS or Window Manager notification. To honor request and close the shell, override and call Destroy(). Implements MGUI::SHELL.

virtual void MGUI::TOPSHELL::v_OnOpen (   )  [private, virtual]

Called after shell is actually displayed.

---

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

• mgui/topshell.h

---