QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Protected Slots | Protected Member Functions | Protected Attributes | List of all members
QgsOptionsDialogBase Class Reference

A base dialog for options and properties dialogs that offers vertical tabs. More...

#include <qgsoptionsdialogbase.h>

Inheritance diagram for QgsOptionsDialogBase:
Inheritance graph
[legend]
Collaboration diagram for QgsOptionsDialogBase:
Collaboration graph
[legend]

Public Member Functions

 QgsOptionsDialogBase (QString settingsKey, QWidget *parent=0, Qt::WindowFlags fl=0, QSettings *settings=0)
 Constructor. More...
 
 ~QgsOptionsDialogBase ()
 
void initOptionsBase (bool restoreUi=true, QString title=QString())
 Set up the base ui connections for vertical tabs. More...
 
void setSettings (QSettings *settings)
 
void restoreOptionsBaseUi (QString title=QString())
 Restore the base ui. More...
 
bool iconOnly ()
 determine if the options list is in icon only mode More...
 

Protected Slots

void updateOptionsListVerticalTabs ()
 
void optionsStackedWidget_CurrentChanged (int indx)
 
void optionsStackedWidget_WidgetRemoved (int indx)
 
void warnAboutMissingObjects ()
 

Protected Member Functions

void showEvent (QShowEvent *e)
 
void paintEvent (QPaintEvent *e)
 
virtual void updateWindowTitle ()
 

Protected Attributes

QString mOptsKey
 
bool mInit
 
QListWidget * mOptListWidget
 
QStackedWidget * mOptStackedWidget
 
QSplitter * mOptSplitter
 
QDialogButtonBox * mOptButtonBox
 
QString mDialogTitle
 
bool mIconOnly
 
QPointer< QSettings > mSettings
 
bool mDelSettings
 

Detailed Description

A base dialog for options and properties dialogs that offers vertical tabs.

It handles saving/restoring of geometry, splitter and current tab states, switching vertical tabs between icon/text to icon-only modes (splitter collapsed to left), and connecting QDialogButtonBox's accepted/rejected signals to dialog's accept/reject slots

To use: 1) Start with copy of qgsoptionsdialog_template.ui and build options/properties dialog. 2) In source file for dialog, inherit this class instead of QDialog, then in constructor: ... setupUi( this ); // set up .ui file objects initOptionsBase( false ); // set up this class to use .ui objects, optionally restoring base ui ... restoreOptionsBaseUi(); // restore the base ui with initOptionsBase or use this later on

Note
added in 1.9

Definition at line 49 of file qgsoptionsdialogbase.h.

Constructor & Destructor Documentation

QgsOptionsDialogBase::QgsOptionsDialogBase ( QString  settingsKey,
QWidget *  parent = 0,
Qt::WindowFlags  fl = 0,
QSettings *  settings = 0 
)

Constructor.

Parameters
settingsKeyQSettings subgroup key for saving/restore ui states, e.g. "ProjectProperties".
parentparent object (owner)
flwidget flags
settingscustom QSettings pointer

Definition at line 30 of file qgsoptionsdialogbase.cpp.

QgsOptionsDialogBase::~QgsOptionsDialogBase ( )

Member Function Documentation

bool QgsOptionsDialogBase::iconOnly ( )
inline

determine if the options list is in icon only mode

Definition at line 80 of file qgsoptionsdialogbase.h.

void QgsOptionsDialogBase::initOptionsBase ( bool  restoreUi = true,
QString  title = QString() 
)

Set up the base ui connections for vertical tabs.

Parameters
restoreUiWhether to restore the base ui at this time.
titlethe window title

Definition at line 56 of file qgsoptionsdialogbase.cpp.

References mDelSettings, mDialogTitle, mInit, mOptButtonBox, mOptListWidget, mOptSplitter, mOptStackedWidget, mSettings, optionsStackedWidget_CurrentChanged(), optionsStackedWidget_WidgetRemoved(), restoreOptionsBaseUi(), size, and updateOptionsListVerticalTabs().

void QgsOptionsDialogBase::optionsStackedWidget_CurrentChanged ( int  indx)
protectedslot

Definition at line 265 of file qgsoptionsdialogbase.cpp.

References mOptListWidget, and updateWindowTitle().

Referenced by initOptionsBase(), and showEvent().

void QgsOptionsDialogBase::optionsStackedWidget_WidgetRemoved ( int  indx)
protectedslot

Definition at line 274 of file qgsoptionsdialogbase.cpp.

References mOptListWidget.

Referenced by initOptionsBase().

void QgsOptionsDialogBase::paintEvent ( QPaintEvent *  e)
protected

Definition at line 208 of file qgsoptionsdialogbase.cpp.

References mInit, and updateOptionsListVerticalTabs().

void QgsOptionsDialogBase::restoreOptionsBaseUi ( QString  title = QString())

Restore the base ui.

Sometimes useful to do at end of subclass's constructor.

Parameters
titlethe window title (it does not need to be defined if previously given to initOptionsBase();

Definition at line 144 of file qgsoptionsdialogbase.cpp.

References mDialogTitle, mInit, mOptListWidget, mOptsKey, mOptSplitter, mOptStackedWidget, mSettings, and updateWindowTitle().

Referenced by initOptionsBase().

void QgsOptionsDialogBase::setSettings ( QSettings *  settings)

Definition at line 133 of file qgsoptionsdialogbase.cpp.

References mDelSettings, and mSettings.

void QgsOptionsDialogBase::showEvent ( QShowEvent *  e)
protected
void QgsOptionsDialogBase::updateOptionsListVerticalTabs ( )
protectedslot

Definition at line 229 of file qgsoptionsdialogbase.cpp.

References mIconOnly, mInit, mOptListWidget, and mOptSplitter.

Referenced by initOptionsBase(), paintEvent(), and showEvent().

void QgsOptionsDialogBase::updateWindowTitle ( )
protectedvirtual
void QgsOptionsDialogBase::warnAboutMissingObjects ( )
protectedslot

Definition at line 280 of file qgsoptionsdialogbase.cpp.

References tr.

Referenced by showEvent().

Member Data Documentation

bool QgsOptionsDialogBase::mDelSettings
protected

Definition at line 105 of file qgsoptionsdialogbase.h.

Referenced by initOptionsBase(), setSettings(), and ~QgsOptionsDialogBase().

QString QgsOptionsDialogBase::mDialogTitle
protected
bool QgsOptionsDialogBase::mIconOnly
protected

Definition at line 101 of file qgsoptionsdialogbase.h.

Referenced by updateOptionsListVerticalTabs().

bool QgsOptionsDialogBase::mInit
protected
QDialogButtonBox* QgsOptionsDialogBase::mOptButtonBox
protected

Definition at line 99 of file qgsoptionsdialogbase.h.

Referenced by initOptionsBase().

QListWidget* QgsOptionsDialogBase::mOptListWidget
protected
QString QgsOptionsDialogBase::mOptsKey
protected

Definition at line 94 of file qgsoptionsdialogbase.h.

Referenced by restoreOptionsBaseUi(), and ~QgsOptionsDialogBase().

QSplitter* QgsOptionsDialogBase::mOptSplitter
protected
QStackedWidget* QgsOptionsDialogBase::mOptStackedWidget
protected
QPointer<QSettings> QgsOptionsDialogBase::mSettings
protected

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