JXSharedPrefObject Class Reference

#include <JXSharedPrefObject.h>

Inheritance diagram for JXSharedPrefObject:

Classes
struct	VersionInfo

Public Member Functions
	JXSharedPrefObject (const JFileVersion currVers, const JPrefID &latestVersID, const VersionInfo versList[], const JSize versCount)
	~JXSharedPrefObject () override
JFileVersion	GetCurrentPrefsVersion () const
const JPrefID &	GetLatestVersionID () const
JPrefID	GetPrefID (const JFileVersion vers) const
const JArray< VersionInfo > &	GetVersionList () const
void	ReadPrefs ()
void	WritePrefs () const
virtual void	ReadPrefs (std::istream &input)=0
virtual void	WritePrefs (std::ostream &output, const JFileVersion vers) const =0
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
virtual JString	ToString () const
template<class T >
void	ListenTo (const JBroadcaster *sender, const std::function< void(const T &)> &f)

Protected Member Functions
void	Receive (JBroadcaster *sender, const Message &message) override
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)

Detailed Description

Base class for objects that own an ID in the global JX shared
preferences file.  To read/write preferences, simply call
JXSharedPrefObject::Read/WritePrefs().

All the instructions for JPrefObject are also relevant here.

The version list passed to the constructor must be pre-sorted by
version.

Constructor & Destructor Documentation

JXSharedPrefObject()

JXSharedPrefObject::JXSharedPrefObject	(	const JFileVersion	currVers,
		const JPrefID &	latestVersID,
		const VersionInfo	versList[],
		const JSize	versCount
	)

~JXSharedPrefObject()

JXSharedPrefObject::~JXSharedPrefObject ( )

override

Member Function Documentation

GetCurrentPrefsVersion()

JFileVersion JXSharedPrefObject::GetCurrentPrefsVersion ( ) const

inline

GetLatestVersionID()

const JPrefID & JXSharedPrefObject::GetLatestVersionID ( ) const

inline

GetPrefID()

JPrefID JXSharedPrefObject::GetPrefID

(

const JFileVersion

vers

)

const

vers cannot be smaller than the minimum version in our list.

GetVersionList()

const JArray< JXSharedPrefObject::VersionInfo > & JXSharedPrefObject::GetVersionList ( ) const

inline

ReadPrefs() [1/2]

void JXSharedPrefObject::ReadPrefs

(

)

ReadPrefs() [2/2]

virtual void JXSharedPrefObject::ReadPrefs ( std::istream &  input )

pure virtual

Implemented in JXSpellChecker, and JXWebBrowser.

Receive()

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

overrideprotectedvirtual

Process the given message from the given sender. This function is not pure virtual because not all classes will want to implement it.

Reimplemented from JBroadcaster.

WritePrefs() [1/2]

void JXSharedPrefObject::WritePrefs

(

)

const

WritePrefs() [2/2]

virtual void JXSharedPrefObject::WritePrefs ( std::ostream &  output, const JFileVersion  vers  ) const

pure virtual

Implemented in JXSpellChecker, and JXWebBrowser.

---

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

• libjx/code/JXSharedPrefObject.h
• libjx/code/JXSharedPrefObject.cpp