flxSettingsSave Class Reference

#include <flxSettings.h>

Inheritance diagram for flxSettingsSave:

Public Member Functions
	flxSettingsSave (flxSettingsSave const &)=delete
void	operator= (flxSettingsSave const &)=delete
void	saveEvent_CB (void)
void	restoreEvent_CB (void)
void	setStorage (flxStorage *pStorage)
void	setFallback (flxStorage *pStorage)
bool	saveSystem (void)
bool	save (flxObject &theObject, bool primary_only=false)
bool	save (flxObject *pObject, bool primary_only=false)
bool	restoreSystem (void)
bool	restore (flxObject &theObject)
bool	restore (flxObject *pObject)
void	reset (void)
bool	isAvailable ()
bool	saveObjectToStorage (flxObject *, flxStorage *)
bool	restoreObjectFromStorage (flxObject *, flxStorage *)
Public Member Functions inherited from flxActionType< flxSettingsSave >
flxTypeID	getType (void)
Public Member Functions inherited from flxAction
virtual bool	initialize (void)
Public Member Functions inherited from flxOperation
virtual flxTypeID	getType (void)
virtual bool	execute (void)
	Virtual method called to run the operation - called before data is retrieved. More...
virtual bool	onSave (flxStorageBlock *stBlk)
virtual bool	onRestore (flxStorageBlock *stBlk)
Public Member Functions inherited from flxObject
	flxObject ()
virtual	~flxObject ()
void	setParent (flxObject *parent)
void	setParent (flxObject &parent)
flxObject *	parent ()
void	setHidden (bool bHide=true)
bool	hidden ()
void	setIsDirty (bool bDirty=true)
bool	isDirty (void)
virtual bool	onSave (flxStorageBlock *stBlk)
virtual bool	save (flxStorage *pStorage)
virtual bool	onRestore (flxStorageBlock *stBlk)
virtual bool	restore (flxStorage *pStorage)
virtual flxTypeID	getType (void)
virtual bool	save (flxStorage *)=0
virtual bool	restore (flxStorage *)=0
Public Member Functions inherited from _flxPropertyContainer
	_flxPropertyContainer ()
void	addProperty (flxProperty *newProperty)
void	addProperty (flxProperty &newProperty)
void	removeProperty (flxProperty *rmProp)
void	removeProperty (flxProperty &rmProp)
flxPropertyList &	getProperties (void)
uint	nProperties (void)
bool	saveProperties (flxStorageBlock *stBlk)
bool	restoreProperties (flxStorageBlock *stBlk)
size_t	propertySaveSize ()
void	hideProperty (flxProperty &theProp)
Public Member Functions inherited from flxDescriptor
	flxDescriptor ()
void	setName (const char *new_name)
	Set the Name object - storing the pointer to the provided string No allocation is performed. If the previous name was allocated, it is freed. More...
void	setName (const char *new_name, const char *new_desc)
	Set the Name object and the Description for the object. Both strings are constants. More...
void	setName (char *new_name)
	Set the Name object, but makes a copy of the input string since the input is not const. If the previous name was allocated, it is freed. More...
const char *	name ()
	Return a const char pointer to the name of the object. More...
std::string	name_ (void)
	Returns a std::string of the name of the object. More...
void	setDescription (const char *new_desc)
	Set the Description object - the input value is constant and not copied. If the previous description was allocated, it is freed. More...
void	setDescription (char *new_desc)
	Set the Description object - the input value is not constant and is copied. If the previous description was allocated, it is freed. More...
const char *	description ()
	Return the constant C string pointer to the description of the object. More...
std::string	description_ (void)
	Return the description of the object as a std::string. More...
void	setTitle (const char *title)
	Set the Title object - the title is optional and is used mostly for UX or organizational purposes. The input value is constant and not copied. If the previous title was allocated, it is freed. More...
void	setTitleAlloc (char *new_title)
	Set the Title of the object , but make an explict copy of the provided string. More...
const char *	title (void)
	Return the C constant string pointer to the title of the object. More...
Public Member Functions inherited from _flxParameterContainer
void	addParameter (flxParameterIn *newParam, bool head=false)
void	addParameter (flxParameterIn &newParam, bool head=false)
void	removeParameter (flxParameterIn *rmParam)
void	removeParameter (flxParameterIn &rmParam)
size_t	nInputParameters ()
void	addParameter (flxParameterOut *newParam, bool head=false)
void	addParameter (flxParameterOut &newParam, bool head=false)
void	removeParameter (flxParameterOut *rmParam)
void	removeParameter (flxParameterOut &rmParam)
size_t	nOutputParameters ()
flxParameterOutList &	getOutputParameters (void)
flxParameterInList &	getInputParameters (void)

Static Public Member Functions
static flxSettingsSave &	get (void)
Static Public Member Functions inherited from flxActionType< flxSettingsSave >
static flxTypeID	type (void)
Static Public Member Functions inherited from flxObject
static flxTypeID	type (void)

Public Attributes
flxPropertyHiddenBool< flxSettingsSave >	saveOnEvent = {true}
flxPropertyHiddenBool< flxSettingsSave >	restoreOnEvent = {true}
flxPropertyBool< flxSettingsSave >	fallbackSave = {false}
flxPropertyBool< flxSettingsSave >	fallbackRestore = {true}
flxPropertyRWUInt32< flxSettingsSave, &flxSettingsSave::get_fallBackSize, &flxSettingsSave::set_fallbackSize >	fallbackBuffer
flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_settings >	saveSettings
flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_settings >	restoreSettings
flxParameterInVoid< flxSettingsSave, &flxSettingsSave::reset >	clearSettings
flxParameterInVoid< flxSettingsSave, &flxSettingsSave::restore_fallback >	restoreFallback
flxParameterInVoid< flxSettingsSave, &flxSettingsSave::save_fallback >	saveFallback

Additional Inherited Members
Protected Attributes inherited from flxDescriptor
const char *	_name
bool	_nameAlloc
const char *	_desc
bool	_descAlloc
const char *	_title
bool	_titleAlloc

Constructor & Destructor Documentation

flxSettingsSave()

flxSettingsSave::flxSettingsSave ( flxSettingsSave const &  )

delete

Member Function Documentation

get()

static flxSettingsSave & flxSettingsSave::get ( void  )

inlinestatic

isAvailable()

bool flxSettingsSave::isAvailable ( )

inline

operator=()

void flxSettingsSave::operator= ( flxSettingsSave const &  )

delete

reset()

void flxSettingsSave::reset

(

void

)

restore() [1/2]

bool flxSettingsSave::restore

(

flxObject &

theObject

)

restore() [2/2]

bool flxSettingsSave::restore

(

flxObject *

pObject

)

restoreEvent_CB()

void flxSettingsSave::restoreEvent_CB ( void  )

inline

restoreObjectFromStorage()

bool flxSettingsSave::restoreObjectFromStorage	(	flxObject *	pObject,
		flxStorage *	pStorage
	)

restoreSystem()

bool flxSettingsSave::restoreSystem

(

void

)

save() [1/2]

bool flxSettingsSave::save	(	flxObject &	theObject,
		bool	primary_only = false
	)

save() [2/2]

bool flxSettingsSave::save	(	flxObject *	pObject,
		bool	primary_only = false
	)

saveEvent_CB()

void flxSettingsSave::saveEvent_CB ( void  )

inline

saveObjectToStorage()

bool flxSettingsSave::saveObjectToStorage	(	flxObject *	pObject,
		flxStorage *	pStorage
	)

saveSystem()

bool flxSettingsSave::saveSystem

(

void

)

setFallback()

void flxSettingsSave::setFallback

(

flxStorage *

pStorage

)

setStorage()

void flxSettingsSave::setStorage

(

flxStorage *

pStorage

)

Member Data Documentation

clearSettings

flxParameterInVoid<flxSettingsSave, &flxSettingsSave::reset> flxSettingsSave::clearSettings

fallbackBuffer

flxPropertyRWUInt32<flxSettingsSave, &flxSettingsSave::get_fallBackSize, &flxSettingsSave::set_fallbackSize> flxSettingsSave::fallbackBuffer

fallbackRestore

flxPropertyBool<flxSettingsSave> flxSettingsSave::fallbackRestore = {true}

fallbackSave

flxPropertyBool<flxSettingsSave> flxSettingsSave::fallbackSave = {false}

restoreFallback

flxParameterInVoid<flxSettingsSave, &flxSettingsSave::restore_fallback> flxSettingsSave::restoreFallback

restoreOnEvent

flxPropertyHiddenBool<flxSettingsSave> flxSettingsSave::restoreOnEvent = {true}

restoreSettings

flxParameterInVoid<flxSettingsSave, &flxSettingsSave::restore_settings> flxSettingsSave::restoreSettings

saveFallback

flxParameterInVoid<flxSettingsSave, &flxSettingsSave::save_fallback> flxSettingsSave::saveFallback

saveOnEvent

flxPropertyHiddenBool<flxSettingsSave> flxSettingsSave::saveOnEvent = {true}

saveSettings

flxParameterInVoid<flxSettingsSave, &flxSettingsSave::save_settings> flxSettingsSave::saveSettings

---

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

• src/core/flux_prefs/flxSettings.h
• src/core/flux_prefs/flxSettings.cpp