Class template for accessing a specific value in the CSettingsCache. More...
Inheritance diagram for swift::misc::CSetting< Trait >:
Public Member Functions | |
| template<typename T > | |
| CSetting (T *owner) | |
| Constructor. More... | |
| template<typename T , typename F > | |
| CSetting (T *owner, F slot) | |
| Constructor. More... | |
| CStatusMessage | setDefault () |
| Reset the setting to its default value. | |
| auto | getDefault () const |
| Gets the default value. | |
| bool | isDefault () const |
| Is default value? | |
| QString | getFilename () const |
| Return the file that is used for persistence for this value. | |
 Public Member Functions inherited from swift::misc::CCached< Trait::type > | |
| CCached (CValueCache *cache, const QString &key, const QString &name, U *owner) | |
| Constructor. More... | |
| CCached (CValueCache *cache, const QString &key, const QString &name, F validator, const Trait::type &defaultValue, U *owner) | |
| Constructor. More... | |
| CCached (const CCached &)=delete | |
| Deleted copy constructor. | |
| void | setNotifySlot (F slot) |
| Set a callback to be called when the value is changed by another source. | |
| const Trait::type & | getThreadLocal () const |
| Read the current value. | |
| Trait::type | get () const |
| Get a copy of the current value. More... | |
| CStatusMessage | set (const Trait::type &value, qint64 timestamp=0) |
| Write a new value. Must be called from the thread in which the owner lives. | |
| CStatusMessage | setAndSave (const Trait::type &value, qint64 timestamp=0) |
| Write and save in the same step. Must be called from the thread in which the owner lives. | |
| CStatusMessage | save () |
| Save using the currently set value. Must be called from the thread in which the owner lives. | |
| CStatusMessage | setProperty (CPropertyIndexRef index, const CVariant &value, qint64 timestamp=0) |
| Write a property of the value. Must be called from the thread in which the owner lives. | |
| CStatusMessage | setAndSaveProperty (CPropertyIndexRef index, const CVariant &value, qint64 timestamp=0) |
| Write a property and save in the same step. Must be called from the thread in which the owner lives. | |
| bool | isOwnerThread () const |
| Is current thread the owner thread, so CCached::set is safe. | |
| const QString & | getKey () const |
| Get the key string of this value. | |
| QDateTime | getTimestamp () const |
| Return the time when this value was updated. More... | |
| qint64 | getTimestampMsSinceEpoch () const |
| Return the time when this value was updated. More... | |
| qint64 | lastUpdatedAge () const |
| How old is that cache (ms)? | |
| bool | isSaved () const |
| Return true if this value was already saved. | |
| bool | isSaving () const |
| Return true if this value is currently saving. | |
| bool | isInitialized () const |
| Can be false if key contains OwnerName% and owner's objectName was empty. | |
| CCached & | operator= (const CCached &)=delete |
| Deleted copy assignment operator. | |
Detailed Description
template<typename Trait>
class swift::misc::CSetting< Trait >
Class template for accessing a specific value in the CSettingsCache.
- Template Parameters
-
Trait A subclass of swift::misc::TSettingTrait that identifies the value's key and other metadata.
Definition at line 67 of file settingscache.h.
Constructor & Destructor Documentation
◆ CSetting() [1/2]
template<typename Trait >
template<typename T >
|
inline |
Constructor.
- Parameters
-
owner Will be the parent of the internal QObject used to access the value.
Definition at line 73 of file settingscache.h.
◆ CSetting() [2/2]
template<typename Trait >
template<typename T , typename F >
|
inline |
Constructor.
- Parameters
-
owner Will be the parent of the internal QObject used to access the value. slot Slot to call when the value is modified by another object. Must be a void, non-const member function of the owner.
Definition at line 88 of file settingscache.h.
The documentation for this class was generated from the following file:
- src/misc/settingscache.h
