MGUI::LAYOUT_PANE_BASE Class Reference

Layout pane base class, not intended to be used directly. More...

#include <mgui/layout.h>

Inheritance diagram for MGUI::LAYOUT_PANE_BASE:

[legend]List of all members.

Public Member Functions
void	AddItem (CWnd *ItemWnd, MGUI::LAYOUT_SIZEALIGN sizealign)
void	AddSpaceExpanding ()
void	AddSpaceFixed (int size)
CRect	ComputeRect (int width, int xadd=0, int yadd=0) const
CRect	ComputeRect (const CString &str, int xadd=0, int yadd=0) const
CSize	ComputeTextSize (const CString &str) const
MGUI::POINT	ComputeTextSize (const UNICODE *str) const
MGUI::POINT	ComputeTextSize (const MISTRING &str) const
MGUI::POINT	ComputeTextSize (int width) const
MDLGPARENT	GetDlgParent () const
ETSLayoutMgr *	GetLayoutMgr () const
CWnd *	GetMainWnd () const
UINT	GetNextControlID ()
ETSLayoutMgr::CPane &	GetPane ()
MGUI::LAYOUT_PANE_ROOT *	GetRootPane () const
CWnd *	GetRootWnd () const
Widget	GetWidget () const
bool	IsCreated () const
	LAYOUT_PANE_BASE ()
	LAYOUT_PANE_BASE (CWnd *RootWnd=0)
	operator CWnd * ()
void	PreTransListAddCtrl (CTRL *ctrl)
void	SetEnabled (bool enabled)
void	SetVisible (bool visible)
void	UpdateLayout ()
virtual	~LAYOUT_PANE_BASE ()=0
Protected Member Functions
void	SetPaneWidget (Widget PaneWidget)
Protected Attributes
ETSLayoutMgr::CPane	m_Pane
MGUI::LAYOUT_PANE_ROOT *	m_RootPane

---

Detailed Description

Layout pane base class, not intended to be used directly.

Definition at line 1066 of file layout.h.

---

Constructor & Destructor Documentation

MGUI::LAYOUT_PANE_BASE::LAYOUT_PANE_BASE (  CWnd *  RootWnd = 0  )  [inline]

Constructor (MFC version). Definition at line 1071 of file layout.h.

MGUI::LAYOUT_PANE_BASE::LAYOUT_PANE_BASE (   )  [inline]

Constructor (X version). Definition at line 1078 of file layout.h.

virtual MGUI::LAYOUT_PANE_BASE::~LAYOUT_PANE_BASE (   )  [pure virtual]

Destructor.

---

Member Function Documentation

void MGUI::LAYOUT_PANE_BASE::AddItem (  CWnd *  ItemWnd, MGUI::LAYOUT_SIZEALIGN  sizealign )

Add item to pane (MFC only).

void MGUI::LAYOUT_PANE_BASE::AddSpaceExpanding (   )  [inline]

Add automatically expanding whitespace item. Definition at line 1101 of file layout.h.

void MGUI::LAYOUT_PANE_BASE::AddSpaceFixed (  int  size  )  [inline]

Add whitespace item of fixed size. Definition at line 1111 of file layout.h.

CRect MGUI::LAYOUT_PANE_BASE::ComputeRect (  int  width, int  xadd = 0, int  yadd = 0 )  const [inline]

Compute size rectangle for given text "width" (MFC only). Definition at line 1132 of file layout.h.

CRect MGUI::LAYOUT_PANE_BASE::ComputeRect (  const CString &  str, int  xadd = 0, int  yadd = 0 )  const

Compute size rectangle for given label text as CString (MFC only).

CSize MGUI::LAYOUT_PANE_BASE::ComputeTextSize (  const CString &  str  )  const

Compute size of given label text as CString (MFC only).

MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize (  const UNICODE *  str  )  const

Compute size of given label text as UNICODE string. Parameters: str  String

MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize (  const MISTRING &  str  )  const

Compute size of given label text from MISTRING. Parameters: str  String (or TEXTID)

MGUI::POINT MGUI::LAYOUT_PANE_BASE::ComputeTextSize (  int  width  )  const

Compute typical size for given text width in characters. Parameters: width  Width in characters

MDLGPARENT MGUI::LAYOUT_PANE_BASE::GetDlgParent (   )  const [inline]

Get suitable parent for dialog launched from pane. Definition at line 1162 of file layout.h.

ETSLayoutMgr* MGUI::LAYOUT_PANE_BASE::GetLayoutMgr (   )  const [inline]

Get pointer to layout manager (MFC only). Reimplemented in MGUI::LAYOUT_PANE_ROOT.

CWnd* MGUI::LAYOUT_PANE_BASE::GetMainWnd (   )  const [inline]

Get "main" window, typically for use as parent for other dialogs. MGUI::LAYOUT_ORIENTATION GetOrientation ( ) const;

UINT MGUI::LAYOUT_PANE_BASE::GetNextControlID (   )

Get next available dynamically assigned control ID.

ETSLayoutMgr::CPane& MGUI::LAYOUT_PANE_BASE::GetPane (   )  [inline]

Get reference to layout manager pane. Definition at line 1195 of file layout.h.

MGUI::LAYOUT_PANE_ROOT* MGUI::LAYOUT_PANE_BASE::GetRootPane (   )  const [inline]

Get "root pane". Definition at line 1207 of file layout.h.

CWnd* MGUI::LAYOUT_PANE_BASE::GetRootWnd (   )  const [inline]

Get root CWnd* for control creation.

Widget MGUI::LAYOUT_PANE_BASE::GetWidget (   )  const [inline]

Get pane widget (X only). Definition at line 1201 of file layout.h.

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

Determine if pane has been created. Definition at line 1218 of file layout.h.

MGUI::LAYOUT_PANE_BASE::operator CWnd * (   )  [inline]

Cast to CWnd* so can use pane as parent for MFC Create() methods. Definition at line 1088 of file layout.h.

void MGUI::LAYOUT_PANE_BASE::PreTransListAddCtrl (  CTRL *  ctrl  )  [inline]

Add CTRL to message pre-translation list.

void MGUI::LAYOUT_PANE_BASE::SetEnabled (  bool  enabled  )  [inline]

Set 'enabled' status for all controls in pane or children therof. Reimplemented in MGUI::LAYOUT_PAGE. Definition at line 1235 of file layout.h.

void MGUI::LAYOUT_PANE_BASE::SetPaneWidget (  Widget  PaneWidget  )  [protected]

void MGUI::LAYOUT_PANE_BASE::SetVisible (  bool  visible  )  [inline]

Set visibility for all controls in pane or children thereof. Definition at line 1246 of file layout.h.

void MGUI::LAYOUT_PANE_BASE::UpdateLayout (   )  [inline]

Force update of layout. This may be necessary if the layout is changed after the dialog/window is initially created. Definition at line 1258 of file layout.h.

---

Member Data Documentation

ETSLayoutMgr::CPane MGUI::LAYOUT_PANE_BASE::m_Pane [protected]

Actual layout manager pane. Definition at line 1276 of file layout.h.

MGUI::LAYOUT_PANE_ROOT* MGUI::LAYOUT_PANE_BASE::m_RootPane [protected]

Pointer to root pane. Definition at line 1275 of file layout.h.

---

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

• mgui/layout.h

---