MGUI::SHELL Class Reference

Base class for 'shell' windows (application windows and dialogs). More...

#include <mgui/shell.h>

Inheritance diagram for MGUI::SHELL:

[legend]List of all members.

Public Member Functions
void	Destroy ()
MDLGPARENT	GetDlgParent () const
HELPID	GetHelpID () const
LAYOUT_PANE_MAIN &	GetMainPane ()
void	GetPlacement (PLACEMENT &placement) const
bool	IsCreated () const
bool	SetPlacement (const PLACEMENT &placement)
void	SetPlacementByKey (const char *PlacementKey)
void	SetTitle (const MISTRING &title)
Protected Member Functions
MGUI::COMMAND_ROUTER *	GetCmdRouter () const
void	SetMenuBar (const MGUI::MENU &menu)
void	SetStatusBar (MGUI::CTRL_STATUSBAR &StatusBar)
	SHELL (HELPID helpid)
virtual	~SHELL ()
Private Member Functions
virtual int	v_CreateContent ()=0
virtual void	v_Destroy ()=0
virtual MGUI::COMMAND_ROUTER *	v_GetCmdRouter () const =0
virtual LAYOUT_PANE_MAIN &	v_GetMainPane ()=0
virtual void	v_OnCloseRequest ()=0

---

Detailed Description

Base class for 'shell' windows (application windows and dialogs).

Definition at line 75 of file shell.h.

---

Constructor & Destructor Documentation

MGUI::SHELL::SHELL (  HELPID  helpid  )  [protected]

Constructor.

virtual MGUI::SHELL::~SHELL (   )  [protected, virtual]

Destructor.

---

Member Function Documentation

void MGUI::SHELL::Destroy (   )

Destroy the shell.

MGUI::COMMAND_ROUTER* MGUI::SHELL::GetCmdRouter (   )  const [inline, protected]

Get "command router" for shell. Definition at line 139 of file shell.h.

MDLGPARENT MGUI::SHELL::GetDlgParent (   )  const

Get MDLGPARENT for use as parent for child dialogs.

HELPID MGUI::SHELL::GetHelpID (   )  const [inline]

Get Help ID. Definition at line 88 of file shell.h.

LAYOUT_PANE_MAIN& MGUI::SHELL::GetMainPane (   )  [inline]

Get main layout pane. Definition at line 92 of file shell.h.

void MGUI::SHELL::GetPlacement (  PLACEMENT &  placement  )  const

Get shell 'placement' on screen.

bool MGUI::SHELL::IsCreated (   )  const [inline]

Determine if shell has been 'created' yet. Definition at line 101 of file shell.h.

void MGUI::SHELL::SetMenuBar (  const MGUI::MENU &  menu  )  [protected]

bool MGUI::SHELL::SetPlacement (  const PLACEMENT &  placement  )

Set shell 'placement' on screen. Return 'true' if successful, 'false' if not.

void MGUI::SHELL::SetPlacementByKey (  const char *  PlacementKey  )

Set Ini/Registry key for automatic shell placement. This will automatically load the placement and subsequently record any changes later made to the placement by the user.

void MGUI::SHELL::SetStatusBar (  MGUI::CTRL_STATUSBAR &  StatusBar  )  [inline, protected]

Set status bar. Definition at line 153 of file shell.h.

void MGUI::SHELL::SetTitle (  const MISTRING &  title  )

Set title. Parameters: title  Title string (can be TEXTID also)

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

Create shell contents. For details see MGUI::TOPSHELL or MGUI::DLGSHELL. Implemented in GRE::DLG_VIEWZOOM, MGUI::DLGSHELL, MGUI::FRAMESTYLEDLG, and MGUI::TOPSHELL.

virtual void MGUI::SHELL::v_Destroy (   )  [private, pure virtual]

Destroy the shell.

virtual MGUI::COMMAND_ROUTER* MGUI::SHELL::v_GetCmdRouter (   )  const [private, pure virtual]

Get command router (MFC only).

virtual LAYOUT_PANE_MAIN& MGUI::SHELL::v_GetMainPane (   )  [private, pure virtual]

Get main layout pane.

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

Called when user requests that shell be 'closed'. Usually results from an OS or Window Manager notification. Implemented in MGUI::DLGSHELL, and MGUI::TOPSHELL.

---

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

• mgui/shell.h

---