omni::ui::mixin::Range< VALUE > Struct Template Reference

Mixin for a ranged value with min and maximum. More...

#include <Range.h>

Inheritance diagram for omni::ui::mixin::Range< VALUE >:

Collaboration diagram for omni::ui::mixin::Range< VALUE >:

Public Types
typedef VALUE	value_type

Public Member Functions
	Range (value_type _minimum=0.0, value_type _maximum=100.0)
qreal	ratio (value_type _v) const
	Return ratio of value v. More...
value_type	range () const
	Return range (difference between maximum and minimum) More...
value_type	minimum () const
	Return minimum value. More...
value_type	maximum () const
	Return maximum value. More...
void	setMinimum (value_type _minimum)
	Set new minimum value and value and emit rangeChanged event. More...
void	disableMinimum ()
	Disable minimum by setting the value to infinite. More...
void	setMaximum (value_type _maximum)
	Set new maximum value and value and emit rangeChanged event. More...
void	disableMaximum ()
	Disable maximum by setting maximum to infinite value. More...
void	setRange (value_type _minimum, value_type _maximum)
	Set range and validate. More...
void	disableRange ()
	Disable range by setting minimum and maximum to infinite value. More...
bool	minimumUsed () const
bool	maximumUsed () const

Protected Member Functions
template<typename WIDGET >
void	apply (WIDGET *_widget) const
	Apply range to widget. More...
template<typename WIDGET , typename V >
void	apply (WIDGET *_widget, V _value) const
	Applay range to widget and set value. More...
virtual void	validate ()
	Validate minimum and maximum. More...
virtual void	rangeChangedEvent ()
	Handler to emit rangeChanged signal in derived widgets. More...

Private Attributes
value_type	minimum_
value_type	maximum_

Detailed Description

template<typename VALUE>
struct omni::ui::mixin::Range< VALUE >

Mixin for a ranged value with min and maximum.

Member Typedef Documentation

template<typename VALUE>

typedef VALUE omni::ui::mixin::Range< VALUE >::value_type

Constructor & Destructor Documentation

template<typename VALUE>

omni::ui::mixin::Range< VALUE >::Range ( value_type  _minimum = 0.0, value_type  _maximum = 100.0  )

inline

                                       :
          minimum_(_minimum),
          maximum_(_maximum)
        {}

Member Function Documentation

template<typename VALUE>

template<typename WIDGET >

void omni::ui::mixin::Range< VALUE >::apply ( WIDGET *  _widget ) const

inlineprotected

Apply range to widget.

          {
            _widget->setMinimum(minimum());
            _widget->setMaximum(maximum());
          }

template<typename VALUE>

template<typename WIDGET , typename V >

void omni::ui::mixin::Range< VALUE >::apply ( WIDGET *  _widget, V  _value  ) const

inlineprotected

Applay range to widget and set value.

          {
            apply(_widget);
            _widget->setValue(_value);
          }

template<typename VALUE>

void omni::ui::mixin::Range< VALUE >::disableMaximum ( )

inline

Disable maximum by setting maximum to infinite value.

        {
          setMaximum(std::numeric_limits<value_type>::max());
        }

template<typename VALUE>

void omni::ui::mixin::Range< VALUE >::disableMinimum ( )

inline

Disable minimum by setting the value to infinite.

        {
          setMinimum(std::numeric_limits<value_type>::min());
        }

template<typename VALUE>

void omni::ui::mixin::Range< VALUE >::disableRange ( )

inline

Disable range by setting minimum and maximum to infinite value.

        {
          setRange(
            std::numeric_limits<value_type>::min(),
            std::numeric_limits<value_type>::max());
        }

template<typename VALUE>

value_type omni::ui::mixin::Range< VALUE >::maximum ( ) const

inline

Return maximum value.

        {
          return maximum_;
        }

template<typename VALUE>

bool omni::ui::mixin::Range< VALUE >::maximumUsed ( ) const

inline

        {
          return maximum_ != std::numeric_limits<value_type>::max();
        }

template<typename VALUE>

value_type omni::ui::mixin::Range< VALUE >::minimum ( ) const

inline

Return minimum value.

        {
          return minimum_;
        }

template<typename VALUE>

bool omni::ui::mixin::Range< VALUE >::minimumUsed ( ) const

inline

        {
          return minimum_ != std::numeric_limits<value_type>::min();
        }

template<typename VALUE>

value_type omni::ui::mixin::Range< VALUE >::range ( ) const

inline

Return range (difference between maximum and minimum)

                                 {
          return maximum() - minimum();
        }

template<typename VALUE>

virtual void omni::ui::mixin::Range< VALUE >::rangeChangedEvent ( )

inlineprotectedvirtual

Handler to emit rangeChanged signal in derived widgets.

Reimplemented in omni::ui::RangedFloat, omni::ui::Dial, and omni::ui::RangedInt.

          {}

template<typename VALUE>

qreal omni::ui::mixin::Range< VALUE >::ratio ( value_type  _v ) const

inline

Return ratio of value v.

        {
          return qreal(_v - minimum()) / range();
        }

template<typename VALUE>

void omni::ui::mixin::Range< VALUE >::setMaximum ( value_type  _maximum )

inline

Set new maximum value and value and emit rangeChanged event.

        {
          maximum_ = _maximum;
          validate();
          rangeChangedEvent();
        }

template<typename VALUE>

void omni::ui::mixin::Range< VALUE >::setMinimum ( value_type  _minimum )

inline

Set new minimum value and value and emit rangeChanged event.

        {
          minimum_ = _minimum;
          validate();
          rangeChangedEvent();
        }

template<typename VALUE>

void omni::ui::mixin::Range< VALUE >::setRange ( value_type  _minimum, value_type  _maximum  )

inline

Set range and validate.

        {
          minimum_ = _minimum;
          maximum_ = _maximum;
          validate();
          rangeChangedEvent();
        }

template<typename VALUE>

virtual void omni::ui::mixin::Range< VALUE >::validate ( )

inlineprotectedvirtual

Validate minimum and maximum.

Reimplemented in omni::ui::mixin::RangedValue< DERIVED, VALUE >, omni::ui::mixin::RangedValue< Dial, double >, omni::ui::mixin::RangedValue< RangedFloat, double >, and omni::ui::mixin::RangedValue< RangedInt, int >.

          {
            if (minimum() > maximum()) std::swap(minimum_, maximum_);
          }

Field Documentation

template<typename VALUE>

value_type omni::ui::mixin::Range< VALUE >::maximum_

private

template<typename VALUE>

value_type omni::ui::mixin::Range< VALUE >::minimum_

private

---

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

• include/omni/ui/mixin/Range.h