MGUI::FORM_COMPOSITE Class Reference

Base class for composite forms. More...

#include <mgui/form.h>

Inheritance diagram for MGUI::FORM_COMPOSITE:

[legend]List of all members.

Public Member Functions
	FORM_COMPOSITE ()
MDLGPARENT	GetDlgParent () const
virtual bool	IsCreated () const
virtual void	SetEnabled (bool enabled=true)
virtual void	SetVisible (bool visible=true)
virtual	~FORM_COMPOSITE ()=0
Protected Member Functions
void	CreatePane (MGUI::LAYOUT_PANE_BASE &ParentPane, MGUI::LAYOUT_ORIENTATION orientation, MGUI::LAYOUT_SIZEALIGN sizealign, int ChildSpacing=4, int ExtraBorder=0)
MGUI::LAYOUT_PANE &	GetPane ()

---

Detailed Description

Base class for composite forms.

Definition at line 97 of file form.h.

---

Constructor & Destructor Documentation

MGUI::FORM_COMPOSITE::FORM_COMPOSITE (   )

Constructor.

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

Destructor.

---

Member Function Documentation

void MGUI::FORM_COMPOSITE::CreatePane (  MGUI::LAYOUT_PANE_BASE &  ParentPane, MGUI::LAYOUT_ORIENTATION  orientation, MGUI::LAYOUT_SIZEALIGN  sizealign, int  ChildSpacing = 4, int  ExtraBorder = 0 )  [inline, protected]

Create layout pane. Use GetPane() to retrieve reference to pane. Parameters: ParentPane  'Parent' pane orientation  Pane orientation sizealign  Sizing and alignment ChildSpacing  Spacing between 'children' of pane ExtraBorder  Extra border around pane, in addition to ChildSpacing Definition at line 131 of file form.h.

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

Get suitable parent for dialog launched from form. Definition at line 109 of file form.h.

MGUI::LAYOUT_PANE& MGUI::FORM_COMPOSITE::GetPane (   )  [inline, protected]

Get layout pane. Definition at line 140 of file form.h.

virtual bool MGUI::FORM_COMPOSITE::IsCreated (   )  const [virtual]

Determine if form has been created. Returns: true if created, false if not. Implements MGUI::FORM. Reimplemented in MGUI::FORM_COLORSELECTOR.

virtual void MGUI::FORM_COMPOSITE::SetEnabled (  bool  enabled = true  )  [virtual]

Set whether mouse or keyboard input to form is allowed. Implements MGUI::FORM. Reimplemented in MGUI::FORM_COLORSELECTOR, and MGUI::FORM_COMBOBOX.

virtual void MGUI::FORM_COMPOSITE::SetVisible (  bool  visible = true  )  [virtual]

Set whether form is visible or not. Implements MGUI::FORM. Reimplemented in MGUI::FORM_COLORSELECTOR.

---

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

• mgui/form.h

---