sf::PropertyPage Class Reference

Widget to create a page in a PropertySheet dialog. More...

#include <PropertyPage.h>

Inheritance diagram for sf::PropertyPage:

Collaboration diagram for sf::PropertyPage:

Public Member Functions
	PropertyPage (QWidget *parent)
	Constructor.
virtual QIcon	getPageIcon () const
	Gets the icon of the page for displaying in the list view. Default it returns the sf::Resource settings icon.
void	setPageIcon (const QIcon &)
	Sets the icon of the page for displaying in the list view.
virtual QString	getPageName () const
	Gets the name of the page for displaying in the list view. When reimplemented the QObject's name is returned.
void	setPageName (const QString &)
	Sets the page name icon of the page for displaying in the list view.
virtual QString	getPageDescription () const
	Gets the description for hinting of the page in the list view.
void	setPageDescription (const QString &)
	Sets the description for hinting of the page in the list view.
virtual void	updatePage ()
	Updates the control widgets of the page. This method is called to initialize the control widgets.
virtual bool	isPageModified () const
	Gets the modified/changed status of the page.
virtual bool	canApplyPage () const
	Allows validation of the changes made per page. First page which return false is selected.
virtual void	applyPage ()
	Applies the changes made in this page.
virtual void	afterPageApply (bool was_modified)
	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.
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.

Protected Member Functions
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
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

Detailed Description

Widget to create a page in a PropertySheet dialog.

Constructor & Destructor Documentation

PropertyPage()

sf::PropertyPage::PropertyPage ( QWidget *  parent )

explicit

Constructor.

Parameters

parent

Myst be a PropertySheetDialog pointer or derived one.

Member Function Documentation

afterPageApply()

virtual void sf::PropertyPage::afterPageApply ( bool  was_modified )

virtual

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 in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::ProjectPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::DefaultBinderPropertyPage, sf::ipj::LineScanMethodPropertyPage, sf::ipj::MeanderScanMethodPropertyPage, sf::ipj::ElementInfoPropertyPage, sf::ipj::NipscanTranslatePropertyPage, sf::ipj::ScanDepthPropertyPage, sf::ipj::ToolInfoPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, and sf::xgl::SceneServerPropertyPage.

applyPage()

virtual void sf::PropertyPage::applyPage ( )

virtual

Applies the changes made in this page.

Reimplemented in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::ContainerPropertyPage, sf::MiscellaneousPropertyPage, sf::PositionPropertyPage, sf::WidgetPropertyPage, sf::ProjectPropertyPage, sf::ScriptManagerPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::VariableIdPropertyPage, sf::GmiServerPropertyPage, sf::CustomFieldsPropertyPage, sf::MaterialPropertyPage, sf::ParamMappingPropertyPage, sf::ProjectDataPropertyPage, sf::ScanMethodConfigurationPropertyPage, sf::ScanMethodPositionPropertyPage, sf::BinderCommonPropertyPage, sf::CheckPositionsPropertyPage, sf::DefaultBinderConfigPropertyPage, sf::DefaultBinderProjectPropertyPage, sf::DefaultBinderPropertyPage, sf::ipj::CircleScanMethodPropertyPage, sf::ipj::LineScanMethodPropertyPage, sf::ipj::MeanderScanMethodPropertyPage, sf::ipj::ElementInfoPropertyPage, sf::ipj::ElementInfoFilerPropertyPage, sf::ipj::NipscanTranslatePropertyPage, sf::ipj::ScanDepthPropertyPage, sf::ipj::ToolInfoPropertyPage, sf::ipj::ToolInfoFilerPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, sf::xgl::SceneServerPropertyPage, sf::AcquisitionControlPropertyPage, sf::AscanPropertyPage, sf::BscanPropertyPage, and sf::LayoutButtonPropertyPage.

canApplyPage()

virtual bool sf::PropertyPage::canApplyPage ( ) const

virtual

Allows validation of the changes made per page. First page which return false is selected.

Reimplemented in sf::MiscellaneousPropertyPage, sf::ProjectPropertyPage, and sf::DefaultBinderPropertyPage.

connectControls()

QWidgetList sf::PropertyPage::connectControls ( )

protected

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.

Returns

List of not connected control widgets.

connectIt()

virtual void sf::PropertyPage::connectIt ( PropertySheetDialog *  sheet, const QObject *  object, QWidgetList &  list  )

protectedvirtual

Connects all standard controls to the sf::PropertySheetDialog::checkModified() method. Is called recursively.

Parameters

sheet	Dialog sheet the property page belongs to.
object	The object who children
list	Returns the list of non-connectable instances.

getPageDescription()

virtual QString sf::PropertyPage::getPageDescription ( ) const

virtual

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

Reimplemented in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::ContainerPropertyPage, sf::PositionPropertyPage, sf::ProjectPropertyPage, sf::ScriptManagerPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, and sf::xgl::SceneServerPropertyPage.

getPageIcon()

virtual QIcon sf::PropertyPage::getPageIcon ( ) const

virtual

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

Reimplemented in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::MiscellaneousPropertyPage, sf::PositionPropertyPage, sf::WidgetPropertyPage, sf::ProjectPropertyPage, sf::ScriptManagerPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::GmiServerPropertyPage, sf::ipj::CircleScanMethodPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, sf::xgl::SceneServerPropertyPage, sf::AcquisitionControlPropertyPage, and sf::BscanPropertyPage.

getPageName()

virtual QString sf::PropertyPage::getPageName ( ) const

virtual

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

Reimplemented in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::ContainerPropertyPage, sf::MiscellaneousPropertyPage, sf::PositionPropertyPage, sf::WidgetPropertyPage, sf::ProjectPropertyPage, sf::ScriptManagerPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::VariableIdPropertyPage, sf::GmiServerPropertyPage, sf::ipj::CircleScanMethodPropertyPage, sf::ipj::MeanderScanMethodPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, sf::xgl::SceneServerPropertyPage, sf::AcquisitionControlPropertyPage, sf::AscanPropertyPage, sf::BscanPropertyPage, and sf::LayoutButtonPropertyPage.

getSheet()

PropertySheetDialog * sf::PropertyPage::getSheet

(

)

Gets the parent sheet of this page. (also the parent but cast.)

isPageModified()

virtual bool sf::PropertyPage::isPageModified ( ) const

virtual

Gets the modified/changed status of the page.

Returns

True when modified.

Reimplemented in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::ContainerPropertyPage, sf::MiscellaneousPropertyPage, sf::PositionPropertyPage, sf::WidgetPropertyPage, sf::ProjectPropertyPage, sf::ScriptManagerPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::VariableIdPropertyPage, sf::GmiServerPropertyPage, sf::CustomFieldsPropertyPage, sf::MaterialPropertyPage, sf::ParamMappingPropertyPage, sf::ProjectDataPropertyPage, sf::ScanMethodConfigurationPropertyPage, sf::ScanMethodPositionPropertyPage, sf::BinderCommonPropertyPage, sf::CheckPositionsPropertyPage, sf::DefaultBinderConfigPropertyPage, sf::DefaultBinderProjectPropertyPage, sf::DefaultBinderPropertyPage, sf::ipj::CircleScanMethodPropertyPage, sf::ipj::LineScanMethodPropertyPage, sf::ipj::MeanderScanMethodPropertyPage, sf::ipj::ElementInfoPropertyPage, sf::ipj::NipscanTranslatePropertyPage, sf::ipj::ScanDepthPropertyPage, sf::ipj::ToolInfoPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, sf::xgl::SceneServerPropertyPage, sf::AcquisitionControlPropertyPage, sf::AscanPropertyPage, sf::BscanPropertyPage, and sf::LayoutButtonPropertyPage.

setPageDescription()

void sf::PropertyPage::setPageDescription

(

const QString &

)

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

setPageIcon()

void sf::PropertyPage::setPageIcon

(

const QIcon &

)

Sets the icon of the page for displaying in the list view.

setPageName()

void sf::PropertyPage::setPageName

(

const QString &

)

Sets the page name icon of the page for displaying in the list view.

storeState()

virtual void sf::PropertyPage::storeState ( ConfigStore &  cfg_store, bool  save  )

virtual

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.

Reimplemented in sf::LayoutEditorPropertyPage, sf::WidgetPropertyPage, sf::UnitConversionPropertyPage, sf::CustomFieldsPropertyPage, sf::ParamMappingPropertyPage, sf::ProjectDataPropertyPage, sf::CheckPositionsPropertyPage, and sf::ipj::CircleScanMethodPropertyPage.

updatePage()

virtual void sf::PropertyPage::updatePage ( )

virtual

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

Reimplemented in sf::ApplicationPropertyPage, sf::MainWindowPropertyPage, sf::LayoutEditorPropertyPage, sf::ContainerPropertyPage, sf::MiscellaneousPropertyPage, sf::PositionPropertyPage, sf::WidgetPropertyPage, sf::ProjectPropertyPage, sf::ScriptManagerPropertyPage, sf::ServicePropertyPage, sf::UnitConversionPropertyPage, sf::VariableIdPropertyPage, sf::GmiServerPropertyPage, sf::CustomFieldsPropertyPage, sf::MaterialPropertyPage, sf::ParamMappingPropertyPage, sf::ProjectDataPropertyPage, sf::ScanMethodConfigurationPropertyPage, sf::ScanMethodPositionPropertyPage, sf::BinderCommonPropertyPage, sf::CheckPositionsPropertyPage, sf::DefaultBinderConfigPropertyPage, sf::DefaultBinderProjectPropertyPage, sf::DefaultBinderPropertyPage, sf::ipj::CircleScanMethodPropertyPage, sf::ipj::LineScanMethodPropertyPage, sf::ipj::MeanderScanMethodPropertyPage, sf::ipj::ElementInfoPropertyPage, sf::ipj::NipscanTranslatePropertyPage, sf::ipj::ScanDepthPropertyPage, sf::ipj::ToolInfoPropertyPage, sf::EditorPropertyPage, sf::PaletteServerPropertyPage, sf::xgl::SceneServerPropertyPage, sf::AcquisitionControlPropertyPage, sf::AscanPropertyPage, sf::BscanPropertyPage, and sf::LayoutButtonPropertyPage.

Member Data Documentation

_description

QString sf::PropertyPage::_description

protected

Holds the description of the property page for when getPageDescription() is not overridden.

_icon

QIcon sf::PropertyPage::_icon

protected

Holds the description of the property page for when getPageIcon() is not overridden.

_name

QString sf::PropertyPage::_name

protected

Holds the name of the property page for when getPageName() is not overridden.

_sheet

PropertySheetDialog* sf::PropertyPage::_sheet

protected

Holds the sheet it is part of and also its parent.

PropertySheetDialog

friend sf::PropertyPage::PropertySheetDialog

protected

---

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

• PropertyPage.h