sf::MainWindowPropertyPage Class Reference

#include <MainWindowPropertyPage.h>

Inheritance diagram for sf::MainWindowPropertyPage:

Collaboration diagram for sf::MainWindowPropertyPage:

Public Member Functions
	MainWindowPropertyPage (MainWindow *main_window, QWidget *parent=nullptr)
	~MainWindowPropertyPage () override
QString	getPageName () const override
	Gets the name of the page for displaying in the list view. When reimplemented the QObject's name is returned.
QString	getPageDescription () const override
	Gets the description for hinting of the page in the list view.
QIcon	getPageIcon () const override
	Gets the icon of the page for displaying in the list view. Default it returns the sf::Resource settings icon.
void	updatePage () override
	Updates the control widgets of the page. This method is called to initialize the control widgets.
bool	isPageModified () const override
	Gets the modified/changed status of the page.
void	applyPage () override
	Applies the changes made in this page.
void	afterPageApply (bool was_modified) override
	Called when all pages are applied. Method can be overridden by a derived class to update control widgets that were changed because of other pages being applied.
Public Member Functions inherited from sf::PropertyPage
	PropertyPage (QWidget *parent)
	Constructor.
void	setPageIcon (const QIcon &)
	Sets the icon of the page for displaying in the list view.
void	setPageName (const QString &)
	Sets the page name icon of the page for displaying in the list view.
void	setPageDescription (const QString &)
	Sets the description for hinting of the page in the list view.
virtual bool	canApplyPage () const
	Allows validation of the changes made per page. First page which return false is selected.
PropertySheetDialog *	getSheet ()
	Gets the parent sheet of this page. (also the parent but cast.)
virtual void	storeState (ConfigStore &cfg_store, bool save)
	Called by sheet to save the state of the page. A call to QSettings::beginGroup() is not needed since it is done by the parent sheet already.

Additional Inherited Members
Protected Member Functions inherited from sf::PropertyPage
QWidgetList	connectControls ()
	Connects all known controls change signals to a handler which enables or disables buttons. A derived class should call this method when the is set up and controls are updated.
virtual void	connectIt (PropertySheetDialog *sheet, const QObject *object, QWidgetList &list)
	Connects all standard controls to the sf::PropertySheetDialog::checkModified() method. Is called recursively.
Protected Attributes inherited from sf::PropertyPage
PropertySheetDialog *	_sheet
	Holds the sheet it is part of and also its parent.
QString	_name
	Holds the name of the property page for when getPageName() is not overridden.
QString	_description
	Holds the description of the property page for when getPageDescription() is not overridden.
QIcon	_icon
	Holds the description of the property page for when getPageIcon() is not overridden.
friend	PropertySheetDialog

Constructor & Destructor Documentation

MainWindowPropertyPage()

sf::MainWindowPropertyPage::MainWindowPropertyPage ( MainWindow *  main_window, QWidget *  parent = nullptr  )

explicit

~MainWindowPropertyPage()

sf::MainWindowPropertyPage::~MainWindowPropertyPage ( )

override

Member Function Documentation

afterPageApply()

void sf::MainWindowPropertyPage::afterPageApply ( bool  was_modified )

overridevirtual

Called when all pages are applied. Method can be overridden by a derived class to update control widgets that were changed because of other pages being applied.

Parameters

was_modified

True when this page was modified.

Reimplemented from sf::PropertyPage.

applyPage()

void sf::MainWindowPropertyPage::applyPage ( )

overridevirtual

Applies the changes made in this page.

Reimplemented from sf::PropertyPage.

getPageDescription()

QString sf::MainWindowPropertyPage::getPageDescription ( ) const

overridevirtual

Gets the description for hinting of the page in the list view.

Reimplemented from sf::PropertyPage.

getPageIcon()

QIcon sf::MainWindowPropertyPage::getPageIcon ( ) const

overridevirtual

Gets the icon of the page for displaying in the list view. Default it returns the sf::Resource settings icon.

Reimplemented from sf::PropertyPage.

getPageName()

QString sf::MainWindowPropertyPage::getPageName ( ) const

overridevirtual

Gets the name of the page for displaying in the list view. When reimplemented the QObject's name is returned.

Reimplemented from sf::PropertyPage.

isPageModified()

bool sf::MainWindowPropertyPage::isPageModified ( ) const

overridevirtual

Gets the modified/changed status of the page.

Returns

True when modified.

Reimplemented from sf::PropertyPage.

updatePage()

void sf::MainWindowPropertyPage::updatePage ( )

overridevirtual

Updates the control widgets of the page. This method is called to initialize the control widgets.

Reimplemented from sf::PropertyPage.

---

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

• MainWindowPropertyPage.h