JXCheckboxGroup Class Reference

#include <JXCheckboxGroup.h>

Inheritance diagram for JXCheckboxGroup:

Public Member Functions
	~JXCheckboxGroup () override
bool	Includes (JXCheckbox *cb) const
void	Add (JXCheckbox *cb)
void	Insert (const JIndex index, JXCheckbox *cb)
void	Remove (JXCheckbox *cb)
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
	JXCheckboxGroup ()
	JXCheckboxGroup (const JPtrArray< JXCheckbox > &cbList)
bool	AllChecked () const
bool	AllUnchecked () const
bool	AllDisabled () const
bool	CheckboxDisabled (const JIndex index) const
bool	FindCheckbox (JBroadcaster *obj, JIndex *index) const
JXCheckbox *	GetCheckbox (const JIndex index) const
JPtrArray< JXCheckbox > *	GetCheckboxList () const
void	Receive (JBroadcaster *sender, const Message &message) override
virtual void	EnforceConstraints (const JIndex cbIndex)=0
void	ReceiveGoingAway (JBroadcaster *sender) override
Protected Member Functions inherited from JContainer
void	InstallCollection (JCollection *list)
const JCollection *	GetList () const
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)

Detailed Description

This defines the concept of a group of checkboxes that are constrained
in some way.  Derived classes must implement the actual constraints.

Derived classes must implement the following function:

    EnforceConstraints
        The value passed in is the index of the checkbox that changed.
        The function should change the state of the checkboxes to
        maintain the constraints.

Constructor & Destructor Documentation

~JXCheckboxGroup()

JXCheckboxGroup::~JXCheckboxGroup ( )

override

JXCheckboxGroup() [1/2]

JXCheckboxGroup::JXCheckboxGroup ( )

protected

JXCheckboxGroup() [2/2]

JXCheckboxGroup::JXCheckboxGroup ( const JPtrArray< JXCheckbox > &  cbList )

protected

Member Function Documentation

Add()

void JXCheckboxGroup::Add

(

JXCheckbox *

cb

)

AllChecked()

bool JXCheckboxGroup::AllChecked ( ) const

protected

AllDisabled()

bool JXCheckboxGroup::AllDisabled ( ) const

protected

Returns true if all checkboxes are either hidden or inactive.

AllUnchecked()

bool JXCheckboxGroup::AllUnchecked ( ) const

protected

CheckboxDisabled()

bool JXCheckboxGroup::CheckboxDisabled ( const JIndex  index ) const

protected

Returns true if the checkbox is either hidden or inactive.

EnforceConstraints()

virtual void JXCheckboxGroup::EnforceConstraints ( const JIndex  cbIndex )

protectedpure virtual

Implemented in JXAtLeastOneCBGroup, and JXAtMostOneCBGroup.

FindCheckbox()

bool JXCheckboxGroup::FindCheckbox ( JBroadcaster *  obj, JIndex *  index  ) const

protected

This takes a JBroadcaster because one is not allowed to downcast from a virtual base class, so there is no other way for Receive() to obtain a JXCheckbox*.

GetCheckbox()

JXCheckbox * JXCheckboxGroup::GetCheckbox ( const JIndex  index ) const

inlineprotected

GetCheckboxList()

JPtrArray< JXCheckbox > * JXCheckboxGroup::GetCheckboxList ( ) const

inlineprotected

Includes()

bool JXCheckboxGroup::Includes ( JXCheckbox *  cb ) const

inline

Insert()

void JXCheckboxGroup::Insert	(	const JIndex	index,
		JXCheckbox *	cb
	)

Receive()

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

overrideprotectedvirtual

Keep the number of items up to date.

Reimplemented from JContainer.

ReceiveGoingAway()

void JXCheckboxGroup::ReceiveGoingAway ( JBroadcaster *  sender )

overrideprotectedvirtual

The given sender has been deleted.

Reimplemented from JBroadcaster.

Remove()

void JXCheckboxGroup::Remove

(

JXCheckbox *

cb

)

---

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

• libjx/code/JXCheckboxGroup.h
• libjx/code/JXCheckboxGroup.cpp