Implements a proxy data source which fetches content from another data source and provides callbacks to subclasses for filtering and sorting. More...

#include <sort_filter_proxy_datasource_abs.hpp>

Inheritance diagram for kanzi::connect::SortFilterProxyDataSourceAbs:

Public Member Functions
virtual DataObjectSharedPtr	getData () KZ_OVERRIDE

	KZ_METACLASS_END ()

virtual void	unloadOverride () KZ_OVERRIDE

virtual	~SortFilterProxyDataSourceAbs () KZ_OVERRIDE
	dtor More...

Static Public Attributes
static PropertyType< string >	ItemSourceProperty

static PropertyType< ResourceSharedPtr >	OriginalDataContextProperty

Protected Member Functions
size_t	getColumnCount () const
	How many columns (fields) the list item has. More...

string	getStringValueFromColumnFieldItem (DataObjectSharedPtr item) const
	Convenience function to get value in string format from DataObject. More...

string	getStringValueFromListItem (const DataObjectSharedPtr listItem, unsigned int column) const
	Convenience function to get value in string format from given list item. More...

virtual bool	isIncluded (const DataObjectSharedPtr &object) const KZ_OVERRIDE
	Subclasses may override this to implement filtering functionality. More...

virtual bool	isLessThan (const DataObjectSharedPtr &lhs, const DataObjectSharedPtr &rhs) const KZ_OVERRIDE
	Subclasses may override this to implement sorting functionality. More...

virtual void	onLoaded () KZ_OVERRIDE
	Called by Kanzi after loading the KZB file of the application. More...

virtual void	onOriginalDataSourceChangedOverride ()
	Subclasses may override this to get event that the original data source has changed and may do validation on sort/filter conditions. More...

void	refreshFiltering ()
	Request filtering and then sorting the list contents. More...

void	refreshSorting ()
	Request resorting the list contents. More...

	SortFilterProxyDataSourceAbs (Domain *domain, string_view name)
	Constructor. More...

Static Protected Member Functions
static const DataObjectSharedPtr	findColumnItemFromListItem (const DataObjectSharedPtr listItem, unsigned int column)
	Find the data object that contains the value within individual list item. More...

Detailed Description

Implements a proxy data source which fetches content from another data source and provides callbacks to subclasses for filtering and sorting.

Constructor & Destructor Documentation

◆ ~SortFilterProxyDataSourceAbs()

virtual kanzi::connect::SortFilterProxyDataSourceAbs::~SortFilterProxyDataSourceAbs ( )

virtual

dtor

◆ SortFilterProxyDataSourceAbs()

kanzi::connect::SortFilterProxyDataSourceAbs::SortFilterProxyDataSourceAbs	(	Domain *	domain,
		string_view	name
	)

explicitprotected

Constructor.

Member Function Documentation

◆ findColumnItemFromListItem()

static const DataObjectSharedPtr kanzi::connect::SortFilterProxyDataSourceAbs::findColumnItemFromListItem	(	const DataObjectSharedPtr	listItem,
		unsigned int	column
	)

staticprotected

Find the data object that contains the value within individual list item.

Parameters

listItem	The list item which contains the value items as children
column	Identifies which child to return

Returns: The data object that contains the wanted value

◆ getColumnCount()

size_t kanzi::connect::SortFilterProxyDataSourceAbs::getColumnCount ( ) const

protected

How many columns (fields) the list item has.

Returns: The column count

◆ getData()

virtual DataObjectSharedPtr kanzi::connect::SortFilterProxyDataSourceAbs::getData ( )

virtual

See also: kanzi::DataSource

◆ getStringValueFromColumnFieldItem()

string kanzi::connect::SortFilterProxyDataSourceAbs::getStringValueFromColumnFieldItem ( DataObjectSharedPtr item ) const

protected

Convenience function to get value in string format from DataObject.

Parameters

item	The DataObject that has a value

Returns: The value in string format

◆ getStringValueFromListItem()

string kanzi::connect::SortFilterProxyDataSourceAbs::getStringValueFromListItem	(	const DataObjectSharedPtr	listItem,
		unsigned int	column
	)		const

protected

Convenience function to get value in string format from given list item.

Parameters

listItem	The list item which contains the value
column	Specifies the column withing the list item

Returns: The value in string format

◆ isIncluded()

virtual bool kanzi::connect::SortFilterProxyDataSourceAbs::isIncluded ( const DataObjectSharedPtr & object ) const

protectedvirtual

Subclasses may override this to implement filtering functionality.

Parameters

object The data object to test

Returns: true if the object is to be included in the list

Implements kanzi::connect::SortFilterDataObjectList::SortFilterInterface.

Reimplemented in kanzi::connect::DefaultSortFilterDataSource.

◆ isLessThan()

virtual bool kanzi::connect::SortFilterProxyDataSourceAbs::isLessThan	(	const DataObjectSharedPtr &	lhs,
		const DataObjectSharedPtr &	rhs
	)		const

protectedvirtual

Subclasses may override this to implement sorting functionality.

Parameters

lhs	The left side of <
rhs	The right side of <

Returns: True if lhs < rhs

Implements kanzi::connect::SortFilterDataObjectList::SortFilterInterface.

Reimplemented in kanzi::connect::DefaultSortFilterDataSource.

◆ KZ_METACLASS_END()

kanzi::connect::SortFilterProxyDataSourceAbs::KZ_METACLASS_END ( )

◆ onLoaded()

virtual void kanzi::connect::SortFilterProxyDataSourceAbs::onLoaded ( )

protectedvirtual

Called by Kanzi after loading the KZB file of the application.

◆ onOriginalDataSourceChangedOverride()

virtual void kanzi::connect::SortFilterProxyDataSourceAbs::onOriginalDataSourceChangedOverride ( )

protectedvirtual

Subclasses may override this to get event that the original data source has changed and may do validation on sort/filter conditions.

Reimplemented in kanzi::connect::DefaultSortFilterDataSource.

◆ refreshFiltering()

void kanzi::connect::SortFilterProxyDataSourceAbs::refreshFiltering ( )

protected

Request filtering and then sorting the list contents.

◆ refreshSorting()

void kanzi::connect::SortFilterProxyDataSourceAbs::refreshSorting ( )

protected

Request resorting the list contents.

◆ unloadOverride()

virtual void kanzi::connect::SortFilterProxyDataSourceAbs::unloadOverride ( )

virtual

See also: kanzi::Resource

Member Data Documentation

◆ ItemSourceProperty

PropertyType<string> kanzi::connect::SortFilterProxyDataSourceAbs::ItemSourceProperty

static

◆ OriginalDataContextProperty

PropertyType<ResourceSharedPtr> kanzi::connect::SortFilterProxyDataSourceAbs::OriginalDataContextProperty

static

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

connect/kanzi_adaptation/sort_filter_proxy_datasource/sort_filter_proxy_datasource_abs.hpp

Public Member Functions

Static Public Attributes

Protected Member Functions

Static Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ~SortFilterProxyDataSourceAbs()

◆ SortFilterProxyDataSourceAbs()

Member Function Documentation

◆ findColumnItemFromListItem()

◆ getColumnCount()

◆ getData()

◆ getStringValueFromColumnFieldItem()

◆ getStringValueFromListItem()

◆ isIncluded()

◆ isLessThan()

◆ KZ_METACLASS_END()

◆ onLoaded()

◆ onOriginalDataSourceChangedOverride()

◆ refreshFiltering()

◆ refreshSorting()

◆ unloadOverride()

Member Data Documentation

◆ ItemSourceProperty

◆ OriginalDataContextProperty