Home · Modules · Classes · Namespaces · Functions

QxtConfigWidget Class Reference
[QxtGui module]

The QxtConfigWidget class provides a configuration widget. More...

    #include <QxtConfigWidget>

Inherits QWidget.

Public Types

Public Functions

Public Slots

Signals

Protected Functions

Additional Inherited Members


Detailed Description

The QxtConfigWidget class provides a configuration widget.

QxtConfigWidget provides a convenient interface for building common configuration views. QxtConfigWidget consists of a list of icons and a stack of pages.

See also QxtConfigDialog.


Member Type Documentation

enum QxtConfigWidget::IconPosition

This enum describes the page icon position.

ConstantValueDescription
QxtConfigWidget::North0The icons are located above the pages.
QxtConfigWidget::West1The icons are located to the left of the pages.
QxtConfigWidget::East2The icons are located to the right of the pages.


Member Function Documentation

QxtConfigWidget::QxtConfigWidget ( QWidget * parent = 0, Qt::WindowFlags flags = 0 )

Constructs a new QxtConfigWidget with parent and flags.

QxtConfigWidget::QxtConfigWidget ( QxtConfigWidget::IconPosition position, QWidget * parent = 0, Qt::WindowFlags flags = 0 )

Constructs a new QxtConfigWidget with icon position, parent and flags.

QxtConfigWidget::~QxtConfigWidget ()   [virtual]

Destructs the config widget.

void QxtConfigWidget::accept ()   [virtual slot]

Note: The default implementation calls SLOT(accept()) of each page page provided that such slot exists.

See also reject().

int QxtConfigWidget::addPage ( QWidget * page, const QIcon & icon, const QString & title = QString() )

Adds a page with icon and title.

In case title is an empty string, QWidget::windowTitle of page is used.

Returns the index of added page.

Warning: Adding and removing pages dynamically at run time might cause flicker.

See also insertPage().

void QxtConfigWidget::cleanupPage ( int index )   [virtual protected]

This virtual function is called to clean up previous page at index before switching to a new page.

Note: The default implementation calls SLOT(cleanup()) of the corresponding page provided that such slot exists.

See also initializePage().

int QxtConfigWidget::count () const

int QxtConfigWidget::currentIndex () const

See also setCurrentIndex().

void QxtConfigWidget::currentIndexChanged ( int index )   [signal]

This signal is emitted whenever the current page index changes.

See also currentIndex().

QWidget * QxtConfigWidget::currentPage () const

Returns the current page.

See also currentIndex() and setCurrentPage().

bool QxtConfigWidget::hasHoverEffect () const

QxtConfigWidget::IconPosition QxtConfigWidget::iconPosition () const

See also setIconPosition().

QSize QxtConfigWidget::iconSize () const

See also setIconSize().

int QxtConfigWidget::indexOf ( QWidget * page ) const

Returns the index of page or -1 if the page is unknown.

void QxtConfigWidget::initializePage ( int index )   [virtual protected]

This virtual function is called to initialize page at index before switching to it.

Note: The default implementation calls SLOT(initialize()) of the corresponding page provided that such slot exists.

See also cleanupPage().

int QxtConfigWidget::insertPage ( int index, QWidget * page, const QIcon & icon, const QString & title = QString() )

Inserts a page with icon and title at index.

In case title is an empty string, QWidget::windowTitle of page is used.

Returns the index of inserted page.

Warning: Inserting and removing pages dynamically at run time might cause flicker.

See also addPage().

bool QxtConfigWidget::isPageEnabled ( int index ) const

Returns true if the page at index is enabled; otherwise false.

See also setPageEnabled().

bool QxtConfigWidget::isPageHidden ( int index ) const

Returns true if the page at index is hidden; otherwise false.

See also setPageHidden().

QWidget * QxtConfigWidget::page ( int index ) const

Returns the page at index or 0 if the index is out of range.

QIcon QxtConfigWidget::pageIcon ( int index ) const

Returns the icon of page at index.

See also setPageIcon().

QString QxtConfigWidget::pageTitle ( int index ) const

Returns the title of page at index.

See also setPageTitle().

QString QxtConfigWidget::pageToolTip ( int index ) const

Returns the tooltip of page at index.

See also setPageToolTip().

QString QxtConfigWidget::pageWhatsThis ( int index ) const

Returns the what's this of page at index.

See also setPageWhatsThis().

void QxtConfigWidget::reject ()   [virtual slot]

Note: The default implementation calls SLOT(reject()) of each page provided that such slot exists.

See also accept().

void QxtConfigWidget::setCurrentIndex ( int index )   [slot]

See also currentIndex().

void QxtConfigWidget::setCurrentPage ( QWidget * page )   [slot]

Sets the current page.

See also currentPage() and currentIndex().

void QxtConfigWidget::setHoverEffect ( bool enabled )

See also hasHoverEffect().

void QxtConfigWidget::setIconPosition ( QxtConfigWidget::IconPosition position )

See also iconPosition().

void QxtConfigWidget::setIconSize ( const QSize & size )

See also iconSize().

void QxtConfigWidget::setPageEnabled ( int index, bool enabled )

Sets the page at index enabled. The corresponding page icon is also enabled.

See also isPageEnabled().

void QxtConfigWidget::setPageHidden ( int index, bool hidden )

Sets the page at index hidden. The corresponding page icon is also hidden.

See also isPageHidden().

void QxtConfigWidget::setPageIcon ( int index, const QIcon & icon )

Sets the icon of page at index.

See also pageIcon().

void QxtConfigWidget::setPageTitle ( int index, const QString & title )

Sets the title of page at index.

See also pageTitle().

void QxtConfigWidget::setPageToolTip ( int index, const QString & tooltip )

Sets the tooltip of page at index.

See also pageToolTip().

void QxtConfigWidget::setPageWhatsThis ( int index, const QString & whatsthis )

Sets the whatsthis of page at index.

See also pageWhatsThis().

QStackedWidget * QxtConfigWidget::stackedWidget () const   [protected]

Returns the internal stacked widget used for stacking pages.

See also tableWidget().

QTableWidget * QxtConfigWidget::tableWidget () const   [protected]

Returns the internal table widget used for showing page icons.

See also stackedWidget().

QWidget * QxtConfigWidget::takePage ( int index )

Removes the page at index and returns it.

Note: Does not delete the page widget.


Copyright © 2007-2011 Qxt Foundation
Qxt 0.6.2