QGIS API Documentation  2.5.0-Master
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules 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]

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

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
QgsOptionsDialogBase::~QgsOptionsDialogBase ( )

Member Function Documentation

bool QgsOptionsDialogBase::iconOnly ( )
inline

determine if the options list is in icon only mode

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
void QgsOptionsDialogBase::optionsStackedWidget_CurrentChanged ( int  indx)
protectedslot
void QgsOptionsDialogBase::optionsStackedWidget_WidgetRemoved ( int  indx)
protectedslot
void QgsOptionsDialogBase::paintEvent ( QPaintEvent *  e)
protected
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();
void QgsOptionsDialogBase::setSettings ( QSettings *  settings)
void QgsOptionsDialogBase::showEvent ( QShowEvent *  e)
protected
void QgsOptionsDialogBase::updateOptionsListVerticalTabs ( )
protectedslot
void QgsOptionsDialogBase::updateWindowTitle ( )
protectedvirtual
void QgsOptionsDialogBase::warnAboutMissingObjects ( )
protectedslot

Member Data Documentation

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

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