omni::ui::RangedInt Class Reference

Integer slider. More...

#include <RangedInt.h>

Inheritance diagram for omni::ui::RangedInt:

Collaboration diagram for omni::ui::RangedInt:

Public Types
typedef QSpinBox	editor_type
typedef mixin::RangedValue < RangedInt, int >	mixin_range_type
Public Types inherited from omni::ui::AbstractInputWidget
typedef mixin::Editor < AbstractInputWidget, QWidget >	mixin_editor_type
Public Types inherited from omni::ui::mixin::RangedValue< RangedInt, int >
typedef Range< int >	range_type
typedef Step< int >	step_type
typedef int	value_type
Public Types inherited from omni::ui::mixin::Range< int >
typedef int	value_type
Public Types inherited from omni::ui::mixin::Step< int >
typedef int	value_type

Public Slots
void	setValue (int)
void	setMinimum (int)
void	setMaximum (int)
void	setRange (int, int)
void	setEditorVisible (bool)
void	setUseDefaultValue (bool)
	Use Default Value and show it. More...
void	setDrawTicks (bool)
Public Slots inherited from omni::ui::AbstractInputWidget
virtual void	setEditorVisible (bool)
	Set editor visible. More...
void	showEditor ()
	Show editor. More...
void	hideEditor ()
	Hide editor. More...

Signals
void	valueChanged ()
void	rangeChanged ()
Signals inherited from omni::ui::AbstractInputWidget
void	valueChanged ()
	Value changed event. More...

Public Member Functions
	RangedInt (QWidget *=nullptr)
	RangedInt (QString const &_label, int _value, int _min, int _max, QWidget *=nullptr)
	~RangedInt ()
bool	useDefaultValue () const
	Return flag if default value is used. More...
bool	drawTicks () const
Public Member Functions inherited from omni::ui::AbstractInputWidget
	AbstractInputWidget (QWidget *=nullptr)
virtual	~AbstractInputWidget ()
Public Member Functions inherited from omni::ui::Widget
	Widget (QWidget *=nullptr)
	Widget (QString const &_label, QWidget *=nullptr)
virtual	~Widget ()
QString	label () const
	Return label text of widget. More...
void	setLabel (QString const &)
	Set label text of widget. More...
ColorSet const &	colorSet () const
double	zoomFactor () const
	Zoom factor of widget. More...
Public Member Functions inherited from omni::ui::mixin::RangedValue< RangedInt, int >
	RangedValue ()
	Default constructor. More...
	RangedValue (value_type _value, value_type _minimum, value_type _maximum, value_type _singleStep=1.0, value_type _pageStep=10.0)
	Constructor from user defined value and range. More...
qreal	ratio () const
	Returns ratio of current value. More...
value_type	value () const
	Return value. More...
value_type	defaultValue () const
	Return default value. More...
value_type	pivot () const
	Return pivot value. More...
void	increase ()
	Increate value by single step value. More...
void	decrease ()
	Decrease value by single step value. More...
void	setValue (value_type _value)
	Set new value and emit value changed event. More...
void	reset ()
	Reset value to default value. More...
void	setDefaultValue (value_type _value)
	Set new default value. More...
void	setPivot (value_type _pivot)
	Set pivot value (0.0 by default) More...
Public Member Functions inherited from omni::ui::mixin::Range< int >
	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
Public Member Functions inherited from omni::ui::mixin::Step< int >
	Step (value_type _singleStep=1.0, value_type _pageStep=10.0, bool _snap=false)
	Construct with a single step, page step value. More...
qreal	snapped (value_type _v) const
	Return snapped value. More...
bool	snap () const
	Snap value (align to single step value) More...
void	setSnap (bool _snap)
	Set boolean if value is to be snapped. More...
value_type	singleStep () const
	Return value for single step. More...
value_type	pageStep () const
	Return value for page step. More...
void	setSingleStep (value_type _singleStep)
	Set new single step value. More...
void	setPageStep (value_type _pageStep)
	Set new value for page step. More...

Protected Member Functions
void	paintEvent (QPaintEvent *)
void	keyPressEvent (QKeyEvent *)
	Show editor when enter key is pressed. More...
void	mouseMoveEvent (QMouseEvent *)
void	mousePressEvent (QMouseEvent *)
	Hide editor and set focus on click. More...
void	mouseReleaseEvent (QMouseEvent *)
void	wheelEvent (QWheelEvent *)
void	valueChangedEvent ()
	Value changed event which is emitted on changed value. More...
void	rangeChangedEvent ()
	Handler to emit rangeChanged signal in derived widgets. More...
Protected Member Functions inherited from omni::ui::AbstractInputWidget
virtual void	mouseDoubleClickEvent (QMouseEvent *)
	Show editor on double click. More...
void	drawHandle (QPainter &_p, double _pos, double _heightFactor=1.0) const
	Draw slider handle. More...
void	drawTrack (QPainter &_p, double _pos) const
void	drawTrack (QPainter &_p, double _left, double _right) const
void	init ()
Protected Member Functions inherited from omni::ui::Widget
void	drawBorder (QPainter &)
void	drawBorder (QPainter &, bool _focus)
Protected Member Functions inherited from omni::ui::mixin::Editor< AbstractInputWidget, QWidget >
	Editor (widget_type *_widget)
T *	createEditor ()
	Create editor with type. More...
editor_type const *	editor () const
	Return pointer editor (const version) More...
editor_type *	editor ()
	Return pointer editor. More...
T *	editorAs ()
	Return editor as type T. More...
T const *	editorAs () const
	Return editor as type T (const version) More...
virtual void	setEditorVisible (bool _visible)
	Set editor visibility and set focus. More...
void	showEditor ()
	Show editor and set focus. More...
void	hideEditor ()
	Hide editor. More...
Protected Member Functions inherited from omni::ui::mixin::RangedValue< RangedInt, int >
void	apply (WIDGET *_widget) const
	Apply ranged value to widget. More...
void	for_each_step (F f)
	Functor to apply for each step. More...
void	validate ()
	Validate minimum, maximum and value. More...
Protected Member Functions inherited from omni::ui::mixin::Range< int >
void	apply (WIDGET *_widget) const
	Apply range to widget. More...
void	apply (WIDGET *_widget, V _value) const
	Applay range to widget and set value. More...
Protected Member Functions inherited from omni::ui::mixin::Step< int >
void	for_each_step (MIN _min, MAX _max, F f)
	Functor to be applied for each step between min and maximum. More...

Private Member Functions
void	init ()
void	editorSetup ()
int	valueFromPos (double) const
int	valueToPos () const
double	valueToPos (int) const
	Calculate position from value. More...

Private Attributes
bool	drawTicks_ = true
bool	useDefaultValue_ = false
bool	moving_ = false

Additional Inherited Members
Protected Types inherited from omni::ui::mixin::Editor< AbstractInputWidget, QWidget >
typedef AbstractInputWidget	widget_type
	Widget type. More...
typedef QWidget	editor_type
	Editor widget type, e.g. QDoubleSpinBox. More...
Protected Attributes inherited from omni::ui::AbstractInputWidget
QLabel *	valueLabel_ = nullptr
Protected Attributes inherited from omni::ui::Widget
QLabel *	label_

Detailed Description

Integer slider.

Member Typedef Documentation

typedef QSpinBox omni::ui::RangedInt::editor_type

typedef mixin::RangedValue<RangedInt, int> omni::ui::RangedInt::mixin_range_type

Constructor & Destructor Documentation

omni::ui::RangedInt::RangedInt

(

QWidget *

_parent = nullptr

)

                                             :
            AbstractInputWidget(_parent)
        {
            init();
        }

omni::ui::RangedInt::RangedInt	(	QString const &	_label,
		int	_value,
		int	_min,
		int	_max,
		QWidget *	_parent = nullptr
	)

                                                                               :
            AbstractInputWidget(_parent),
            mixin_range_type(_value, _min, _max)
        {
            setLabel(_label);
            init();
        }

omni::ui::RangedInt::~RangedInt

(

)

        {}

Member Function Documentation

bool omni::ui::RangedInt::drawTicks

(

)

const

        {
            return drawTicks_;
        }

void omni::ui::RangedInt::editorSetup ( )

privatevirtual

Implements omni::ui::mixin::Editor< AbstractInputWidget, QWidget >.

                                    {
            auto _editor = this->editorAs<editor_type>();

            connect(_editor, SIGNAL(valueChanged(int)), this,
                    SLOT(setValue(int)));
            _editor->setFrame(false);
            _editor->setAlignment(Qt::AlignRight);
            _editor->setButtonSymbols(QAbstractSpinBox::PlusMinus);
            mixin_range_type::apply(_editor);
            valueChangedEvent();
        }

void omni::ui::RangedInt::init ( )

private

        {
            setSingleStep(1.0);
            AbstractInputWidget::createEditor<editor_type>();
        }

void omni::ui::RangedInt::keyPressEvent ( QKeyEvent *  e )

protectedvirtual

Show editor when enter key is pressed.

Reimplemented from omni::ui::AbstractInputWidget.

                                                       {
            float _step = pageStep();

            if (_event->modifiers() & Qt::ShiftModifier) {
                _step = singleStep();
            }
            if (_event->modifiers() & Qt::ControlModifier) {
                _step *= 10.0;
            }

            if (_event->key() == Qt::Key_Left) {
                setValue(value() - _step);
            }
            if (_event->key() == Qt::Key_Right) {
                setValue(value() + _step);
            }
        }

void omni::ui::RangedInt::mouseMoveEvent ( QMouseEvent *  e )

protected

        {
            if (moving_)
            {
                setValue(valueFromPos(e->pos().x()));
            }
        }

void omni::ui::RangedInt::mousePressEvent ( QMouseEvent *  )

protectedvirtual

Hide editor and set focus on click.

Reimplemented from omni::ui::AbstractInputWidget.

        {
            AbstractInputWidget::mousePressEvent(e);

            if (abs(e->pos().x() - valueToPos()) <= 4)
            {
                moving_ = true;
            }
        }

void omni::ui::RangedInt::mouseReleaseEvent ( QMouseEvent *  e )

protected

        {
            moving_ = false;
        }

void omni::ui::RangedInt::paintEvent ( QPaintEvent *  _paintEvent )

protected

        {
            QStylePainter _p(this);

            _p.setRenderHint(QPainter::Antialiasing);
            QStyleOption _option;
            _option.initFrom(this);

            double _pos = valueToPos();

            if (useDefaultValue()) AbstractInputWidget::drawHandle(_p,
                                                                   valueToPos(
                                                                       defaultValue()),
                                                                   0.5);


            AbstractInputWidget::drawTrack(_p, _pos);

            if (drawTicks())
            {
                mixin_range_type::for_each_step([&](int _step, double i,
                                                    bool _isPage)
                {
                    _p.setPen(QPen(i >= mixin_range_type::value() ?
                                   colorSet().shadow() :
                                   colorSet().windowText(), 1));

                    double _pos = valueToPos(i);
                    double _sizeFactor = _isPage ? 0.3 : 0.15;
                    _p.drawLine(
                        QPointF(_pos,
                                rect().bottom() - rect().height() * _sizeFactor),
                        QPointF(_pos, rect().bottom()));
                });
            }
            AbstractInputWidget::drawBorder(_p,
                                            hasFocus() || editor()->hasFocus());
        }

void omni::ui::RangedInt::rangeChanged ( )

signal

void omni::ui::RangedInt::rangeChangedEvent ( )

protectedvirtual

Handler to emit rangeChanged signal in derived widgets.

Reimplemented from omni::ui::mixin::Range< int >.

        {
            mixin_range_type::apply(editorAs<editor_type>());
            emit rangeChanged();
        }

void omni::ui::RangedInt::setDrawTicks ( bool  _ticks )

slot

        {
            drawTicks_ = _ticks;
            update();
        }

void omni::ui::RangedInt::setEditorVisible ( bool  _visible )

slot

        {
            AbstractInputWidget::setEditorVisible(_visible);
            mixin_range_type::apply(editorAs<editor_type>());
        }

void omni::ui::RangedInt::setMaximum ( int  _max )

slot

        {
            mixin_range_type::setMaximum(_max);
        }

void omni::ui::RangedInt::setMinimum ( int  _min )

slot

        {
            mixin_range_type::setMinimum(_min);
        }

void omni::ui::RangedInt::setRange ( int  _min, int  _max  )

slot

        {
            mixin_range_type::setRange(_min, _max);
        }

void omni::ui::RangedInt::setUseDefaultValue ( bool  _defaultValue )

slot

Use Default Value and show it.

        {
            useDefaultValue_ = _defaultValue;
            update();
        }

void omni::ui::RangedInt::setValue ( int  _value )

slot

        {
            mixin_range_type::setValue(_value);
            emit valueChanged();

            update();
        }

bool omni::ui::RangedInt::useDefaultValue

(

)

const

Return flag if default value is used.

        {
            return useDefaultValue_;
        }

void omni::ui::RangedInt::valueChanged ( )

signal

void omni::ui::RangedInt::valueChangedEvent ( )

protectedvirtual

Value changed event which is emitted on changed value.

Reimplemented from omni::ui::mixin::RangedValue< RangedInt, int >.

        {
            mixin_range_type::apply(editorAs<editor_type>());
            AbstractInputWidget::valueLabel_->setText(QString("%1").arg(value()));

            update();
            emit valueChanged();
        }

int omni::ui::RangedInt::valueFromPos ( double  _pos ) const

private

        {
            auto && _rect = rect();
            return (_pos - _rect.left()) / _rect.width() * range() + minimum();
        }

int omni::ui::RangedInt::valueToPos ( ) const

private

        {
            auto && _rect = rect();
            return _rect.left() + ratio() * float(_rect.width());
        }

double omni::ui::RangedInt::valueToPos ( int  _value ) const

private

Calculate position from value.

        {
            auto && _rect = rect();
            return _rect.left() + mixin::Range<int>::ratio(_value) *
                   double(_rect.width());
        }

void omni::ui::RangedInt::wheelEvent ( QWheelEvent *  e )

protected

        {
            if (hasFocus()) setValue(
                    value() + e->delta() / 15.0 / 8.0 * singleStep());
        }

Field Documentation

bool omni::ui::RangedInt::drawTicks_ = true

private

bool omni::ui::RangedInt::moving_ = false

private

bool omni::ui::RangedInt::useDefaultValue_ = false

private

---

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

• include/omni/ui/RangedInt.h
• src/lib/ui/RangedInt.cpp