DlgSettingsAbstractBase Class Reference

Abstract base class for all Settings dialogs. More...

#include <DlgSettingsAbstractBase.h>

Inheritance diagram for DlgSettingsAbstractBase:

Public Member Functions
	DlgSettingsAbstractBase (const QString &title, const QString &dialogName, MainWindow &mainWindow)
	Single constructor.

Protected Member Functions
CmdMediator &	cmdMediator ()
	Provide access to Document information wrapped inside CmdMediator.
virtual void	createOptionalSaveDefault (QHBoxLayout *layout)=0
	Let subclass define an optional Save As Default button.
virtual QWidget *	createSubPanel ()=0
	Create dialog-specific panel to which base class will add Ok and Cancel buttons.
void	enableOk (bool enable)
	Let leaf subclass control the Ok button.
void	finishPanel (QWidget *subPanel)
	Add Ok and Cancel buttons to subpanel to get the whole dialog.
virtual void	handleOk ()=0
	Process slotOk.
virtual void	load (CmdMediator &cmdMediator)=0
	Load settings from Document.
MainWindow &	mainWindow ()
	Get method for MainWindow.
const MainWindow &	mainWindow () const
	Const get method for MainWindow.
void	populateColorComboWithoutTransparent (QComboBox &combo)
	Add colors in color palette to combobox, without transparent entry at end.
void	populateColorComboWithTransparent (QComboBox &combo)
	Add colors in color palette to combobox, with transparent entry at end.
void	setCmdMediator (CmdMediator &cmdMediator)
	Store CmdMediator for easy access by the leaf class.
void	setDisableOkAtStartup (bool disableOkAtStartup)
	Override the default Ok button behavior applied in showEvent.

Static Protected Attributes
static int	MINIMUM_DIALOG_WIDTH = 350
	Dialog layout constant that guarantees every widget has sufficient room.
static int	MINIMUM_PREVIEW_HEIGHT = 200
	Dialog layout constant that guarantees preview has sufficent room.

Detailed Description

Abstract base class for all Settings dialogs.

Definition at line 19 of file DlgSettingsAbstractBase.h.

Constructor & Destructor Documentation

DlgSettingsAbstractBase()

DlgSettingsAbstractBase::DlgSettingsAbstractBase	(	const QString &	title,
		const QString &	dialogName,
		MainWindow &	mainWindow
	)

Single constructor.

Definition at line 22 of file DlgSettingsAbstractBase.cpp.

~DlgSettingsAbstractBase()

DlgSettingsAbstractBase::~DlgSettingsAbstractBase ( )

virtual

Definition at line 38 of file DlgSettingsAbstractBase.cpp.

Member Function Documentation

cmdMediator()

CmdMediator & DlgSettingsAbstractBase::cmdMediator ( )

protected

Provide access to Document information wrapped inside CmdMediator.

Definition at line 44 of file DlgSettingsAbstractBase.cpp.

createOptionalSaveDefault()

virtual void DlgSettingsAbstractBase::createOptionalSaveDefault ( QHBoxLayout *  layout )

protectedpure virtual

Let subclass define an optional Save As Default button.

Implemented in DlgImportAdvanced, DlgSettingsAxesChecker, DlgSettingsColorFilter, DlgSettingsCoords, DlgSettingsCurveAddRemove, DlgSettingsCurveProperties, DlgSettingsDigitizeCurve, DlgSettingsExportFormat, DlgSettingsGeneral, DlgSettingsGridRemoval, DlgSettingsMainWindow, DlgSettingsPointMatch, and DlgSettingsSegments.

createSubPanel()

virtual QWidget * DlgSettingsAbstractBase::createSubPanel ( )

protectedpure virtual

Create dialog-specific panel to which base class will add Ok and Cancel buttons.

Implemented in DlgImportAdvanced, DlgSettingsAxesChecker, DlgSettingsColorFilter, DlgSettingsCoords, DlgSettingsCurveAddRemove, DlgSettingsCurveProperties, DlgSettingsDigitizeCurve, DlgSettingsExportFormat, DlgSettingsGeneral, DlgSettingsGridRemoval, DlgSettingsMainWindow, DlgSettingsPointMatch, and DlgSettingsSegments.

enableOk()

void DlgSettingsAbstractBase::enableOk ( bool  enable )

protected

Let leaf subclass control the Ok button.

This method is separate from the subclasses' updateControls, rather than part of that method since updateControls is not aware of when it is called at startup - at which point the ok button should ALWAYS be disabled since there are not yet any changes. In other words, we call this method at startup to override the ok button state that was just set by updateControls

Note - if this method is called with a constant value of true from updateControls, one of two cases applies: 1) There are no constraints to worry about (like a required text field cannot be empty) 2) There are constraints, but they are already handled by validators and/or other constraint logic

Definition at line 51 of file DlgSettingsAbstractBase.cpp.

finishPanel()

void DlgSettingsAbstractBase::finishPanel ( QWidget *  subPanel )

protected

Add Ok and Cancel buttons to subpanel to get the whole dialog.

Definition at line 56 of file DlgSettingsAbstractBase.cpp.

handleOk()

virtual void DlgSettingsAbstractBase::handleOk ( )

protectedpure virtual

Process slotOk.

Implemented in DlgImportAdvanced, DlgSettingsAxesChecker, DlgSettingsColorFilter, DlgSettingsCoords, DlgSettingsCurveAddRemove, DlgSettingsCurveProperties, DlgSettingsDigitizeCurve, DlgSettingsExportFormat, DlgSettingsGeneral, DlgSettingsGridRemoval, DlgSettingsMainWindow, DlgSettingsPointMatch, and DlgSettingsSegments.

load()

virtual void DlgSettingsAbstractBase::load ( CmdMediator &  cmdMediator )

protectedpure virtual

Load settings from Document.

Implemented in DlgImportAdvanced, DlgSettingsAxesChecker, DlgSettingsColorFilter, DlgSettingsCoords, DlgSettingsCurveAddRemove, DlgSettingsCurveProperties, DlgSettingsDigitizeCurve, DlgSettingsExportFormat, DlgSettingsGeneral, DlgSettingsGridRemoval, DlgSettingsMainWindow, DlgSettingsPointMatch, and DlgSettingsSegments.

mainWindow() [1/2]

MainWindow & DlgSettingsAbstractBase::mainWindow ( )

protected

Get method for MainWindow.

Definition at line 98 of file DlgSettingsAbstractBase.cpp.

mainWindow() [2/2]

const MainWindow & DlgSettingsAbstractBase::mainWindow ( ) const

protected

Const get method for MainWindow.

Definition at line 103 of file DlgSettingsAbstractBase.cpp.

populateColorComboWithoutTransparent()

void DlgSettingsAbstractBase::populateColorComboWithoutTransparent ( QComboBox &  combo )

protected

Add colors in color palette to combobox, without transparent entry at end.

Definition at line 108 of file DlgSettingsAbstractBase.cpp.

populateColorComboWithTransparent()

void DlgSettingsAbstractBase::populateColorComboWithTransparent ( QComboBox &  combo )

protected

Add colors in color palette to combobox, with transparent entry at end.

Definition at line 128 of file DlgSettingsAbstractBase.cpp.

setCmdMediator()

void DlgSettingsAbstractBase::setCmdMediator ( CmdMediator &  cmdMediator )

protected

Store CmdMediator for easy access by the leaf class.

Definition at line 141 of file DlgSettingsAbstractBase.cpp.

setDisableOkAtStartup()

void DlgSettingsAbstractBase::setDisableOkAtStartup ( bool  disableOkAtStartup )

protected

Override the default Ok button behavior applied in showEvent.

Definition at line 146 of file DlgSettingsAbstractBase.cpp.

Member Data Documentation

MINIMUM_DIALOG_WIDTH

int DlgSettingsAbstractBase::MINIMUM_DIALOG_WIDTH = 350

staticprotected

Dialog layout constant that guarantees every widget has sufficient room.

Definition at line 57 of file DlgSettingsAbstractBase.h.

MINIMUM_PREVIEW_HEIGHT

int DlgSettingsAbstractBase::MINIMUM_PREVIEW_HEIGHT = 200

staticprotected

Dialog layout constant that guarantees preview has sufficent room.

Definition at line 60 of file DlgSettingsAbstractBase.h.

---

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

• Dlg/DlgSettingsAbstractBase.h
• Dlg/DlgSettingsAbstractBase.cpp