MGUI::FORM_COMPOSITE Class Reference

Base class for composite forms. More...

#include <mgui/form.h>

Inherits MGUI::FORM.

Inherited by GRE::DATATIPPARMS::FORM, GRE::GEOLOCKSETTINGS::FORM, GRE::LAYER::GLOBALOPTIONS::FORM, GRE::UI::FORM_PLACES, GRE::UI::FORM_VIEW, GRE::UI::FORM_ZOOM, GRE::VIEWCOMMON::FORM, GRE::VIEWCOMMON::FORM_SNAPSHOT, LIDAR::UI::FORM_CLASSDESCSET, MATTE::FORM, MGD::IMAGEFILEWRITER::SETTINGS::FORM, MGUI::FORM_BOOK, MGUI::FORM_BUTTONTEXT, MGUI::FORM_CHECKLIST, MGUI::FORM_COLORBUTTON, MGUI::FORM_COLORSELECTOR, MGUI::FORM_COLORSPREAD, MGUI::FORM_COMBOBOX, MGUI::FORM_EDIT_COLORS, MGUI::FORM_EDIT_CONTACT, MGUI::FORM_EDIT_COORD, MGUI::FORM_EDIT_EXTENTS, MGUI::FORM_EDIT_NUMBER_BASE, MGUI::FORM_EDIT_RANGE, MGUI::FORM_EDIT_SML, MGUI::FORM_EDIT_SML_PARAMETERS, MGUI::FORM_EDIT_STRING, MGUI::FORM_EDIT_TSD, MGUI::FORM_FILE_LIST, MGUI::FORM_GEOCATALOG, MGUI::FORM_GOOGLESEARCH, MGUI::FORM_HTML, MGUI::FORM_LINKTOTILESET, MGUI::FORM_LIST, MGUI::FORM_NAMEDREGION_LIST, MGUI::FORM_ODBC, MGUI::FORM_ODBC_PRIMARY, MGUI::FORM_ODBC_SOURCE, MGUI::FORM_PASSWORD, MGUI::FORM_QUERY_BUILDER, MGUI::FORM_RADIOBUTTONS, MGUI::FORM_RASTER_FILTER_PARMS, MGUI::FORM_RAWDATA [private], MGUI::FORM_SLIDER, MGUI::FORM_SPATMOD_IMAGE_VIEW, MGUI::FORM_STEREODEVICE, MGUI::FORM_TABBED, MGUI::TOOL_BASE::MANUAL_BASE, RVC::UI::FORM_DB_FIELD_PICKLIST, RVC::UI::FORM_DB_RECORD, RVC::UI::FORM_EDIT_DESCRIPTOR, RVC::UI::FORM_EDIT_OBJECTNAME, RVC::UI::FORM_EDIT_RASTER_VALUE, RVC::UI::FORM_GEOMETRIC_EXTRACT, RVC::UI::FORM_IMAGE_PYRAMID, RVC::UI::FORM_IMAGEDISPLAYBANDS, RVC::UI::FORM_OBJECT_LIST, RVC::UI::FORM_RASTER_COMPRESSION, RVC::UI::FORM_RASTER_TYPE, RVC::UI::FORM_SELECT_ELEMENTS_GEOMETRIC, RVC::UI::FORM_SELECT_ELEMENTS_SINGLETYPE, RVC::VECTORTOOLKIT::SNAPPARMS::PANEL, SOA::ARCIMS::UI_FORM_CONNECTION, SOA::ARCIMS::UI_FORM_CONNECTION_SMALL, SOA::ARCIMS::UI_FORM_LAYERSELECT, SOA::WMS::UI_FORM_CONNECTION, SOA::WMS::UI_FORM_CONNECTION_SMALL, and SOA::WMS::UI_FORM_LAYERSELECT.

List of all members.

Public Member Functions
	FORM_COMPOSITE ()
virtual	~FORM_COMPOSITE ()=0
MDLGPARENT	GetDlgParent () const
virtual bool	IsCreated () const
bool	IsVisible () const
virtual void	SetEnabled (bool enabled=true)
virtual void	SetVisible (bool visible=true)
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.

---

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

MDLGPARENT MGUI::FORM_COMPOSITE::GetDlgParent

(

)

const [inline]

Get suitable parent for dialog launched from form.

MGUI::LAYOUT_PANE& MGUI::FORM_COMPOSITE::GetPane

(

)

[inline, protected]

Get layout pane.

virtual bool MGUI::FORM_COMPOSITE::IsCreated

(

)

const [virtual]

Determine if form has been created.

Returns:

true if created, false if not.

Implements MGUI::FORM.

bool MGUI::FORM_COMPOSITE::IsVisible

(

)

const [inline]

Determine if form is visible.

Returns:

true if visible, false if not. Does not check if form is contained in a non-visible parent form.

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_CHECKLIST.

virtual void MGUI::FORM_COMPOSITE::SetVisible

(

bool

visible = true

)

[virtual]

Set whether form is visible or not.

Implements MGUI::FORM.

Reimplemented in MGUI::FORM_CHECKLIST.

---

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

• mgui/form.h