Kanzi Framework  3.9.0
Kanzi Engine API
kanzi::RangeConceptImpl< TBaseClass, TDerivedClass > Class Template Reference

#include <kanzi/ui/node/concept/range.hpp>

Inheritance diagram for kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >:
[legend]

Public Member Functions

float getMaximumValue () const
 Gets the value of MaximumValueProperty. More...
 
float getMinimumValue () const
 Gets the value of MinimumValueProperty. More...
 
float getNormalizedValue () const
 Gets the value of NormalizedValueProperty. More...
 
float getStep () const
 Gets the value of StepProperty. More...
 
float getValue () const
 Gets the value of ValueProperty. More...
 
void goToMaximumValue ()
 Sets the value to value in MaximumValueProperty. More...
 
void goToMinimumValue ()
 Sets the value to value in MinimumValueProperty. More...
 
void goToNextValue ()
 Increases the value by amount of StepProperty. More...
 
void goToPreviousValue ()
 Decreases the value by amount of StepProperty. More...
 
bool isValueChanging () const
 Gets the value of IsValueChangingProperty. More...
 
 RangeConceptImpl (Domain *domain, string_view name)
 
template<class MessageT >
void sendRangeMessage (const MessageT &messageType)
 
void setMaximumValue (float value)
 Sets the value of MaximumValueProperty. More...
 
void setMinimumValue (float value)
 Sets the value of MinimumValueProperty. More...
 
void setNormalizedValue (float value)
 Sets the value of NormalizedValueProperty. More...
 
void setStep (float value)
 Sets the value of StepProperty. More...
 
void setValue (float value)
 Sets the value of ValueProperty. More...
 

Static Public Member Functions

static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 
- Static Public Member Functions inherited from kanzi::RangeConcept
static PropertyTypeEditorInfoSharedPtr makeEditorInfo ()
 

Protected Member Functions

TDerivedClass * getThisObject ()
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
const TDerivedClass * getThisObject () const
 Internal accessor for the Curiously Recurring Template Pattern. More...
 
void onNodePropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason) override
 

Additional Inherited Members

- Static Public Attributes inherited from kanzi::RangeConcept
static MessageType< ValueChangedMessageArgumentsValueChangedMessage
 
static MessageType< ValueChangeFinishedMessageArgumentsValueChangeFinishedMessage
 
static MessageType< ValueChangeStartedMessageArgumentsValueChangeStartedMessage
 
static PropertyType< float > MinimumValueProperty
 
static PropertyType< float > MaximumValueProperty
 Sets the maximum value that the range allows. More...
 
static PropertyType< float > StepProperty
 Sets the minimum change of the value in the range. More...
 
static PropertyType< float > ValueProperty
 Reports the value in the range. More...
 
static PropertyType< float > NormalizedValueProperty
 Reports the normalized value in the range. More...
 
static PropertyType< bool > IsValueChangingProperty
 Reports whether the value is changing because of user interaction. More...
 

Constructor & Destructor Documentation

◆ RangeConceptImpl()

template<class TBaseClass , class TDerivedClass >
kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::RangeConceptImpl ( Domain domain,
string_view  name 
)
explicit

Member Function Documentation

◆ makeEditorInfo()

template<class TBaseClass , class TDerivedClass >
PropertyTypeEditorInfoSharedPtr kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::makeEditorInfo ( )
static

◆ sendRangeMessage()

template<class TBaseClass , class TDerivedClass >
template<class MessageT >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::sendRangeMessage ( const MessageT &  messageType)

◆ getMinimumValue()

template<class TBaseClass , class TDerivedClass >
float kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getMinimumValue ( ) const

Gets the value of MinimumValueProperty.

See also
setRangeMinimum()

◆ setMinimumValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::setMinimumValue ( float  value)

Sets the value of MinimumValueProperty.

See also
getRangeMinimum()

◆ getMaximumValue()

template<class TBaseClass , class TDerivedClass >
float kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getMaximumValue ( ) const

Gets the value of MaximumValueProperty.

See also
setRangeMaximum()

◆ setMaximumValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::setMaximumValue ( float  value)

Sets the value of MaximumValueProperty.

See also
getRangeMaximum()

◆ getStep()

template<class TBaseClass , class TDerivedClass >
float kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getStep ( ) const

Gets the value of StepProperty.

See also
setRangeStep()

◆ setStep()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::setStep ( float  value)

Sets the value of StepProperty.

See also
getRangeStep()

◆ getValue()

template<class TBaseClass , class TDerivedClass >
float kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getValue ( ) const

Gets the value of ValueProperty.

See also
setRangeValue()

◆ setValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::setValue ( float  value)

Sets the value of ValueProperty.

See also
getRangeValue()

◆ getNormalizedValue()

template<class TBaseClass , class TDerivedClass >
float kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getNormalizedValue ( ) const

Gets the value of NormalizedValueProperty.

See also
setNormalizedValue()

◆ setNormalizedValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::setNormalizedValue ( float  value)

Sets the value of NormalizedValueProperty.

See also
getNormalizedValue()

◆ isValueChanging()

template<class TBaseClass , class TDerivedClass >
bool kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::isValueChanging ( ) const

Gets the value of IsValueChangingProperty.

◆ goToNextValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::goToNextValue ( )

Increases the value by amount of StepProperty.

See also
goToPreviousValue(), goToMinimumValue(), goToMaximumValue()

◆ goToPreviousValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::goToPreviousValue ( )

Decreases the value by amount of StepProperty.

See also
goToNextValue(), goToMinimumValue(), goToMaximumValue()

◆ goToMinimumValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::goToMinimumValue ( )

◆ goToMaximumValue()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::goToMaximumValue ( )

◆ getThisObject() [1/2]

template<class TBaseClass , class TDerivedClass >
TDerivedClass* kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getThisObject ( )
inlineprotected

Internal accessor for the Curiously Recurring Template Pattern.

◆ getThisObject() [2/2]

template<class TBaseClass , class TDerivedClass >
const TDerivedClass* kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::getThisObject ( ) const
inlineprotected

Internal accessor for the Curiously Recurring Template Pattern.

◆ onNodePropertyChanged()

template<class TBaseClass , class TDerivedClass >
void kanzi::RangeConceptImpl< TBaseClass, TDerivedClass >::onNodePropertyChanged ( AbstractPropertyType  propertyType,
PropertyNotificationReason  reason 
)
overrideprotected

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