Implementation of DataObjectTyped<string, DataObject::String>. More...
#include <kanzi/core.ui/data/data_object.hpp>
Static Public Member Functions | |
| static DataObjectStringSharedPtr | create (Domain *domain, string_view name, string_view value) |
| Create a DataObjectString. More... | |
| static DataObjectStringSharedPtr | create (Domain *domain, string_view name) |
| Create a DataObjectString. More... | |
 Static Public Member Functions inherited from kanzi::DataObject | |
| static DataObjectSharedPtr | create (Domain *domain, string_view name) |
| Create a DataObject. More... | |
| Static Public Member Functions inherited from kanzi::DataContext | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| static ResourceSharedPtr | getDataContext (const Node &node) |
| Gets the value of DataContextProperty. More... | |
| static void | setDataContext (Node &node, ResourceSharedPtr value) |
| Sets the value of DataContextProperty. More... | |
| static ResourceSharedPtr | getItemsSource (const Node &node) |
| Gets the value of ItemsSourceProperty. More... | |
| static void | setItemsSource (Node &node, ResourceSharedPtr value) |
| Sets the value of ItemsSourceProperty. More... | |
| 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... | |
| Static Public Member Functions inherited from kanzi::MetaObject | |
| static const Metaclass * | getStaticMetaclass () |
| Returns the metaclass of Object class. More... | |
| static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
| Default implementation that returns empty editor info. More... | |
Additional Inherited Members | |
| Public Types inherited from kanzi::DataObject | |
| typedef ChildContainer::const_iterator | ChildConstIterator |
| typedef ChildContainer::const_reverse_iterator | ChildConstReverseIterator |
| typedef vector< DataObjectSharedPtr > | ChildContainer |
| enum | Type { Object, Integer, Real, Bool, String, Enum, List } |
| Type enumerations for different data object types. More... | |
| Public Types inherited from kanzi::DataContext | |
| typedef function< void()> | ModifiedFunction |
| Callback function type for change subscriptions. More... | |
| typedef shared_ptr< void > | ModifiedSubscriptionToken |
| Token type that can be used to identify the change subscription. More... | |
| Public Types inherited from kanzi::PropertyObject | |
| typedef PropertyStorageContainer::const_iterator | PropertyStorageConstIterator |
| typedef vector< PropertyStoragePtr > | PropertyStorageContainer |
| typedef PropertyStorageContainer::iterator | PropertyStorageIterator |
| typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage > | PropertyStoragePtr |
| typedef PropertyStorageContainer::reverse_iterator | PropertyStorageReverseIterator |
| Public Member Functions inherited from kanzi::DataObjectTyped< string, DataObject::String > | |
| DataObjectTyped (Domain *domain, string_view name, string value) | |
| Constructor that initializes a typed data object from name and value. More... | |
| DataObjectTyped (Domain *domain, string_view name) | |
| Constructor that initializes a typed data object from name and value. More... | |
| Type | getType () const override |
| Retrieves the type of this data object. More... | |
| string | getValue () const |
| Retrieves the value that is represented by this data object. More... | |
| Variant | readVariant () override |
| DataObject::readVariant() implementation. More... | |
| void | setValue (typename DataObjectTypeTraits< string >::ParameterType value) |
| Sets the value of this data object. More... | |
| Public Member Functions inherited from kanzi::DataObject | |
| void | addChild (const DataObjectSharedPtr &child) |
| Adds data object as child of this object. More... | |
| ChildConstIterator | beginChildren () const |
| Returns iterator to start of the child container. More... | |
| ChildConstIterator | endChildren () const |
| Returns iterator in the end of the child container. More... | |
| DataObjectSharedPtr | findChild (string_view name) |
| Tries to find a child with given name. More... | |
| DataObjectSharedPtr | getChild (size_t index) const |
| Retrieves a child object in given index. More... | |
| size_t | getChildCount () const |
| Retrieves the count of child objects in this data object. More... | |
| size_t | getChildIndex (const DataObject &child) const |
| Retrieves the index of a child data object. More... | |
| DataObjectSharedPtr | getData () override |
| DataContext interface. More... | |
| string | getName () const |
| Allows to retrieve the name of the object. More... | |
| DataObjectSharedPtr | getParent () const |
| Retrieves the parent DataObject of this DataObject. More... | |
| bool | hasChild (const DataObject &child) const |
| Checks whether or not the child exists. More... | |
| void | insertChild (size_t index, const DataObjectSharedPtr &child) |
| Inserts data object as child of this object, allows to specify index of the object. More... | |
| DataContextSharedPtr | lookupDataContext (string_view relativePath) override |
| Performs object look-up by path. More... | |
| void | removeAllChildren () |
| Removes all children. More... | |
| void | removeChild (const DataObject &child) |
| Removes a child object from the list of children. More... | |
| void | removeChild (size_t index) |
| Removes a child object in given index. More... | |
| void | setName (string_view value) |
| Sets the name of the object. More... | |
| void | setParent (DataObjectSharedPtr parent) |
| Assigns a parent DataObject to this DataObject. More... | |
| Public Member Functions inherited from kanzi::DataContext | |
| ModifiedSubscriptionToken | addModifiedNotificationHandler (ModifiedFunction callback) |
| Allows to subscribe to modifications in this data context. More... | |
| template<typename Type > | |
| shared_ptr< Type > | lookupDataContextOfType (string_view relativePath) |
| void | notifyModified () |
| Triggers modification procedure in this data context, which invokes the subscriptions. More... | |
| void | removeModifiedNotificationHandler (ModifiedSubscriptionToken token) |
| Allows to unsubscribe from modifications in this data context. More... | |
| Public Member Functions inherited from kanzi::Resource | |
| virtual unsigned int | getCPUMemoryUsage () const |
| Function for getting the memory usage of a resource. More... | |
| const string & | getName () const |
| Gets the resource name. More... | |
| const string & | getUrl () const |
| Gets the resource URL. More... | |
| bool | isKeepAlive () const |
| Tells if the resource has keep alive flag set. More... | |
| void | reload () |
| void | reloadFromFile (string_view filePath) |
| void | reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) |
| void | setKeepAlive (bool keepAlive) |
| Sets the keep alive flag. More... | |
| void | setUrl (string_view url) |
| Sets the resource URL. More... | |
| ~Resource () override | |
| Destructor. More... | |
| Public Member Functions inherited from kanzi::Object | |
| AppliedStyleEntrySharedPtr | applyObjectStyle (kanzi::StyleSharedPtr style) |
| Applies a style to an object. More... | |
| void | applyObjectStyles () |
| Apply all styles for an object node. More... | |
| Domain * | getDomain () const |
| Returns the domain the object belongs to. More... | |
| const Metaclass * | getDynamicMetaclass () const override |
| Returns the metaclass of the dynamic type of the object. More... | |
| MainLoopScheduler * | getMainLoopScheduler () const |
| Returns the MainLoopScheduler instance of the associated Domain. More... | |
| detail::MessageDispatcher * | getMessageDispatcher () const |
| Returns the message dispatcher of the object. More... | |
| ResourceManager * | getResourceManager () const |
| Returns the resource manager of the object. More... | |
| ScriptingContextSharedPtr | getScriptingContext () const |
| Gets the scripting context of the object. More... | |
| Object (Domain *domain) | |
| void | setScriptingContext (ScriptingContextSharedPtr context) |
| Sets the scripting context of the object. More... | |
| void | unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry) |
| void | unapplyObjectStyles () |
| Unapplies and removes all applied styles. More... | |
| ~Object () override | |
| Public Member Functions inherited from kanzi::MetaObject | |
| bool | isTypeOf (const Metaclass *objectType) const |
| Determines if the type of this object is the given type or derived from it. More... | |
| virtual | ~MetaObject () |
| Public Member Functions inherited from kanzi::PropertyObject | |
| template<typename DataType > | |
| void | addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| template<typename DataType > | |
| void | addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| PropertyStorageContainer::iterator | beginPropertyStorage () |
| Returns the begin iterator to the internal property storage container. More... | |
| PropertyStorageContainer::const_iterator | beginPropertyStorage () const |
| Returns the begin iterator to the internal property storage container. More... | |
| void | clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| void | copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType) |
| Copies local value of single property from another object. More... | |
| void | copyLocalValues (const PropertyObject &other) |
| Copies all local values from another object. More... | |
| PropertyStorageContainer::iterator | endPropertyStorage () |
| Returns the end iterator to the internal property storage container. More... | |
| PropertyStorageContainer::const_iterator | endPropertyStorage () const |
| Returns the end iterator to the internal property storage container. More... | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const |
| template<typename DataType > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalProperty (const PropertyType< DataType > &propertyType) 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 > | |
| optional< typename PropertyType< DataType >::Traits::ReturnType > | getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value. More... | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getProperty (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property type. More... | |
| template<typename DataType > | |
| PropertyType< DataType >::Traits::ReturnType | getPropertyBase (const PropertyType< DataType > &propertyType) const |
| Returns the current value of a property disregarding modifiers. More... | |
| template<typename DataType > | |
| size_t | getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const |
| Gets number of current notification handlers for given property type. More... | |
| bool | hasBaseValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value, disregarding modifiers. More... | |
| bool | hasLocalValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a local value set for the property. More... | |
| bool | hasNonClassValue (AbstractPropertyType propertyType) const |
| Evaluates whether there is a value of any precedence higher than class default value set for the property. More... | |
| bool | hasValue (AbstractPropertyType propertyType) const |
| Evaluates whether there are any inputs into the property value. More... | |
| bool | isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const |
| virtual void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) |
| Virtual function to handle property change notifications. More... | |
| PropertyObject () | |
| void | removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties) |
| Remove all KZB properties that are not included in a given set. More... | |
| void | removeKzbProperties () |
| Remove all KZB properties. More... | |
| template<typename DataType > | |
| void | removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| void | removeLocalValue (AbstractPropertyType propertyType) |
| Removes the local value associated with the property. More... | |
| template<typename DataType > | |
| void | removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner) |
| template<typename DataType > | |
| void | removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource *valueSource, void *ownerPointer) |
| template<typename DataType > | |
| void | setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| template<typename DataType > | |
| void | setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value) |
| Sets the local value of a property type. More... | |
| void | setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag) |
| void | validatePropertyModifiers (AbstractPropertyType propertyType) |
| virtual | ~PropertyObject () |
| Static Public Attributes inherited from kanzi::DataContext | |
| static PropertyType< ResourceSharedPtr > | DataContextProperty |
| DataContext property. More... | |
| static PropertyType< ResourceSharedPtr > | ItemsSourceProperty |
| ItemsSource property. More... | |
| Protected Types inherited from kanzi::DataContext | |
| typedef vector< ModifiedSubscriptionSharedPtr > | ModifiedSubscriptionContainer |
| Container for subscriptions. More... | |
| typedef shared_ptr< ModifiedSubscription > | ModifiedSubscriptionSharedPtr |
| Subscription shared pointer type. More... | |
| Protected Types inherited from kanzi::Object | |
| typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
| Applied style container. More... | |
| Protected Member Functions inherited from kanzi::DataObject | |
| DataObject (Domain *domain, string_view name) | |
| Standard constructor. More... | |
| Protected Member Functions inherited from kanzi::DataContext | |
| DataContext (Domain *domain, string_view name) | |
| Protected standard constructor. More... | |
| Protected Member Functions inherited from kanzi::Resource | |
| virtual unsigned int | getCPUMemoryUsageOverride () const |
| virtual void | reloadFromFileOverride (string_view filePath) |
| virtual void | reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser) |
| virtual void | reloadOverride () |
| Resource (Domain *domain, string_view name) | |
| Constructor. More... | |
| Protected Member Functions inherited from kanzi::Object | |
| void | initialize () |
| void | onCopy (const Object &other) |
| Protected Member Functions inherited from kanzi::MetaObject | |
| void | initialize () |
| MetaObject () | |
| Protected Member Functions inherited from kanzi::PropertyObject | |
| AbstractPropertyTypeDescriptor::ValueSourceEntry * | acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| Acquires a local value source entry that is free for the assignment of a value. More... | |
| AbstractPropertyTypeDescriptor::ModifierStorage * | acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
| AbstractPropertyTypeDescriptor::NotificationStorage * | acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) |
| PropertyStoragePtr | acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
| void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, void *ownerPointer) |
| Internally adds a property value source. More... | |
| void | addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner *owner) |
| Internally adds a property value source. More... | |
| AbstractPropertyTypeDescriptor::ValueSourceEntry * | constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage) |
| PropertyStoragePtr | constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) |
| void | copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage) |
| Copy local value from property storage. More... | |
| AbstractPropertyTypeDescriptor::ModifierStorage * | findModifierStorage (AbstractPropertyTypeDescriptor &descriptor) |
| AbstractPropertyTypeDescriptor::NotificationStorage * | findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const |
| AbstractPropertyTypeDescriptor::PropertyStorage * | findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets the property storage for given property type descriptor. More... | |
| PropertyStoragePtr | findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation. More... | |
| AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const |
| Finds a property type descriptor by name and data type. More... | |
| AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const |
| Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names. More... | |
| AbstractPropertyTypeDescriptor * | findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const |
| Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names. More... | |
| AbstractPropertyTypeDescriptor::ValueSource * | getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| AbstractPropertyTypeDescriptor::ValueSource * | getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| AbstractPropertyTypeDescriptor::ValueSource * | getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| AbstractPropertyTypeDescriptor::ValueSource * | getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const |
| Gets the top-level value source for a given property descriptor. More... | |
| virtual void | notifyPropertyHandlers (PropertyStoragePtr &propertyStorage, PropertyNotificationReason reason) |
| void | onCopy (const PropertyObject &other) |
| void | removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage) |
| Removes a local value from the given property storage. More... | |
| void | removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource *valueSource, void *owner) |
| Removes a property value source. More... | |
| void | validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage) |
| Protected Attributes inherited from kanzi::DataContext | |
| unsigned int | m_notificationPassGuard |
| Notification pass guard integer for triggering removal at end. More... | |
| ModifiedSubscriptionContainer | m_subscriptions |
| Subscriptions to data context being modified. More... | |
| Protected Attributes inherited from kanzi::Object | |
| AppliedStyleContainer | m_appliedStyles |
| Listing of applied styles applied to this object. More... | |
Implementation of DataObjectTyped<string, DataObject::String>.
|
inlinestatic |
Create a DataObjectString.
| domain | The UI domain. |
| name | Name of the data object. |
| value | Initial value of the contained data. |
|
inlinestatic |
Create a DataObjectString.
| domain | The UI domain. |
| name | Name of the data object. |
