The NavigationManipulatorComponent node component installs a NavigationManipulator to a node, and configures the navigation key gestures of the manipulator. More...
#include <kanzi/ui/node_component/input/navigation_manipulator_component.hpp>
Static Public Member Functions | |
static NavigationManipulatorComponentSharedPtr | create (Domain *domain, string_view name) |
Creates an instance of a NavigationManipulatorComponent node component. More... | |
static PropertyTypeEditorInfoSharedPtr | makeEditorInfo () |
Initializes and returns the Kanzi Studio editor information. More... | |
Static Public Member Functions inherited from kanzi::NodeComponent | |
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... | |
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... | |
Static Public Attributes | |
Properties | |
static PropertyType< LogicalKey > | UpNavigationKeyProperty |
The property that configures the logical key of the up navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | UpNavigationKeyModifierProperty |
The property that configures the key modifier of the up navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | DownNavigationKeyProperty |
The property that configures the logical key of the down navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | DownNavigationKeyModifierProperty |
The property that configures the key modifier of the down navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | LeftNavigationKeyProperty |
The property that configures the logical key of the left navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | LeftNavigationKeyModifierProperty |
The property that configures the key modifier of the left navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | RightNavigationKeyProperty |
The property that configures the logical key of the right navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | RightNavigationKeyModifierProperty |
The property that configures the key modifier of the right navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | HomeNavigationKeyProperty |
The property that configures the logical key of the home navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | HomeNavigationKeyModifierProperty |
The property that configures the key modifier of the home navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | EndNavigationKeyProperty |
The property that configures the logical key of the end navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | EndNavigationKeyModifierProperty |
The property that configures the key modifier of the end navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | PageUpNavigationKeyProperty |
The property that configures the logical key of the page up navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | PageUpNavigationKeyModifierProperty |
The property that configures the key modifier of the page up navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< LogicalKey > | PageDownNavigationKeyProperty |
The property that configures the logical key of the page down navigation direction of the installed NavigationManipulator. More... | |
static PropertyType< KeyModifier > | PageDownNavigationKeyModifierProperty |
The property that configures the key modifier of the page down navigation direction of the installed NavigationManipulator. More... | |
Static Public Attributes inherited from kanzi::NodeComponent | |
static PropertyType< string > | NameProperty |
Name property specifies the name of node component. More... | |
Protected Member Functions | |
void | attachOverride () final |
NodeComponent::attachOverride() implementation. More... | |
void | detachOverride () final |
NodeComponent::detachOverride() implementation. More... | |
NavigationManipulatorComponent (Domain *domain, string_view name) | |
Constructor. More... | |
void | onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) final |
NodeComponent::onPropertyChanged implementation. More... | |
Protected Member Functions inherited from kanzi::NodeComponent | |
template<typename TMessageType , typename TClass , typename TMethod > | |
Node::MessageSubscriptionToken | addNodeComponentMessageHandler (TMessageType &messageType, TClass *messageHandlerObject, TMethod method) |
Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of this node component, or if the message is broadcast to all node components with an empty target name. More... | |
template<typename TMessageType > | |
Node::MessageSubscriptionToken | addNodeComponentMessageHandler (TMessageType &messageType, typename TMessageType::FunctionType function) |
Kanzi calls the message handler that you add using this function when the target name of the incoming message matches the name of the node component, or if the message is broadcast to all node components with an empty target name. More... | |
void | dispatchAbstractMessage (const AbstractMessageType &messageType, MessageArguments &messageArguments) |
Adds the name of the node component to the abstract message arguments and dispatches the message to the node of the node component. More... | |
template<typename TArgumentsType > | |
void | dispatchMessage (const MessageType< TArgumentsType > &messageType, typename MessageType< TArgumentsType >::ArgumentsType &messageArguments) |
Adds the name of the node component to the message arguments and dispatches the message to the node of the node component. More... | |
NodeComponent (Domain *domain, string_view name) | |
Constructor. More... | |
void | removeNodeComponentMessageFilter (Node::MessageSubscriptionToken subscriptionToken) |
Removes message handler added via addNodeComponentMessageHandler function. 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) |
template<typename DataType > | |
void | addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify) |
Adds a property modifier entry to the property modifier stack and validates them. More... | |
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 &storagePtr, PropertyNotificationReason reason) |
Notifies all property handlers on a property storage. More... | |
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 | validatePropertyModifiers (PropertyStoragePtr &propertyStorage) |
Validates property modifiers without notifying handlers. More... | |
void | validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage) |
Validates property modifiers and notifies handlers. More... | |
Additional Inherited Members | |
Public Types inherited from kanzi::NodeComponent | |
using | NodeComponentMessageArguments = NodeComponentTargetMessageArguments |
Legacy name for NodeComponentTargetMessageArguments. More... | |
enum | State { StateDetached, StateDetaching, StateAttaching, StateAttached } |
State indicating if component is attached to a node, detached from any node or in process of attaching/detaching. 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::NodeComponent | |
void | attach (NodeWeakPtr node) |
Attaches node component to node. More... | |
void | detach () |
Detaches node component from the node it was attached to. More... | |
string | getName () const |
Gets the name of node component. More... | |
NodeSharedPtr | getNode () const |
Returns the node the node component is attached to or null pointer if node component is not attached to a node. More... | |
State | getState () const |
Gets the state of node component indicating if component is attached to a node, detached from any node or in process of attaching/detaching. More... | |
bool | isAttached () const |
Indicates whether node component is attached to a node. More... | |
bool | isAttaching () const |
Indicates whether node component is in the process of attaching to a node. More... | |
bool | isAttachingOrAttached () const |
Indicates whether node component is in the process of attaching to a node or already attached. More... | |
bool | isDetached () const |
Indicates whether node component is detached from any node. More... | |
bool | isDetaching () const |
Indicates whether node component currently detaching from the node. More... | |
bool | isDetachingOrDetached () const |
Indicates whether node component is in the process of detaching from the node or already detached. More... | |
void | setName (string_view name) |
Sets the name of node component. More... | |
~NodeComponent () 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 | addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner) |
Adds a property modifier without notifying handlers. More... | |
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 |
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) |
KZ_DEPRECATED void | validatePropertyModifiers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. More... | |
void | validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType) |
Validates property modifiers and notifies handlers. More... | |
virtual | ~PropertyObject () |
Protected Types inherited from kanzi::Object | |
typedef vector< AppliedStyleEntrySharedPtr > | AppliedStyleContainer |
Applied style container. More... | |
Static Protected Member Functions inherited from kanzi::NodeComponent | |
template<typename TMessageType > | |
static void | nodeComponentMessageHandler (const NodeComponent *nodeComponent, const typename TMessageType::FunctionType &function, typename TMessageType::ArgumentsType &messageArguments) |
Handler function for node component messages. More... | |
Protected Attributes inherited from kanzi::Object | |
AppliedStyleContainer | m_appliedStyles |
Listing of applied styles applied to this object. More... | |
The NavigationManipulatorComponent node component installs a NavigationManipulator to a node, and configures the navigation key gestures of the manipulator.
|
explicitprotected |
Constructor.
domain | The domain that holds the NavigationManipulatorComponent. |
name | The name of the NavigationManipulatorComponent instance. |
|
static |
Initializes and returns the Kanzi Studio editor information.
|
static |
Creates an instance of a NavigationManipulatorComponent node component.
domain | The domain that holds the NavigationManipulatorComponent. |
name | The name of the NavigationManipulatorComponent instance. |
|
finalprotectedvirtual |
NodeComponent::attachOverride() implementation.
Reimplemented from kanzi::NodeComponent.
|
finalprotectedvirtual |
NodeComponent::detachOverride() implementation.
Reimplemented from kanzi::NodeComponent.
|
finalprotectedvirtual |
NodeComponent::onPropertyChanged implementation.
propertyType | The property type that identifies the property that has changed. |
reason | The reason that caused the property notification to be invoked. |
Reimplemented from kanzi::PropertyObject.
|
static |
The property that configures the logical key of the up navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the up navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the down navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the down navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the left navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the left navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the right navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the right navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the home navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the home navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the end navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the end navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the page up navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the page up navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.
|
static |
The property that configures the logical key of the page down navigation direction of the installed NavigationManipulator.
The default value is LogicalKey::Unknown.
|
static |
The property that configures the key modifier of the page down navigation direction of the installed NavigationManipulator.
The default value is KeyModifier::Undefined.