Allows column views to store more data than simply strings and indices. More...

#include <hdicoreColumnEntry.h>

Public Types
typedef std::vector< EntryValue >	ValueVector

typedef std::vector< bool >	EditableVector

typedef std::vector< void * >	DataVector

Public Member Functions
	ColumnEntry ()
	Constructs an empty ColumnEntry object.

	ColumnEntry (const ColumnEntry &e_)
	Constructs a new ColumnEntry object from an existing ColumnEntry object (copy constructor)

	ColumnEntry (const std::string &id_, const ValueVector &values_, const DataVector &userData_, const bool enabled_, const EditableVector &editable_)
	Constructs a ColumnEntry object with some custom data.

virtual	~ColumnEntry ()
	Destructs a ColumnEntry object.

virtual ColumnEntry &	operator= (const ColumnEntry &rhs_)
	Assigns one ColumnEntry object to another.

virtual bool	isEmpty () const
	Gets whether the target ColumnEntry 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 ValueVector	values () const
	Gets the value objects of an entry.

virtual void	setValues (const ValueVector &values_)
	Sets the value objects of an entry.

virtual bool	enabled () const
	Gets whether the entry should be enabled (selectable by the user in the list)

virtual void	setEnabled (const bool enabled_)
	Sets whether the entry should be enabled (selectable by the user in the list)

virtual EditableVector	editable () const
	Gets the editability of each cell in the entry (whether the user can edit it inline)

virtual void	setEditable (const EditableVector &editable_)
	Sets the editability of each cell in the entry (whether the user can edit it inline)

virtual DataVector	userData () const
	Gets the custom data of an entry.

virtual void	setUserData (const DataVector &data_)
	Sets the custom data of an entry.

virtual bool	operator== (const ColumnEntry &rhs_) const
	Tests whether a given ColumnEntry object is the same as another.

virtual bool	operator!= (const ColumnEntry &rhs_) const
	Tests whether a given ColumnEntry object is not the same as another.

Static Public Attributes
static const char *	separatorValue
	When you want a separator in a container widget, create a ColumnEntry object with this as its string value.

Friends
pui::ColumnEntryData *	__accessImpl (const ColumnEntry &)

Detailed Description

Allows column views to store more data than simply strings and indices.

Constructor & Destructor Documentation

◆ ColumnEntry() [1/3]

hdi::core::ColumnEntry::ColumnEntry ( )

Constructs an empty ColumnEntry object.

Author: GW

Date: 01/2015

Note: To test if a ColumnEntry object is empty, call isEmpty() on it; Empty ColumnEntry objects do not relate to any entry in any widget; they are designed to be "receivers" of some other ColumnEntry object via the overloaded assignment operator. Empty ColumnEntry objects are useless until such time (though it is safe to call any of their methods).

◆ ColumnEntry() [2/3]

hdi::core::ColumnEntry::ColumnEntry ( const ColumnEntry & e_ )

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

Author: GW

Date: 01/2015

Parameters

e_	Existing ColumnEntry object

◆ ColumnEntry() [3/3]

hdi::core::ColumnEntry::ColumnEntry	(	const std::string &	id_,
		const ValueVector &	values_,
		const DataVector &	userData_,
		const bool	enabled_,
		const EditableVector &	editable_
	)

Constructs a ColumnEntry object with some custom data.

Author: GW

Date: 01/2015

Parameters

id_	Entry ID string, as UTF-8 (must form a unique ID path in the target container)
values_	Entry value objects, one for each column
userData_	Data to store in each column of the entry
enabled_	Whether the entry should be enabled
editable_	Whether each cell in the entry should be inline editable

◆ ~ColumnEntry()

virtual hdi::core::ColumnEntry::~ColumnEntry ( )

virtual

Destructs a ColumnEntry object.

Author: GW

Date: 01/2015

Member Function Documentation

◆ editable()

virtual EditableVector hdi::core::ColumnEntry::editable ( ) const

virtual

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

Author: GW

Date: 07/2022

Returns: true for enabled, false otherwise

◆ enabled()

virtual bool hdi::core::ColumnEntry::enabled ( ) const

virtual

Gets whether the entry should be enabled (selectable by the user in the list)

Author: GW

Date: 01/2015

Returns: true for enabled, false otherwise

◆ entryID()

virtual std::string hdi::core::ColumnEntry::entryID ( ) const

virtual

Gets the ID string of an entry.

Author: GW

Date: 01/2015

Returns: The unique ID of the entry, as UTF-8

◆ isEmpty()

virtual bool hdi::core::ColumnEntry::isEmpty ( ) const

virtual

Gets whether the target ColumnEntry object is empty (constructed with the default ctor)

Author: GW

Date: 01/2015

Returns: true if the target ColumnEntry object is empty, false otherwise

◆ operator!=()

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

virtual

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

Author: GW

Date: 01/2015

Parameters

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

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

◆ operator=()

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

virtual

Assigns one ColumnEntry object to another.

Author: GW

Date: 01/2015

Parameters

rhs_	Existing ColumnEntry object to copy values from

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

◆ operator==()

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

virtual

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

Author: GW

Date: 01/2015

Parameters

rhs_	ColumnEntry 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::ColumnEntry::setEditable ( const EditableVector & editable_ )

virtual

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

Author: GW

Date: 07/2022

Parameters

enabled_ true for enabled, false otherwise

◆ setEnabled()

virtual void hdi::core::ColumnEntry::setEnabled ( const bool enabled_ )

virtual

Sets whether the entry should be enabled (selectable by the user in the list)

Author: GW

Date: 01/2015

Parameters

enabled_ true for enabled, false otherwise

◆ setEntryID()

virtual void hdi::core::ColumnEntry::setEntryID ( const std::string & id_ )

virtual

Sets the ID string of an entry.

Author: GW

Date: 01/2015

Parameters

id_	New entry ID string, as UTF-8

Note: It is up to the caller to ensure that the ID path is not in use with other entries within the same container widget.

◆ setUserData()

virtual void hdi::core::ColumnEntry::setUserData ( const DataVector & data_ )

virtual

Sets the custom data of an entry.

Author: GW

Date: 01/2015

Parameters

data_ New custom data to store

◆ setValues()

virtual void hdi::core::ColumnEntry::setValues ( const ValueVector & values_ )

virtual

Sets the value objects of an entry.

Author: GW

Date: 01/2015

Parameters

values_ New entry value objects

◆ userData()

virtual DataVector hdi::core::ColumnEntry::userData ( ) const

virtual

Gets the custom data of an entry.

Author: GW

Date: 01/2015

Returns: The data stored inside the target entry object

◆ values()

virtual ValueVector hdi::core::ColumnEntry::values ( ) const

virtual

Gets the value objects of an entry.

Author: GW

Date: 01/2015

Returns: The entry's value objects

Public Types

Public Member Functions

Static Public Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ ColumnEntry() [1/3]

◆ ColumnEntry() [2/3]

◆ ColumnEntry() [3/3]

◆ ~ColumnEntry()

Member Function Documentation

◆ editable()

◆ enabled()

◆ entryID()

◆ isEmpty()

◆ operator!=()

◆ operator=()

◆ operator==()

◆ setEditable()

◆ setEnabled()

◆ setEntryID()

◆ setUserData()

◆ setValues()

◆ userData()

◆ values()