#include <kanzi/node/concept/list_box/list_box_item_generator.hpp>
Public Types | |
typedef Node2D | ListBoxType |
typedef Node2D | Item |
typedef Node2DSharedPtr | ItemSharedPtr |
typedef Item::LayoutVectorType | VectorType |
Public Member Functions | |
virtual void | attach (ListBoxType &node)=0 |
Attaches the Object Generator. More... | |
virtual void | detach (ListBoxType &node)=0 |
Detaches the Object Generator. More... | |
virtual ItemSharedPtr | acquireItem (size_t index)=0 |
Gets an object that should be displayed at the given index. More... | |
virtual void | releaseItem (ItemSharedPtr object)=0 |
Frees an object that has been returned from getObject. More... | |
virtual optional< size_t > | getItemIndex (ItemSharedPtr object)=0 |
Gets index of an object that has been returned from getObject, or KZU_UI_LIST_BOX_NO_ITEM if the object does not exist. More... | |
virtual VectorType | getItemSize (size_t index)=0 |
Gets exact size of the object that should be displayed at the given index. More... | |
virtual size_t | getCount ()=0 |
Gets the number of objects known by the object generator. More... | |
Public Member Functions inherited from kanzi::Object | |
Object (Domain *domain) | |
virtual | ~Object () |
Domain * | getDomain () const |
Returns the domain the object belongs to. More... | |
KzuPropertyManager * | getPropertyManager () const |
Returns the property manager of the object. More... | |
KzuTaskScheduler * | getTaskScheduler () const |
Returns the task scheduler of the object. More... | |
KzuMessageDispatcher * | getMessageDispatcher () const |
Returns the message dispatcher of the object. More... | |
ResourceManager * | getResourceManager () const |
Returns the resource manager of the object. More... | |
virtual const Metaclass * | getDynamicMetaclass () const |
Returns the metaclass of the dynamic type of the object. More... | |
bool | isTypeOf (const Metaclass *objectType) const |
Determines if the type of this object is the given type or derived from it. More... | |
template<typename DataType > | |
void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType value) |
Sets the local value of a property. More... | |
void | setProperty (const PropertyType< ResourceID > &propertyType, ResourceSharedPtr value) |
Sets the local value of a resource id property with a resource pointer. More... | |
template<typename DataType > | |
DataType | getProperty (const PropertyType< DataType > &propertyType) const |
Returns the current value of a property. More... | |
template<typename DataType > | |
bool | getProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::DataType &value) const |
Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value. More... | |
template<typename DataType > | |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType value) |
void | setAbstractProperty (AbstractPropertyType abstractPropertyType, ResourceSharedPtr value) |
template<typename DataType > | |
DataType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
template<typename DataType > | |
bool | getAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::DataType &value) const |
bool | hasValue (AbstractPropertyType propertyType) const |
Evaluates whether there are any inputs into the property value. More... | |
bool | hasLocalValue (AbstractPropertyType propertyType) const |
Evaluates whether there is a local value set for the property. More... | |
void | removeLocalValue (AbstractPropertyType propertyType) |
Removes the local value associated with the property. More... | |
void | copyLocalValues (const Object &other) |
Copies all local values from another object. More... | |
virtual void | onPropertyChanged (AbstractPropertyType propertyType, KzuPropertyNotificationReason reason) |
Virtual function to handle property change notifications. More... | |
AppliedStyleEntry * | applyObjectStyle (kanzi::StyleSharedPtr style) |
Applies a style to an object. More... | |
void | unapplyObjectStyle (AppliedStyleEntry *appliedStyleEntry) |
void | applyObjectStyles () |
Apply all styles for an object node. More... | |
void | unapplyObjectStyles () |
Unapplies and removes all applied styles. More... | |
Static Public Member Functions | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Static Public Member Functions inherited from kanzi::Object | |
static const Metaclass * | getStaticMetaclass () |
Returns the metaclass of Object class. More... | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Default implementation that returns empty editor info. More... | |
Protected Member Functions | |
ListBoxItemGenerator2D (Domain *domain) | |
virtual | ~ListBoxItemGenerator2D () |
Destructor. More... | |
Protected Member Functions inherited from kanzi::Object | |
void | initialize () |
void | onCopy (const Object &other) |
Additional Inherited Members | |
Protected Types inherited from kanzi::Object | |
typedef vector < AppliedStyleEntry * > | AppliedStyleContainer |
Applied style container. More... | |
Protected Attributes inherited from kanzi::Object | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. More... | |
|
inlineexplicitprotected |
|
inlineprotectedvirtual |
Destructor.
|
inlinestatic |
|
pure virtual |
Attaches the Object Generator.
|
pure virtual |
Detaches the Object Generator.
|
pure virtual |
Gets an object that should be displayed at the given index.
If the object has already been created and not freed afterwards, returns the object from cache.
|
pure virtual |
Frees an object that has been returned from getObject.
|
pure virtual |
Gets index of an object that has been returned from getObject, or KZU_UI_LIST_BOX_NO_ITEM if the object does not exist.
|
pure virtual |
Gets exact size of the object that should be displayed at the given index.
This size will be used unless the list box is provided an object prototype. If it is not possible to determine item size without acquiring the item first, unbounded layout value should be returned. Caching the sizes may be a good idea.
|
pure virtual |
Gets the number of objects known by the object generator.
Last index can be calculated as 'count' - 1.