KoUnitDoubleSpinBox Class Reference

#include <KoUnitDoubleSpinBox.h>

Inheritance diagram for KoUnitDoubleSpinBox:

Signals
void	valueChangedPt (qreal)
	emitted like valueChanged in the parent, but this one emits the point value

Public Member Functions
virtual void	changeValue (double newValue)
	KoUnitDoubleSpinBox (QWidget *parent=0)
	Private (double low, double up, double step)
void	setLineStep (double step)
	Set step size in the current unit.
void	setLineStepPt (double step)
	Set step size in points.
void	setMaximum (double max)
	Set maximum value in points.
void	setMinimum (double min)
	Set minimum value in points.
void	setMinMaxStep (double min, double max, double step)
	Set minimum, maximum value and the step size (all in points)
virtual void	setUnit (const KoUnit &)
QString	textFromValue (double value) const override
QValidator::State	validate (QString &input, int &pos) const override
	reimplemented from superclass, will forward to KoUnitDoubleValidator
double	value () const
double	valueFromText (const QString &str) const override
	~KoUnitDoubleSpinBox () override

Public Attributes
double	lowerInPoints
	lowest value in points
double	stepInPoints
	step in points
KoUnit	unit
double	upperInPoints
	highest value in points

Private Slots
void	privateValueChanged ()

Private Attributes
Private *const	d
Private Attributes inherited from Private
KisCanvas2 *	canvas
int	displayedFrame
int	intendedFrame

Additional Inherited Members
Private Member Functions inherited from Private
	Private (KisCanvas2 *c)

Detailed Description

Spin box for double precision numbers with unit display. Use this widget for any value that represents a real measurable value for consistency throughout Krita. This widget shows the value in the user-selected units (inch, millimeters, etc) but keeps the Krita-widget default measurement unit internally. This has the advantage that just setting and getting a value will not change the value due to conversions. The KoDocument class has a unit() method for consistent (document wide) configuration of the used unit. It is advised to use a QDoubleSpinBox in QtDesigner and then use the context-menu item: 'Promote to Custom Widget' and use the values: 'classname=KoUnitDoubleSpinBox', 'headerfile=KoUnitDoubleSpinBox.h' This will generate code that uses this spinbox in the correct manner.

This class need to be replaced as much as possible with

See also

KisDoubleParseUnitSpinBox to add math parsing ability.

Definition at line 23 of file KoUnitDoubleSpinBox.cpp.

Constructor & Destructor Documentation

KoUnitDoubleSpinBox()

KoUnitDoubleSpinBox::KoUnitDoubleSpinBox ( QWidget * parent = 0 )

explicit

Constructor Create a new spinBox with very broad range predefined. This spinbox will have min and max borders of 10000 points and use the default unit of points.

Parameters

parent

the parent widget

Definition at line 40 of file KoUnitDoubleSpinBox.cpp.

    : QDoubleSpinBox( parent ),
    d( new Private(-9999, 9999, 1))
{
    QDoubleSpinBox::setDecimals( 2 );
    //setAcceptLocalizedNumbers( true );
    setUnit( KoUnit(KoUnit::Point) );
    setAlignment( Qt::AlignRight );
 
    connect(this, SIGNAL(valueChanged(double)), SLOT(privateValueChanged()));
}

References KoUnit::Point, privateValueChanged(), and setUnit().

~KoUnitDoubleSpinBox()

KoUnitDoubleSpinBox::~KoUnitDoubleSpinBox ( )

override

Definition at line 52 of file KoUnitDoubleSpinBox.cpp.

{
    delete d;
}

References d.

Member Function Documentation

changeValue()

void KoUnitDoubleSpinBox::changeValue ( double newValue )

virtual

Set the new value in points which will then be converted to the current unit for display

Parameters

newValue

the new value

See also

value()

Definition at line 113 of file KoUnitDoubleSpinBox.cpp.

{
    QDoubleSpinBox::setValue( d->unit.toUserValue( val ) );
    // TODO: Q_EMIT valueChanged ONLY if the value was out-of-bounds
    // This will allow the 'user' dialog to set a dirty bool and ensure
    // a proper value is getting saved.
}

References d.

Private()

KoUnitDoubleSpinBox::Private ( double low, double up, double step )

inline

Definition at line 26 of file KoUnitDoubleSpinBox.cpp.

        : lowerInPoints(low),
        upperInPoints(up),
        stepInPoints(step),
        unit(KoUnit(KoUnit::Point))
    {
    }

privateValueChanged

void KoUnitDoubleSpinBox::privateValueChanged ( )

privateslot

Definition at line 121 of file KoUnitDoubleSpinBox.cpp.

                                              {
    Q_EMIT valueChangedPt( value () );
}

References value(), and valueChangedPt().

setLineStep()

void KoUnitDoubleSpinBox::setLineStep

(

double

step

)

Set step size in the current unit.

Definition at line 163 of file KoUnitDoubleSpinBox.cpp.

{
  d->stepInPoints = KoUnit(KoUnit::Point).toUserValue(step);
  QDoubleSpinBox::setSingleStep( step );
}

References d, KoUnit::Point, and KoUnit::toUserValue().

setLineStepPt()

void KoUnitDoubleSpinBox::setLineStepPt

(

double

step

)

Set step size in points.

Definition at line 169 of file KoUnitDoubleSpinBox.cpp.

{
  d->stepInPoints = step;
  QDoubleSpinBox::setSingleStep( d->unit.toUserValue( step ) );
}

References d.

setMaximum()

void KoUnitDoubleSpinBox::setMaximum

(

double

max

)

Set maximum value in points.

Definition at line 157 of file KoUnitDoubleSpinBox.cpp.

{
  d->upperInPoints = max;
  QDoubleSpinBox::setMaximum( d->unit.toUserValue( max ) );
}

References d.

setMinimum()

void KoUnitDoubleSpinBox::setMinimum

(

double

min

)

Set minimum value in points.

Definition at line 151 of file KoUnitDoubleSpinBox.cpp.

{
  d->lowerInPoints = min;
  QDoubleSpinBox::setMinimum( d->unit.toUserValue( min ) );
}

References d.

setMinMaxStep()

void KoUnitDoubleSpinBox::setMinMaxStep	(	double	min,
		double	max,
		double	step )

Set minimum, maximum value and the step size (all in points)

Definition at line 175 of file KoUnitDoubleSpinBox.cpp.

{
  setMinimum( min );
  setMaximum( max );
  setLineStepPt( step );
}

References setLineStepPt(), setMaximum(), and setMinimum().

setUnit()

void KoUnitDoubleSpinBox::setUnit ( const KoUnit & unit )

virtual

This spinbox shows the internal value after a conversion to the unit set here.

Definition at line 125 of file KoUnitDoubleSpinBox.cpp.

{
    if (unit == d->unit) return;
 
    double oldvalue = d->unit.fromUserValue( QDoubleSpinBox::value() );
    QDoubleSpinBox::setMinimum( unit.toUserValue( d->lowerInPoints ) );
    QDoubleSpinBox::setMaximum( unit.toUserValue( d->upperInPoints ) );
 
    qreal step = unit.toUserValue( d->stepInPoints );
 
    if (unit.type() == KoUnit::Pixel) {
        // limit the pixel step by 1.0
        step = qMax(qreal(1.0), step);
    }
 
    QDoubleSpinBox::setSingleStep( step );
    d->unit = unit;
    QDoubleSpinBox::setValue(unit.toUserValuePrecise(oldvalue));
    setSuffix(unit.symbol().prepend(QLatin1Char(' ')));
}

References d, KoUnit::Pixel, KoUnit::symbol(), KoUnit::toUserValue(), KoUnit::toUserValuePrecise(), KoUnit::type(), and unit.

textFromValue()

QString KoUnitDoubleSpinBox::textFromValue ( double value ) const

override

Transform the double in a nice text, using locale symbols

Parameters

value

the number as double

Returns

the resulting string

Definition at line 182 of file KoUnitDoubleSpinBox.cpp.

{
    //debugWidgets <<"textFromValue:" << QString::number( value, 'f', 12 ) <<" =>" << num;
    //const QString num(QString("%1%2").arg(QLocale().toString(value, d->precision ), m_unit.symbol()));
    //const QString num ( QString( "%1").arg( QLocale().toString( value, d->precision )) );
    return QLocale().toString( value, 'f', decimals() );
}

References value().

validate()

QValidator::State KoUnitDoubleSpinBox::validate ( QString & input, int & pos ) const

override

reimplemented from superclass, will forward to KoUnitDoubleValidator

Definition at line 57 of file KoUnitDoubleSpinBox.cpp.

{
#ifdef DEBUG_VALIDATOR
    debugWidgets <<"KoUnitDoubleSpinBox::validate :" << input <<" at" << pos;
#else
    Q_UNUSED(pos);
#endif
 
    QRegularExpression regexp ("([ a-zA-Z]+)$"); // Letters or spaces at end
    QRegularExpressionMatch match;
    const int res = input.indexOf(regexp, 0, &match);
 
    if ( res == -1 )
    {
        // Nothing like an unit? The user is probably editing the unit
#ifdef DEBUG_VALIDATOR
        debugWidgets <<"Intermediate (no unit)";
#endif
        return QValidator::Intermediate;
    }
 
    // ### TODO: are all the QString::trimmed really necessary?
    const QString number ( input.left( res ).trimmed() );
    const QString unitName ( match.captured( 1 ).trimmed().toLower() );
 
#ifdef DEBUG_VALIDATOR
    debugWidgets <<"Split:" << number <<":" << unitName <<":";
#endif
 
    const double value = valueFromText( number );
    double newVal = 0.0;
    if (!qIsNaN(value)) {
        bool ok;
        const KoUnit unit = KoUnit::fromSymbol(unitName, &ok);
        if ( ok )
            newVal = unit.fromUserValue( value );
        else
        {
            // Probably the user is trying to edit the unit
#ifdef DEBUG_VALIDATOR
            debugWidgets <<"Intermediate (unknown unit)";
#endif
            return QValidator::Intermediate;
        }
    }
    else
    {
        warnWidgets << "Not a number: " << number;
        return QValidator::Invalid;
    }
    newVal = d->unit.toUserValuePrecise(newVal);
    //input = textFromValue( newVal ); // don't overwrite for now; the effect is not exactly what I expect...
 
    return QValidator::Acceptable;
}

References d, debugWidgets, KoUnit::fromSymbol(), KoUnit::fromUserValue(), unit, value(), valueFromText(), and warnWidgets.

value()

double KoUnitDoubleSpinBox::value

(

)

const

Returns

the current value, converted in points

Definition at line 146 of file KoUnitDoubleSpinBox.cpp.

{
    return d->unit.fromUserValue( QDoubleSpinBox::value() );
}

References d.

valueChangedPt

void KoUnitDoubleSpinBox::valueChangedPt ( qreal )

signal

emitted like valueChanged in the parent, but this one emits the point value

valueFromText()

double KoUnitDoubleSpinBox::valueFromText ( const QString & str ) const

override

Transform a string into a double, while taking care of locale specific symbols.

Parameters

str	the string to transform into a number

Returns

the value as double

Definition at line 190 of file KoUnitDoubleSpinBox.cpp.

{
    QString str2( str );
    str2.remove(d->unit.symbol());
    return QLocale().toDouble(str2);
//    QString str2( str );
//    /* KLocale::readNumber wants the thousand separator exactly at 1000.
//       But when editing, it might be anywhere. So we need to remove it. */
//    const QString sep( KGlobal::locale()->thousandsSeparator() );
//    if ( !sep.isEmpty() )
//        str2.remove( sep );
//    str2.remove(d->unit.symbol());
//    bool ok;
//    const double dbl = KGlobal::locale()->readNumber( str2, &ok );
//#ifdef DEBUG_VALUEFROMTEXT
//    if ( ok )
//      debugWidgets <<"valueFromText:" << str <<": => :" << str2 <<": =>" << QString::number( dbl, 'f', 12 );
//    else
//        warnWidgets << "valueFromText error:" << str << ": => :" << str2 << ":";
//#endif
//    return dbl;
}

References d.

Member Data Documentation

d

Private* const KoUnitDoubleSpinBox::d

private

Definition at line 98 of file KoUnitDoubleSpinBox.h.

lowerInPoints

double KoUnitDoubleSpinBox::lowerInPoints

lowest value in points

Definition at line 34 of file KoUnitDoubleSpinBox.cpp.

stepInPoints

double KoUnitDoubleSpinBox::stepInPoints

step in points

Definition at line 36 of file KoUnitDoubleSpinBox.cpp.

unit

KoUnit KoUnitDoubleSpinBox::unit

Definition at line 37 of file KoUnitDoubleSpinBox.cpp.

upperInPoints

double KoUnitDoubleSpinBox::upperInPoints

highest value in points

Definition at line 35 of file KoUnitDoubleSpinBox.cpp.

---

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

• libs/widgets/KoUnitDoubleSpinBox.cpp
• libs/widgets/KoUnitDoubleSpinBox.h