Updraft  1.0
Open source glider flight visualisation tool.
Updraft::SettingInterface Class Reference

Interface to a single settings value. More...

#include <settinginterface.h>

Inheritance diagram for Updraft::SettingInterface:

List of all members.

Public Member Functions

virtual ~SettingInterface ()
virtual QVariant get ()=0
virtual void set (const QVariant &value)=0
 Sets the value of the associated setting.
virtual void setDescription (const QString &newDescription)=0
 Sets the description string for the settings dialog.
virtual void setNeedsRestart (bool needsRestart)=0
 Sets/unsets the needs_restart flag of the setting.
virtual void callOnValueChanged (QObject *slotOwner, const char *slot)=0
 Connects a slot that should be called whenever the value changes.

Detailed Description

Interface to a single settings value.


Constructor & Destructor Documentation

virtual Updraft::SettingInterface::~SettingInterface ( ) [inline, virtual]

Member Function Documentation

virtual void Updraft::SettingInterface::callOnValueChanged ( QObject *  slotOwner,
const char *  slot 
) [pure virtual]

Connects a slot that should be called whenever the value changes.

Parameters:
slotOwnerpointer to the QObject owning the target slot.
slotName of the slot to be called. This can be obtained using the SLOT(foo()) syntax.

Implemented in Updraft::Core::BasicSetting.

virtual QVariant Updraft::SettingInterface::get ( ) [pure virtual]
Returns:
Current value of the associated setting.

Implemented in Updraft::Core::BasicSetting.

virtual void Updraft::SettingInterface::set ( const QVariant &  value) [pure virtual]

Sets the value of the associated setting.

Parameters:
valueThe new value of the setting.

Implemented in Updraft::Core::BasicSetting.

virtual void Updraft::SettingInterface::setDescription ( const QString &  newDescription) [pure virtual]

Sets the description string for the settings dialog.

Parameters:
newDescriptionThe new description of the setting in the dialog.

Implemented in Updraft::Core::BasicSetting.

virtual void Updraft::SettingInterface::setNeedsRestart ( bool  needsRestart) [pure virtual]

Sets/unsets the needs_restart flag of the setting.

This flag is used to display an asterisk next to settings that need the application to restart after their value is changed.

Parameters:
needsRestartWhether the flag should be set or unset

Implemented in Updraft::Core::BasicSetting.


The documentation for this class was generated from the following file:
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Defines