XII Release 0.1.0
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
xiiGameObjectContextPreferencesUser Class Reference
Inheritance diagram for xiiGameObjectContextPreferencesUser:
[legend]

Public Member Functions

xiiUuid GetContextDocument () const
 
void SetContextDocument (xiiUuid val)
 
xiiUuid GetContextObject () const
 
void SetContextObject (xiiUuid val)
 
- Public Member Functions inherited from xiiPreferences
Domain GetDomain () const
 Whether the preferences are app, project or document specific.
 
xiiString GetName () const
 Within the same domain and visibility the name must be unique, but across those it can be reused.
 
const xiiDocument * 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.
 
- Public Member Functions inherited from xiiReflectedClass
virtual const xiiRTTI * GetDynamicRTTI () const
 
bool IsInstanceOf (const xiiRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T>
XII_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 

Protected Attributes

xiiUuid m_ContextDocument
 
xiiUuid m_ContextObject
 

Additional Inherited Members

- Public Types inherited from xiiPreferences
enum class  Domain { Application , Project , Document }
 
- Static Public Member Functions inherited from xiiPreferences
template<typename TYPE>
static TYPE * QueryPreferences (const xiiDocument *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 xiiPreferences * QueryPreferences (const xiiRTTI *pRtti, const xiiDocument *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 xiiDocument *pDocument)
 Saves all preferences that are tied to the given document.
 
static void ClearDocumentPreferences (const xiiDocument *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 (xiiHybridArray< xiiPreferences *, 16 > &out_allPreferences)
 
- Static Public Member Functions inherited from xiiNoBase
static const xiiRTTI * GetStaticRTTI ()
 
- Public Attributes inherited from xiiPreferences
xiiEvent< xiiPreferences * > m_ChangedEvent
 A simple event that can be fired when any preference property changes. No specific change details are given.
 
- Protected Member Functions inherited from xiiPreferences
 xiiPreferences (Domain domain, const char *szUniqueName)
 
xiiString GetFilePath () const
 
The documentation for this class was generated from the following files: