|
plUuid | GetContextDocument () const |
|
void | SetContextDocument (plUuid val) |
|
plUuid | GetContextObject () const |
|
void | SetContextObject (plUuid val) |
|
Domain | GetDomain () const |
| Whether the preferences are app, project or document specific.
|
|
plString | GetName () const |
| Within the same domain and visibility the name must be unique, but across those it can be reused.
|
|
const plDocument * | GetDocumentAssociation () const |
| If these preferences are per document, the pointer is valid, otherwise nullptr.
|
|
void | TriggerPreferencesChangedEvent () |
| Call this to broadcast that this preference object was modified.
|
|
virtual const plRTTI * | GetDynamicRTTI () const |
|
bool | IsInstanceOf (const plRTTI *pType) const |
| Returns whether the type of this instance is of the given type or derived from it.
|
|
template<typename T > |
PL_ALWAYS_INLINE bool | IsInstanceOf () const |
| Returns whether the type of this instance is of the given type or derived from it.
|
|
|
enum class | Domain { Application
, Project
, Document
} |
|
template<typename TYPE > |
static TYPE * | QueryPreferences (const plDocument *pDocument=nullptr) |
| Static function to query a preferences object of the given type. If the instance does not exist yet, it is created and the data is restored from file.
|
|
static plPreferences * | QueryPreferences (const plRTTI *pRtti, const plDocument *pDocument=nullptr) |
| Static function to query a preferences object of the given type. If the instance does not exist yet, it is created and the data is restored from file.
|
|
static void | SaveDocumentPreferences (const plDocument *pDocument) |
| Saves all preferences that are tied to the given document.
|
|
static void | ClearDocumentPreferences (const plDocument *pDocument) |
| Removes all preferences for the given document. Does not save them. Afterwards the preferences will not appear in the UI any further.
|
|
static void | SaveProjectPreferences () |
| Saves all project specific preferences.
|
|
static void | ClearProjectPreferences () |
| Removes all project specific preferences. Does not save them. Afterwards the preferences will not appear in the UI any further.
|
|
static void | SaveApplicationPreferences () |
| Saves all application specific preferences.
|
|
static void | ClearApplicationPreferences () |
| Removes all application specific preferences. Does not save them. Afterwards the preferences will not appear in the UI any further.
|
|
static void | GatherAllPreferences (plHybridArray< plPreferences *, 16 > &out_allPreferences) |
|
static const plRTTI * | GetStaticRTTI () |
|
plEvent< plPreferences * > | m_ChangedEvent |
| A simple event that can be fired when any preference property changes. No specific change details are given.
|
|
| plPreferences (Domain domain, const char *szUniqueName) |
|
plString | GetFilePath () const |
|
The documentation for this class was generated from the following files: