Quassel IRC  Pre-Release
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros
KNotificationBackend::ConfigWidget Class Reference

#include </tmp/quassel/src/qtui/knotificationbackend.h>

Inheritance diagram for KNotificationBackend::ConfigWidget:
Collaboration diagram for KNotificationBackend::ConfigWidget:

Public Slots

virtual void defaults ()
 Restore defaults, overriding any changes the user might have made in the dialog.

Signals

void changed (bool hasChanged)
 Emitted whenever the widget state changes.

Public Member Functions

 ConfigWidget (QWidget *parent=0)
void save ()
 Save settings to permanent storage.
void load ()
 Load settings from permanent storage, overriding any changes the user might have made in the dialog.
virtual QString category () const
 The category of this settings page.
virtual QString title () const
 The title of this settings page.
virtual bool needsCoreConnection () const
 Whether the settingspage needs a core connection to be selectable.
virtual QString settingsKey () const
 The key this settings page stores its values under.
virtual bool hasDefaults () const
 Derived classes need to define this and return true if they have default settings.
bool hasChanged () const
 Check if there are changes in the page, compared to the state saved in permanent storage.
virtual bool aboutToSave ()
 Called immediately before save() is called.

Static Public Member Functions

static bool hasChanged (QCheckBox *box)
static bool hasChanged (QComboBox *box)
static bool hasChanged (QSpinBox *box)
static void load (QCheckBox *box, bool checked)
 sets checked state depending on and stores the value for later comparision
static void load (QComboBox *box, int index)
static void load (QSpinBox *box, int value)

Protected Slots

void changed ()
 Calling this slot is equivalent to calling setChangedState(true).
void setChangedState (bool hasChanged=true)
 This should be called whenever the widget state changes from unchanged to change or the other way round.

Protected Member Functions

void initAutoWidgets ()
virtual QVariant loadAutoWidgetValue (const QString &widgetName)
virtual void saveAutoWidgetValue (const QString &widgetName, const QVariant &value)

Private Slots

void widgetChanged (bool)

Private Attributes

KNotifyConfigWidget * _widget

Detailed Description

Definition at line 58 of file knotificationbackend.h.

Constructor & Destructor Documentation

ConfigWidget ( QWidget *  parent = 0)

Definition at line 151 of file knotificationbackend.cpp.

References _widget, SettingsPage::changed(), and widgetChanged().

Member Function Documentation

void save ( )
virtual

Save settings to permanent storage.

This baseclass implementation saves the autoWidgets, so be sure to call it if you use this feature in your settingsPage!

Reimplemented from SettingsPage.

Definition at line 175 of file knotificationbackend.cpp.

void load ( )
virtual

Load settings from permanent storage, overriding any changes the user might have made in the dialog.

This baseclass implementation loads the autoWidgets, so be sure to call it if you use this feature in your settingsPage!

Reimplemented from SettingsPage.

Definition at line 169 of file knotificationbackend.cpp.

void widgetChanged ( bool  changed)
privateslot

Definition at line 163 of file knotificationbackend.cpp.

Referenced by ConfigWidget().

virtual QString category ( ) const
inlinevirtualinherited

The category of this settings page.

Definition at line 66 of file settingspage.h.

References SettingsPage::_category.

Referenced by SettingsDlg::registerSettingsPage().

virtual QString title ( ) const
inlinevirtualinherited

The title of this settings page.

Definition at line 69 of file settingspage.h.

References SettingsPage::_title.

Referenced by SettingsDlg::registerSettingsPage(), and SettingsPageDlg::SettingsPageDlg().

virtual bool needsCoreConnection ( ) const
inlinevirtualinherited

Whether the settingspage needs a core connection to be selectable.

This is a hint for the settingspage dialog. Do not rely on the settingspage not being visible if disconnected, and care about disabling it yourself.

Reimplemented in IgnoreListSettingsPage, NetworksSettingsPage, IdentitiesSettingsPage, AliasesSettingsPage, and ConnectionSettingsPage.

Definition at line 75 of file settingspage.h.

Referenced by SettingsDlg::setItemState().

virtual QString settingsKey ( ) const
inlinevirtualinherited

The key this settings page stores its values under.

This needs to be overriden to enable automatic loading/saving/hasChanged checking of widgets. The child widgets' values will be stored in client settings under this key. Every widget that should be automatically handled needs to have a settingsKey property set, and should also provide a defaultValue property. You can return an empty string (as opposed to a null string) to use the config root as a base, and you can override this key for individual widgets by prefixing their SettingsKey with /.

Reimplemented in BacklogSettingsPage.

Definition at line 85 of file settingspage.h.

Referenced by SettingsPage::autoWidgetSettingsKey().

bool hasChanged ( QCheckBox *  box)
staticinherited

Definition at line 58 of file settingspage.cpp.

bool hasChanged ( QComboBox *  box)
staticinherited

Definition at line 71 of file settingspage.cpp.

bool hasChanged ( QSpinBox *  box)
staticinherited

Definition at line 84 of file settingspage.cpp.

virtual bool aboutToSave ( )
inlinevirtualinherited

Called immediately before save() is called.

Derived classes should return false if saving is not possible (e.g. the current settings are invalid).

Returns
false, if the SettingsPage cannot be saved in its current state.

Reimplemented in NetworksSettingsPage, and IdentitiesSettingsPage.

Definition at line 102 of file settingspage.h.

void load ( QCheckBox *  box,
bool  checked 
)
staticinherited

sets checked state depending on and stores the value for later comparision

Definition at line 51 of file settingspage.cpp.

Referenced by NotificationsSettingsPage::load(), SettingsPageDlg::reload(), SettingsDlg::reload(), SettingsPageDlg::SettingsPageDlg(), SettingsPageDlg::undoChanges(), and SettingsDlg::undoChanges().

void load ( QComboBox *  box,
int  index 
)
staticinherited

Definition at line 64 of file settingspage.cpp.

void load ( QSpinBox *  box,
int  value 
)
staticinherited

Definition at line 77 of file settingspage.cpp.

void defaults ( )
virtualslotinherited

Restore defaults, overriding any changes the user might have made in the dialog.

This baseclass implementation loads the defaults of the autoWidgets (if available), so be sure to call it if you use this feature in your settingsPage!

Reimplemented in IndicatorNotificationBackend::ConfigWidget, SnoreNotificationBackend::ConfigWidget, SystrayNotificationBackend::ConfigWidget, DockManagerNotificationBackend::ConfigWidget, PhononNotificationBackend::ConfigWidget, TaskbarNotificationBackend::ConfigWidget, and OSXNotificationBackend::ConfigWidget.

Definition at line 228 of file settingspage.cpp.

References SettingsPage::_autoWidgets, SettingsPage::autoWidgetHasChanged(), and SettingsPage::autoWidgetPropertyName().

Referenced by NotificationsSettingsPage::defaults(), SettingsPageDlg::loadDefaults(), and SettingsDlg::loadDefaults().

void changed ( bool  hasChanged)
signalinherited

Emitted whenever the widget state changes.

QVariant loadAutoWidgetValue ( const QString &  widgetName)
protectedvirtualinherited

Definition at line 238 of file settingspage.cpp.

Referenced by SettingsPage::load().

void saveAutoWidgetValue ( const QString &  widgetName,
const QVariant &  value 
)
protectedvirtualinherited

Definition at line 245 of file settingspage.cpp.

Referenced by SettingsPage::save().

Member Data Documentation

KNotifyConfigWidget* _widget
private

Definition at line 72 of file knotificationbackend.h.

Referenced by ConfigWidget().


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