kanzi::RangeConcept Class Reference

RangeConcept represents a number range with an optional step. More...

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

Inheritance diagram for kanzi::RangeConcept:

Classes
class	CommonMessageArguments
class	ValueChangedMessageArguments
class	ValueChangeFinishedMessageArguments
class	ValueChangeStartedMessageArguments

Static Public Member Functions
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes
static MessageType< ValueChangedMessageArguments >	ValueChangedMessage
static MessageType< ValueChangeFinishedMessageArguments >	ValueChangeFinishedMessage
static MessageType< ValueChangeStartedMessageArguments >	ValueChangeStartedMessage
Properties
Sets the minimum value that the range allows. The default value is 0.0f. See also setMinimumValue(), getMinimumValue()
static PropertyType< float >	MinimumValueProperty
static PropertyType< float >	MaximumValueProperty
	Sets the maximum value that the range allows.
static PropertyType< float >	StepProperty
	Sets the minimum change of the value in the range.
static PropertyType< float >	ValueProperty
	Reports the value in the range.
static PropertyType< float >	NormalizedValueProperty
	Reports the normalized value in the range.
static PropertyType< bool >	IsValueChangingProperty
	Reports whether the value is changing because of user interaction.

Detailed Description

RangeConcept represents a number range with an optional step.

Member Function Documentation

makeEditorInfo()

static PropertyTypeEditorInfoSharedPtr kanzi::RangeConcept::makeEditorInfo ( )

static

Member Data Documentation

MinimumValueProperty

PropertyType<float> kanzi::RangeConcept::MinimumValueProperty

static

MaximumValueProperty

PropertyType<float> kanzi::RangeConcept::MaximumValueProperty

static

Sets the maximum value that the range allows.

The default value is 1.0f.

See also

setMaximumValue(), getMaximumValue()

StepProperty

PropertyType<float> kanzi::RangeConcept::StepProperty

static

Sets the minimum change of the value in the range.

The default value is 0.0f.

See also

setStep(), getStep()

ValueProperty

PropertyType<float> kanzi::RangeConcept::ValueProperty

static

Reports the value in the range.

Kanzi always clamps the value to a valid range between the values set in the RangeConcept::MinimumValueProperty and RangeConcept::MaximumValueProperty. For example, if the value of RangeConcept::MaximumValueProperty is smaller than the value of RangeConcept::MinimumValueProperty, ValueProperty equals the value of RangeConcept::MinimumValueProperty.

Use this property to set the value in the range. To update the value in the range with a binding, use a TwoWayBinding or ToSourceBinding. During value validation the node that inherits the range concept internally overrides any one-way binding that targets this property. The default value is 0.0f.

See also

setValue(), getValue()

NormalizedValueProperty

PropertyType<float> kanzi::RangeConcept::NormalizedValueProperty

static

Reports the normalized value in the range.

The default value is 0.0f.

See also

setNormalizedValue(), getNormalizedValue()

IsValueChangingProperty

PropertyType<bool> kanzi::RangeConcept::IsValueChangingProperty

static

Reports whether the value is changing because of user interaction.

The default value is false.

See also

setIsValueChanging(), isIsValueChanging()

ValueChangeStartedMessage

MessageType<ValueChangeStartedMessageArguments> kanzi::RangeConcept::ValueChangeStartedMessage

static

ValueChangeFinishedMessage

MessageType<ValueChangeFinishedMessageArguments> kanzi::RangeConcept::ValueChangeFinishedMessage

static

ValueChangedMessage

MessageType<ValueChangedMessageArguments> kanzi::RangeConcept::ValueChangedMessage

static

---

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

• kanzi/ui/node/concept/range.hpp