QGIS API Documentation  2.2.0-Valmiera
 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>

Public Member Functions

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

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

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

added in 1.9

Definition at line 47 of file qgsoptionsdialogbase.h.

Constructor & Destructor Documentation

QgsOptionsDialogBase::QgsOptionsDialogBase ( QString  settingsKey,
QWidget *  parent = 0,
Qt::WFlags  fl = 0 


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

Definition at line 31 of file qgsoptionsdialogbase.cpp.

QgsOptionsDialogBase::~QgsOptionsDialogBase ( )

Definition at line 39 of file qgsoptionsdialogbase.cpp.

References mInit, mOptsKey, mOptSplitter, and mOptStackedWidget.

Member Function Documentation

bool QgsOptionsDialogBase::iconOnly ( )

determine if the options list is in icon only mode

Definition at line 74 of file qgsoptionsdialogbase.h.

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

Set up the base ui connections for vertical tabs.

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

Definition at line 50 of file qgsoptionsdialogbase.cpp.

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

void QgsOptionsDialogBase::optionsStackedWidget_CurrentChanged ( int  indx)

Definition at line 240 of file qgsoptionsdialogbase.cpp.

References mOptListWidget, and updateWindowTitle().

Referenced by initOptionsBase(), and showEvent().

void QgsOptionsDialogBase::optionsStackedWidget_WidgetRemoved ( int  indx)

Definition at line 249 of file qgsoptionsdialogbase.cpp.

References mOptListWidget.

Referenced by initOptionsBase().

void QgsOptionsDialogBase::paintEvent ( QPaintEvent *  e)

Definition at line 183 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.

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

Definition at line 118 of file qgsoptionsdialogbase.cpp.

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

Referenced by initOptionsBase().

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

Definition at line 204 of file qgsoptionsdialogbase.cpp.

References mIconOnly, mInit, mOptListWidget, and mOptSplitter.

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

void QgsOptionsDialogBase::updateWindowTitle ( )
void QgsOptionsDialogBase::warnAboutMissingObjects ( )

Definition at line 255 of file qgsoptionsdialogbase.cpp.

References tr.

Referenced by showEvent().

Member Data Documentation

QString QgsOptionsDialogBase::mDialogTitle

Definition at line 94 of file qgsoptionsdialogbase.h.

Referenced by initOptionsBase(), restoreOptionsBaseUi(), and updateWindowTitle().

bool QgsOptionsDialogBase::mIconOnly

Definition at line 95 of file qgsoptionsdialogbase.h.

Referenced by updateOptionsListVerticalTabs().

bool QgsOptionsDialogBase::mInit
QDialogButtonBox* QgsOptionsDialogBase::mOptButtonBox

Definition at line 93 of file qgsoptionsdialogbase.h.

Referenced by initOptionsBase().

QListWidget* QgsOptionsDialogBase::mOptListWidget
QString QgsOptionsDialogBase::mOptsKey

Definition at line 88 of file qgsoptionsdialogbase.h.

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

QSplitter* QgsOptionsDialogBase::mOptSplitter
QStackedWidget* QgsOptionsDialogBase::mOptStackedWidget

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