Qtilities::CoreGui::GroupedConfigPage Class Reference

A config page which groups other IConfigPage pages using tabs. More...

#include <GroupedConfigPage.h>

Inheritance diagram for Qtilities::CoreGui::GroupedConfigPage:

List of all members.

Signals
void	activeGroupedPageChanged (IConfigPage *config_page)
	Signal emitted whenever the active config page in the group changes.
void	appliedPage (IConfigPage *conig_page)
	Signal emitted whenever a config page is applied.

Public Member Functions
IConfigPage *	activePage () const
	Returns the current active config page.
void	addConfigPage (IConfigPage *page)
	Adds a IConfigPage to this grouping.
QtilitiesCategory	category () const
	Returns the category of this grouped page.
void	configPageApply ()
	Indicates that the current state of the config page must be saved (applied).
QtilitiesCategory	configPageCategory () const
	Gets the category of the config page.
QIcon	configPageIcon () const
	Gets the icon used for the page in the configuration widget.
QStringList	configPageNames () const
	Returns a list of names of all config pages in this grouping.
QList< IConfigPage * >	configPages () const
	Returns a list of all config pages in this grouping.
QString	configPageTitle () const
	Gets the title of the config page.
QWidget *	configPageWidget ()
	Gets widget used in the configuration page area.
IConfigPage *	getConfigPage (const QString &page_title) const
	Gets a IConfigPage with the given title.
bool	hasConfigPage (IConfigPage *page) const
	Checks if a page exists in this grouping.
bool	hasConfigPage (const QString &page_title) const
	Checks if a page exists in this grouping, specified by the title of the page.
QObject *	objectBase ()
	Returns the QObject* base of the interface.
const QObject *	objectBase () const
	Returns a const QObject* base of the interface.
void	removeConfigPage (IConfigPage *page)
	Removes a IConfigPage from this grouping.
void	setActivePage (IConfigPage *page)
	Sets the current active page.
void	setActivePage (const QString &page_title)
	Sets the current active page, specified by the title of the page.
void	setApplyAll (bool apply_all)
	Sets that this grouped widget must apply all its tabbed pages on an apply.
void	setConfigPageIcon (const QIcon &icon)
	Sets the icon used for the page in the configuration widget.
void	setUseTabIcons (bool use_tab_icons)
	Sets if tabs should use icons of individual config pages.
bool	supportsApply () const
	Indicates if the page supports apply operations. When a page only displays information, ExtensionSystemConfig, we don't want the apply button to be active. This function thus controls the activity of the apply button.
bool	useTabIcons () const
	Gets if tabs should use icons of individual config pages.
Public Member Functions inherited from Qtilities::CoreGui::Interfaces::IConfigPage
virtual QString	configPageHelpID () const
	Gets the help ID of the config page.
virtual void	configPageInitialize ()
	Initialization function where you can do any initialization required by your page.
virtual void	configPageRestoreDefaults ()
	Indicates that the defaults of the page must be restored.
virtual void	setConfigPageCategory (const QtilitiesCategory &category)
	Sets the category of the config page.
virtual void	setConfigPageHelpID (const QString &config_help_id)
	Sets the help ID of the config page.
virtual bool	supportsRestoreDefaults () const
	Indicates if the page supports restoration of default settings.
Public Member Functions inherited from Qtilities::Core::Interfaces::IObjectBase
QString	objectOriginID () const
	Allows interfaces to provide some sort of source identification.
void	setObjectOriginID (const QString &object_origin_id)
	Allows setting of the object source ID of this interface implementation.

---

Detailed Description

A config page which groups other IConfigPage pages using tabs.

This class was added in Qtilities v1.1.

---

Member Function Documentation

QtilitiesCategory Qtilities::CoreGui::GroupedConfigPage::configPageCategory ( ) const

virtual

Gets the category of the config page.

If you want other parts of your code to be able to modify the category of your page, implement configPageCategory() like this:

if (IConfigPage::configPageCategory().isEmpty())
    return QtilitiesCategory("Your Category");
else
    return IConfigPage::configPageCategory();

If not, just return your caregory.

See also:

setConfigPageCategory()

Reimplemented from Qtilities::CoreGui::Interfaces::IConfigPage.

QIcon Qtilities::CoreGui::GroupedConfigPage::configPageIcon ( ) const

virtual

Gets the icon used for the page in the configuration widget.

See also:

setConfigPageIcon()

Implements Qtilities::CoreGui::Interfaces::IConfigPage.

const QObject* Qtilities::CoreGui::GroupedConfigPage::objectBase ( ) const

inlinevirtual

Returns a const QObject* base of the interface.

This function can be used in const methods, but make sure that you don't modify things that should stay const. An example where this is used is when we want to get a property on an object in a const method. This is a const operation.

Implements Qtilities::Core::Interfaces::IObjectBase.

void Qtilities::CoreGui::GroupedConfigPage::setConfigPageIcon ( const QIcon &  icon )

virtual

Sets the icon used for the page in the configuration widget.

Note:

The default implementation does nothing.

See also:

configPageIcon()

This function was added in Qtilities v1.1.

Reimplemented from Qtilities::CoreGui::Interfaces::IConfigPage.

bool Qtilities::CoreGui::GroupedConfigPage::useTabIcons

(

)

const

Gets if tabs should use icons of individual config pages.

False by default.