hdi::core::PopupEntry Class Reference

Allows combo boxes, popups, and flyouts to store more data than simply strings and indices. More...

#include <hdicorePopupEntry.h>

Inheritance diagram for hdi::core::PopupEntry:

Collaboration diagram for hdi::core::PopupEntry:

Public Member Functions
	PopupEntry ()
	Constructs an empty PopupEntry object.
	PopupEntry (const PopupEntry &e_)
	Constructs a new PopupEntry object from an existing PopupEntry object (copy constructor)
	PopupEntry (const std::string &id_, const std::string &value_, void *userData_, const bool enabled_)
	Constructs a PopupEntry object with some custom data.
virtual	~PopupEntry ()
	Destructs a PopupEntry object.
virtual PopupEntry &	operator= (const PopupEntry &rhs_)
	Assigns one PopupEntry object to another.
virtual bool	editable () const
	Gets the editability of the entry (whether the user can edit it inline)
virtual void	setEditable (const bool editable_)
	Sets the editability of the entry (whether the user can edit it inline)
virtual bool	operator== (const PopupEntry &rhs_) const
	Tests whether a given PopupEntry object is the same as another.
virtual bool	operator!= (const PopupEntry &rhs_) const
	Tests whether a given PopupEntry object is not the same as another.
Public Member Functions inherited from hdi::core::ListEntry
	ListEntry ()
	Constructs an empty ListEntry object.
	ListEntry (const ListEntry &e_)
	Constructs a new ListEntry object from an existing ListEntry object (copy constructor)
	ListEntry (const std::string &id_, const std::string &value_, void *userData_, const bool enabled_, const bool editable_)
	Constructs a ListEntry object with some custom data.
virtual	~ListEntry ()
	Destructs a ListEntry object.
virtual ListEntry &	operator= (const ListEntry &rhs_)
	Assigns one ListEntry object to another.
virtual bool	isEmpty () const
	Gets whether the target ListEntry object is empty (constructed with the default ctor)
virtual std::string	entryID () const
	Gets the ID string of an entry.
virtual void	setEntryID (const std::string &id_)
	Sets the ID string of an entry.
virtual std::string	value () const
	Gets the string value of an entry (what the user sees in the popup/list/etc.)
virtual void	setValue (const std::string &value_)
	Sets the string value of an entry (what the user sees in the popup/list/etc.)
virtual bool	enabled () const
	Gets whether the entry should be enabled (selectable by the user in the popup/list/etc.)
virtual void	setEnabled (const bool enabled_)
	Sets whether the entry should be enabled (selectable by the user in the popup/list/etc.)
virtual bool	editable () const
	Gets the editability of the entry (whether the user can edit it inline)
virtual void	setEditable (const bool editable_)
	Sets the editability of the entry (whether the user can edit it inline)
virtual void *const	userData () const
	Gets the custom data of an entry.
virtual void	setUserData (void *data_)
	Sets the custom data of an entry.
virtual bool	operator== (const ListEntry &rhs_) const
	Tests whether a given ListEntry object is the same as another.
virtual bool	operator!= (const ListEntry &rhs_) const
	Tests whether a given ListEntry object is not the same as another.

Additional Inherited Members
Static Public Attributes inherited from hdi::core::ListEntry
static const char *	separatorValue
	When you want a separator in a container widget, create a ListEntry object with this as its value.

Detailed Description

Allows combo boxes, popups, and flyouts to store more data than simply strings and indices.

Constructor & Destructor Documentation

PopupEntry() [1/3]

hdi::core::PopupEntry::PopupEntry

(

)

Constructs an empty PopupEntry object.

Author

GW

Date

07/2022

Note

To test if an PopupEntry object is empty, call isEmpty() on it

Empty PopupEntry objects do not relate to any entry in any widget; they are designed to be "receivers" of some other PopupEntry object via the overloaded assignment operator. Empty PopupEntry objects are useless until such time (though it is safe to call any of their methods).

PopupEntry() [2/3]

hdi::core::PopupEntry::PopupEntry

(

const PopupEntry &

e_

)

Constructs a new PopupEntry object from an existing PopupEntry object (copy constructor)

Author

GW

Date

07/2022

Parameters

e_	Existing PopupEntry object

PopupEntry() [3/3]

hdi::core::PopupEntry::PopupEntry	(	const std::string &	id_,
		const std::string &	value_,
		void *	userData_,
		const bool	enabled_
	)

Constructs a PopupEntry object with some custom data.

Author

GW

Date

07/2022

Parameters

id_	Entry ID string (must be unique across all entries in the target container), as UTF-8
value_	Entry string value, as UTF-8
userData_	Data to store in the entry
enabled_	Whether the entry should be enabled

~PopupEntry()

virtual hdi::core::PopupEntry::~PopupEntry ( )

virtual

Destructs a PopupEntry object.

Author

GW

Date

07/2022

Member Function Documentation

editable()

virtual bool hdi::core::PopupEntry::editable ( ) const

virtual

Gets the editability of the entry (whether the user can edit it inline)

Author

GW

Date

07/2022

Returns

true for enabled, false otherwise

Reimplemented from hdi::core::ListEntry.

operator!=()

virtual bool hdi::core::PopupEntry::operator!= ( const PopupEntry &  rhs_ ) const

virtual

Tests whether a given PopupEntry object is not the same as another.

Author

GW

Date

07/2022

Parameters

rhs_	PopupEntry to compare against (righthand side of inequality operator)

Returns

true for the target and rhs_ being different entries, false otherwise

operator=()

virtual PopupEntry & hdi::core::PopupEntry::operator= ( const PopupEntry &  rhs_ )

virtual

Assigns one PopupEntry object to another.

Author

GW

Date

07/2022

Parameters

rhs_	Existing PopupEntry object to copy values from

Returns

The target PopupEntry object, but with its values updated to match that of the rhs_ argument

operator==()

virtual bool hdi::core::PopupEntry::operator== ( const PopupEntry &  rhs_ ) const

virtual

Tests whether a given PopupEntry object is the same as another.

Author

GW

Date

07/2022

Parameters

rhs_	PopupEntry to compare against (righthand side of equality operator)

Returns

true for the target and rhs_ being the same entry, false otherwise

setEditable()

virtual void hdi::core::PopupEntry::setEditable ( const bool  editable_ )

virtual

Sets the editability of the entry (whether the user can edit it inline)

Author

GW

Date

07/2022

Parameters

enabled_

true for enabled, false otherwise

Reimplemented from hdi::core::ListEntry.