DlgSettingsAbstractBase Class Reference

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

#include <DlgSettingsAbstractBase.h>

Inheritance diagram for DlgSettingsAbstractBase:

Collaboration diagram for DlgSettingsAbstractBase:

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

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

Static Protected Attributes
static int	MINIMUM_DIALOG_WIDTH = 380
	Dialog layout constant that guarantees every widget has sufficient room. Can be increased by finishPanel. More...
static int	MINIMUM_PREVIEW_HEIGHT = 100
	Dialog layout constant that guarantees preview has sufficent room. More...

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 23 of file DlgSettingsAbstractBase.cpp.

                                                                         :
  QDialog (&mainWindow),
  m_mainWindow (mainWindow),
  m_cmdMediator (nullptr),
  m_dialogName (dialogName),
  m_disableOkAtStartup (true)
{
  LOG4CPP_INFO_S ((*mainCat)) << "DlgSettingsAbstractBase::DlgSettingsAbstractBase"
                              << " name=" << m_dialogName.toLatin1().data();
 
  setWindowTitle (title);
  setModal (true);

~DlgSettingsAbstractBase()

DlgSettingsAbstractBase::~DlgSettingsAbstractBase ( )

virtual

Definition at line 39 of file DlgSettingsAbstractBase.cpp.

{
  LOG4CPP_INFO_S ((*mainCat)) << "DlgSettingsAbstractBase::~DlgSettingsAbstractBase"
                              << " name=" << m_dialogName.toLatin1().data();

Member Function Documentation

cmdMediator()

CmdMediator & DlgSettingsAbstractBase::cmdMediator ( )

protected

Provide access to Document information wrapped inside CmdMediator.

Definition at line 45 of file DlgSettingsAbstractBase.cpp.

{
  ENGAUGE_CHECK_PTR (m_cmdMediator);
 
  return *m_cmdMediator;

createOptionalSaveDefault()

virtual void DlgSettingsAbstractBase::createOptionalSaveDefault ( QHBoxLayout *  layout )

protectedpure virtual

Let subclass define an optional Save As Default button.

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

createSubPanel()

virtual QWidget* DlgSettingsAbstractBase::createSubPanel ( )

protectedpure virtual

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

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

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 52 of file DlgSettingsAbstractBase.cpp.

{
  m_btnOk->setEnabled (enable);

finishPanel()

void DlgSettingsAbstractBase::finishPanel ( QWidget *  subPanel, int  minimumWidth = MINIMUM_DIALOG_WIDTH, int  minimumHeightOrZero = 0  )

protected

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

Definition at line 57 of file DlgSettingsAbstractBase.cpp.

{
  const int STRETCH_OFF = 0, STRETCH_ON = 1;
 
  m_scroll = new QScrollArea (this);
  m_scroll->setStyleSheet ("QScrollArea { border: 0; margin: 0; padding: 0;}"); // Need QScrollArea or interior frames are affected    
  m_scroll->setHorizontalScrollBarPolicy (Qt::ScrollBarAlwaysOff);
  m_scroll->setVerticalScrollBarPolicy (Qt::ScrollBarAsNeeded);
  m_scroll->setSizePolicy (QSizePolicy::Minimum,
                           QSizePolicy::Minimum);
  m_scroll->setMinimumWidth (minimumWidth);
 
  QWidget *viewport = new QWidget (this);
  m_scroll->setWidget (viewport);
  m_scroll->setWidgetResizable (true);
 
  QHBoxLayout *scrollLayout = new QHBoxLayout (this);
  scrollLayout->addWidget (m_scroll);
  setLayout (scrollLayout);
  
  QVBoxLayout *panelLayout = new QVBoxLayout (viewport);
  viewport->setLayout (panelLayout);
 
  panelLayout->addWidget (subPanel);
  panelLayout->setStretch (panelLayout->count () - 1, STRETCH_ON);
 
  QWidget *panelButtons = new QWidget (this);
  QHBoxLayout *buttonLayout = new QHBoxLayout (panelButtons);
 
  createOptionalSaveDefault(buttonLayout);
 
  QHBoxLayout *layoutRightSide = new QHBoxLayout;
 
  QWidget *widgetRightSide = new QWidget;
  widgetRightSide->setLayout (layoutRightSide);
  buttonLayout->addWidget (widgetRightSide);
 
  QSpacerItem *spacerExpanding = new QSpacerItem (40, 5, QSizePolicy::Expanding, QSizePolicy::Expanding);
  layoutRightSide->addItem (spacerExpanding);
 
  m_btnOk = new QPushButton (tr ("Ok"));
  m_btnOk->setEnabled (false); // Nothing to save initially
  layoutRightSide->addWidget (m_btnOk, 0, Qt::AlignRight);
  connect (m_btnOk, SIGNAL (released ()), this, SLOT (slotOk ()));
 
  QSpacerItem *spacerFixed = new QSpacerItem (40, 5, QSizePolicy::Fixed, QSizePolicy::Fixed);
  layoutRightSide->addItem (spacerFixed);
 
  m_btnCancel = new QPushButton (tr ("Cancel"));
  layoutRightSide->addWidget (m_btnCancel, 0, Qt::AlignRight);
  connect (m_btnCancel, SIGNAL (released ()), this, SLOT (slotCancel ()));
 
  panelLayout->addWidget (panelButtons, STRETCH_ON);
  panelLayout->setStretch (panelLayout->count () - 1, STRETCH_OFF);
 
  setSizePolicy (QSizePolicy::Minimum,
                 QSizePolicy::Minimum);
 
  if (minimumHeightOrZero > 0) {
     m_scroll->setMinimumHeight (minimumHeightOrZero);
  }

handleOk()

virtual void DlgSettingsAbstractBase::handleOk ( )

protectedpure virtual

Process slotOk.

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

load()

virtual void DlgSettingsAbstractBase::load ( CmdMediator &  cmdMediator )

protectedpure virtual

Load settings from Document.

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

mainWindow() [1/2]

MainWindow & DlgSettingsAbstractBase::mainWindow ( )

protected

Get method for MainWindow.

Definition at line 122 of file DlgSettingsAbstractBase.cpp.

{
  return m_mainWindow;

mainWindow() [2/2]

const MainWindow & DlgSettingsAbstractBase::mainWindow ( ) const

protected

Const get method for MainWindow.

Definition at line 127 of file DlgSettingsAbstractBase.cpp.

{
  return m_mainWindow;

populateColorComboWithoutTransparent()

void DlgSettingsAbstractBase::populateColorComboWithoutTransparent ( QComboBox &  combo )

protected

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

Definition at line 132 of file DlgSettingsAbstractBase.cpp.

{
  combo.addItem (colorPaletteToString (COLOR_PALETTE_BLUE),
                 QVariant (COLOR_PALETTE_BLUE));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_BLACK),
                 QVariant (COLOR_PALETTE_BLACK));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_CYAN),
                 QVariant (COLOR_PALETTE_CYAN));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_GOLD),
                 QVariant (COLOR_PALETTE_GOLD));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_GREEN),
                 QVariant (COLOR_PALETTE_GREEN));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_MAGENTA),
                 QVariant (COLOR_PALETTE_MAGENTA));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_RED),
                 QVariant (COLOR_PALETTE_RED));
  combo.addItem (colorPaletteToString (COLOR_PALETTE_YELLOW),
                 QVariant (COLOR_PALETTE_YELLOW));

populateColorComboWithTransparent()

void DlgSettingsAbstractBase::populateColorComboWithTransparent ( QComboBox &  combo )

protected

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

Definition at line 152 of file DlgSettingsAbstractBase.cpp.

{
  populateColorComboWithoutTransparent (combo);
  combo.addItem ("Transparent", QVariant (COLOR_PALETTE_TRANSPARENT));

setCmdMediator()

void DlgSettingsAbstractBase::setCmdMediator ( CmdMediator &  cmdMediator )

protected

Store CmdMediator for easy access by the leaf class.

Definition at line 165 of file DlgSettingsAbstractBase.cpp.

{
  m_cmdMediator = &cmdMediator;

setDisableOkAtStartup()

void DlgSettingsAbstractBase::setDisableOkAtStartup ( bool  disableOkAtStartup )

protected

Override the default Ok button behavior applied in showEvent.

Definition at line 170 of file DlgSettingsAbstractBase.cpp.

{
  m_disableOkAtStartup = disableOkAtStartup;

setSmallDialogs()

virtual void DlgSettingsAbstractBase::setSmallDialogs ( bool  smallDialogs )

protectedpure virtual

If false then dialogs have a minimum size so all controls are visible.

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

Member Data Documentation

MINIMUM_DIALOG_WIDTH

int DlgSettingsAbstractBase::MINIMUM_DIALOG_WIDTH = 380

staticprotected

Dialog layout constant that guarantees every widget has sufficient room. Can be increased by finishPanel.

Definition at line 62 of file DlgSettingsAbstractBase.h.

MINIMUM_PREVIEW_HEIGHT

int DlgSettingsAbstractBase::MINIMUM_PREVIEW_HEIGHT = 100

staticprotected

Dialog layout constant that guarantees preview has sufficent room.

Definition at line 65 of file DlgSettingsAbstractBase.h.

---

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

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