Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::DataSourceListItemGenerator< TBaseGenerator > Class Template Reference

#include <kanzi/ui/node/concept/list_box/data_source_list_item_generator.hpp>

Inheritance diagram for kanzi::DataSourceListItemGenerator< TBaseGenerator >:
[legend]

Public Types

typedef shared_ptr< DataSourceListItemGenerator< TBaseGenerator > > DataSourceListItemGeneratorSharedPtr
 

Public Member Functions

TBaseGenerator::ItemSharedPtr acquireItem (size_t index) override
 
void attach (typename TBaseGenerator::ListBoxType &node) override
 
void detach (typename TBaseGenerator::ListBoxType &node) override
 
size_t getCount () override
 
optional< size_t > getItemIndex (typename TBaseGenerator::ItemSharedPtr object) override
 
TBaseGenerator::VectorType getItemSize (size_t index) override
 
void releaseItem (typename TBaseGenerator::ItemSharedPtr object) override
 
 ~DataSourceListItemGenerator () override
 

Static Public Member Functions

static DataSourceListItemGeneratorSharedPtr create (Domain *domain, string_view name)
 
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

TBaseGenerator::ItemSharedPtr acquireItem (ResourceSharedPtr dataObjectResource)
 
 DataSourceListItemGenerator (Domain *domain)
 
void freeRecycledItems ()
 
void onDataSourceUpdated (const ResourceSharedPtr &dataSource, PropertyNotificationReason reason)
 
PrefabTemplateSharedPtr updateItemPrototype (typename TBaseGenerator::ListBoxType *listBox)
 
DataObjectListSharedPtr updateItemsSource (typename TBaseGenerator::ListBoxType *listBox)
 

Static Protected Member Functions

static ResourceSharedPtr getDataContext (Node &node)
 
static void onDataSourceUpdatedCallback (PropertyObject &object, const ResourceSharedPtr &dataSource, PropertyNotificationReason reason, void *userData)
 

Member Typedef Documentation

◆ DataSourceListItemGeneratorSharedPtr

template<typename TBaseGenerator>
typedef shared_ptr<DataSourceListItemGenerator<TBaseGenerator> > kanzi::DataSourceListItemGenerator< TBaseGenerator >::DataSourceListItemGeneratorSharedPtr

Constructor & Destructor Documentation

◆ ~DataSourceListItemGenerator()

template<typename TBaseGenerator >
kanzi::DataSourceListItemGenerator< TBaseGenerator >::~DataSourceListItemGenerator ( )
override

◆ DataSourceListItemGenerator()

template<typename TBaseGenerator >
kanzi::DataSourceListItemGenerator< TBaseGenerator >::DataSourceListItemGenerator ( Domain domain)
explicitprotected

Member Function Documentation

◆ makeEditorInfo()

template<typename TBaseGenerator >
PropertyTypeEditorInfoSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::makeEditorInfo ( )
static

◆ create()

template<typename TBaseGenerator >
DataSourceListItemGenerator< TBaseGenerator >::DataSourceListItemGeneratorSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::create ( Domain domain,
string_view  name 
)
static

◆ attach()

template<typename TBaseGenerator>
void kanzi::DataSourceListItemGenerator< TBaseGenerator >::attach ( typename TBaseGenerator::ListBoxType &  node)
override

◆ detach()

template<typename TBaseGenerator>
void kanzi::DataSourceListItemGenerator< TBaseGenerator >::detach ( typename TBaseGenerator::ListBoxType &  node)
override

◆ acquireItem() [1/2]

template<typename TBaseGenerator >
TBaseGenerator::ItemSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::acquireItem ( size_t  index)
override

◆ releaseItem()

template<typename TBaseGenerator>
void kanzi::DataSourceListItemGenerator< TBaseGenerator >::releaseItem ( typename TBaseGenerator::ItemSharedPtr  object)
override

◆ getItemIndex()

template<typename TBaseGenerator>
optional< size_t > kanzi::DataSourceListItemGenerator< TBaseGenerator >::getItemIndex ( typename TBaseGenerator::ItemSharedPtr  object)
override

◆ getItemSize()

template<typename TBaseGenerator >
TBaseGenerator::VectorType kanzi::DataSourceListItemGenerator< TBaseGenerator >::getItemSize ( size_t  index)
override

◆ getCount()

template<typename TBaseGenerator >
size_t kanzi::DataSourceListItemGenerator< TBaseGenerator >::getCount ( )
override

◆ updateItemsSource()

template<typename TBaseGenerator>
DataObjectListSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::updateItemsSource ( typename TBaseGenerator::ListBoxType *  listBox)
protected

◆ updateItemPrototype()

template<typename TBaseGenerator>
PrefabTemplateSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::updateItemPrototype ( typename TBaseGenerator::ListBoxType *  listBox)
protected

◆ acquireItem() [2/2]

template<typename TBaseGenerator >
TBaseGenerator::ItemSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::acquireItem ( ResourceSharedPtr  dataObjectResource)
protected

◆ getDataContext()

template<typename TBaseGenerator >
ResourceSharedPtr kanzi::DataSourceListItemGenerator< TBaseGenerator >::getDataContext ( Node node)
staticprotected

◆ freeRecycledItems()

template<typename TBaseGenerator >
void kanzi::DataSourceListItemGenerator< TBaseGenerator >::freeRecycledItems ( )
protected

◆ onDataSourceUpdatedCallback()

template<typename TBaseGenerator >
void kanzi::DataSourceListItemGenerator< TBaseGenerator >::onDataSourceUpdatedCallback ( PropertyObject object,
const ResourceSharedPtr dataSource,
PropertyNotificationReason  reason,
void *  userData 
)
staticprotected

◆ onDataSourceUpdated()

template<typename TBaseGenerator >
void kanzi::DataSourceListItemGenerator< TBaseGenerator >::onDataSourceUpdated ( const ResourceSharedPtr dataSource,
PropertyNotificationReason  reason 
)
protected

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