#include <JXPrefsManager.h>

Inheritance diagram for JXPrefsManager:

Public Member Functions
	JXPrefsManager (const JFileVersion currentVersion, const bool eraseFileIfOpen, const JPrefID &csfID)

	~JXPrefsManager () override

virtual void	CleanUpBeforeSuddenDeath (const JXDocumentManager::SafetySaveReason reason)

Public Member Functions inherited from JPrefsManager
	JPrefsManager (const JString &fileName, const JFileVersion currentVersion, const bool eraseFileIfOpen)

	~JPrefsManager () override

JError	SaveToDisk () const

JFileVersion	GetPrevPrefsVersion () const

Public Member Functions inherited from JContainer
	JContainer ()

	JContainer (const JContainer &source)

JContainer &	operator= (const JContainer &source)

Public Member Functions inherited from JCollection
	JCollection ()

	JCollection (const JCollection &source)

	~JCollection () override

JCollection &	operator= (const JCollection &source)

JSize	GetItemCount () const

bool	IsEmpty () const

bool	IndexValid (const JIndex index) const

JIndex	GetIndexFromEnd (const JIndex index) const

JString	ToString () const override

Public Member Functions inherited from JBroadcaster
	JBroadcaster ()

virtual	~JBroadcaster ()

JBroadcaster &	operator= (const JBroadcaster &source)

bool	HasSenders () const

JSize	GetSenderCount () const

bool	HasRecipients () const

JSize	GetRecipientCount () const

template<class T >
void	ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)

Protected Member Functions
void	DataLoaded () override

virtual void	SaveAllBeforeDestruct ()

Protected Member Functions inherited from JPrefsManager
bool	IDValid (const JPrefID &id) const

bool	GetData (const JPrefID &id, std::string *data) const

void	SetData (const JPrefID &id, std::ostringstream &data)

void	SetData (const JPrefID &id, std::string &data)

void	SetData (const JPrefID &id, const JString &data)

void	SetData (const JPrefID &id, const JUtf8Byte *data)

void	RemoveData (const JPrefID &id)

bool	UpgradeData (const bool reportError=true)

virtual void	UpgradeData (const bool isNew, const JFileVersion currentVersion)=0

Protected Member Functions inherited from JContainer
void	InstallCollection (JCollection *list)

const JCollection *	GetList () const

void	Receive (JBroadcaster *sender, const Message &message) override

Protected Member Functions inherited from JCollection
void	ItemAdded ()

void	ItemRemoved ()

void	SetItemCount (const JSize newItemCount)

Protected Member Functions inherited from JBroadcaster
	JBroadcaster (const JBroadcaster &source)

void	ListenTo (const JBroadcaster *sender)

void	StopListening (const JBroadcaster *sender)

void	ClearWhenGoingAway (const JBroadcaster sender, void pointerToMember)

void	StopListening (const JBroadcaster *sender, const std::type_info &messageType)

template<class T >
void	Send (JBroadcaster *recipient, const T &message)

template<class T >
void	Broadcast (const T &message)

void	SendWithFeedback (JBroadcaster recipient, Message message)

void	BroadcastWithFeedback (Message *message)

virtual void	ReceiveWithFeedback (JBroadcaster sender, Message message)

virtual void	ReceiveGoingAway (JBroadcaster *sender)

Additional Inherited Members
Static Public Attributes inherited from JPrefsManager
static const JUtf8Byte *	kDataChanged = "DataChanged::JPrefsManager"

static const JUtf8Byte *	kDataRemoved = "DataRemoved::JPrefsManager"

static const JUtf8Byte *	kWrongVersion = "WrongVersion::JPrefsManager"

Detailed Description

Builds the file name based on the application signature.

Constructor & Destructor Documentation

◆ JXPrefsManager()

JXPrefsManager::JXPrefsManager	(	const JFileVersion	currentVersion,
		const bool	eraseFileIfOpen,
		const JPrefID &	csfID
	)

◆ ~JXPrefsManager()

JXPrefsManager::~JXPrefsManager ( )

override

Member Function Documentation

◆ CleanUpBeforeSuddenDeath()

void JXPrefsManager::CleanUpBeforeSuddenDeath ( const JXDocumentManager::SafetySaveReason reason )

virtual

This must be the last one called by the application's CleanUpBeforeSuddenDeath() function so we can save the preferences to disk.

If the server is dead, you cannot call any code that contacts it.

◆ DataLoaded()

void JXPrefsManager::DataLoaded ( )

overrideprotectedvirtual

Implements JPrefsManager.

◆ SaveAllBeforeDestruct()

void JXPrefsManager::SaveAllBeforeDestruct ( )

protectedvirtual

This must be called by the leaf class destructor.

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

libjx/code/JXPrefsManager.h
libjx/code/JXPrefsManager.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members