#include <QuantitySpinBox.h>

Public Slots

void setValue (const Base::Quantity &val)
 Sets the field with a quantity. More...
 
void setValue (double)
 Set a numerical value which gets converted to a quantity with the currently set unit type. More...
 

Signals

void showFormulaDialog (bool)
 Gets emitted if formula dialog is about to be opened (true) or finished (false). More...
 
void textChanged (const QString &)
 The new value is passed in text with unit. More...
 
void valueChanged (const Base::Quantity &)
 Gets emitted if the user has entered a VALID input Valid means the user inputted string obeys all restrictions like: minimum, maximum and/or the right Unit (if specified). More...
 
void valueChanged (double)
 Gets emitted if the user has entered a VALID input Valid means the user inputted string obeys all restrictions like: minimum, maximum and/or the right Unit (if specified). More...
 

Public Member Functions

virtual bool apply ()
 
virtual bool apply (const std::string &propName)
 
bool apply (const std::string &propName)
 
void bind (const App::ObjectIdentifier &_path)
 
QString boundToName () const
 Gets the path of the bound property. More...
 
virtual void clear ()
 
void clearSchema ()
 Clears the schemaand again use the system-wide schema. More...
 
int decimals () const
 Gets the number of decimals. More...
 
bool event (QEvent *event)
 
QString expressionText () const
 Gets the expression as a string. More...
 
virtual void fixup (QString &str) const
 
bool hasValidInput () const
 Gives the current state of the user input, gives true if it is a valid input with correct quantity or returns false if the input is a unparsable string or has a wrong unit. More...
 
double maximum () const
 Gets the value of the maximum property. More...
 
double minimum () const
 Gets the value of the minimum property. More...
 
QSize minimumSizeHint () const
 
 QuantitySpinBox (QWidget *parent=0)
 
double rawValue () const
 Get the current quantity without unit. More...
 
void selectNumber ()
 Set the number portion selected. More...
 
void setBoundToByName (const QString &path)
 Sets the path of the bound property. More...
 
void setDecimals (int v)
 Sets the number of decimals. More...
 
void setExpression (boost::shared_ptr< App::Expression > expr)
 
void setMaximum (double max)
 Sets the value of the maximum property. More...
 
void setMinimum (double min)
 Sets the value of the minimum property. More...
 
void setRange (double min, double max)
 
void setSchema (const Base::UnitSystem &s)
 Sets a specific unit schema to handle quantities. More...
 
void setSingleStep (double val)
 Set the value of the singleStep property. More...
 
void setUnit (const Base::Unit &unit)
 
void setUnitText (const QString &)
 Set the unit property. More...
 
double singleStep () const
 Get the value of the singleStep property. More...
 
QSize sizeHint () const
 
virtual void stepBy (int steps)
 
QString textFromValue (const Base::Quantity &val) const
 
Base::Unit unit () const
 Sets the Unit this widget is working with. More...
 
QString unitText (void)
 Get the unit property. More...
 
virtual QValidator::State validate (QString &input, int &pos) const
 
Base::Quantity value () const
 Get the current quantity. More...
 
Base::Quantity valueFromText (const QString &text) const
 
virtual ~QuantitySpinBox ()
 
- Public Member Functions inherited from Gui::ExpressionBinding
bool autoApply () const
 
virtual void bind (const App::Property &prop)
 
 ExpressionBinding ()
 
QPixmap getIcon (const char *name, const QSize &size) const
 
bool hasExpression () const
 
bool isBound () const
 
void setAutoApply (bool value)
 
void unbind ()
 
virtual ~ExpressionBinding ()
 

Protected Slots

void finishFormulaDialog ()
 
void handlePendingEmit ()
 
virtual void onChange ()
 
void openFormulaDialog ()
 
void userInput (const QString &text)
 

Protected Member Functions

virtual void closeEvent (QCloseEvent *event)
 
virtual void focusInEvent (QFocusEvent *event)
 
virtual void focusOutEvent (QFocusEvent *event)
 
virtual void hideEvent (QHideEvent *event)
 
virtual void keyPressEvent (QKeyEvent *event)
 
virtual void paintEvent (QPaintEvent *event)
 
virtual void resizeEvent (QResizeEvent *event)
 
virtual void showEvent (QShowEvent *event)
 
virtual StepEnabled stepEnabled () const
 
- Protected Member Functions inherited from Gui::ExpressionBinding
void expressionChange (const App::ObjectIdentifier &id)
 
std::string getEscapedExpressionString () const
 
boost::shared_ptr< App::ExpressiongetExpression () const
 
std::string getExpressionString (bool no_throw=true) const
 
const App::ObjectIdentifiergetPath () const
 
void objectDeleted (const App::DocumentObject &)
 
virtual void onChange ()
 

Properties

QString binding
 
QString expression
 
double maximum
 
double minimum
 
double rawValue
 
double singleStep
 
QString unit
 
Base::Quantity value
 

Additional Inherited Members

- Protected Attributes inherited from Gui::ExpressionBinding
QPalette defaultPalette
 
boost::signals2::scoped_connection expressionchanged
 
int iconHeight
 
QLabeliconLabel
 
bool m_autoApply
 
boost::signals2::scoped_connection objectdeleted
 

Constructor & Destructor Documentation

◆ QuantitySpinBox()

◆ ~QuantitySpinBox()

QuantitySpinBox::~QuantitySpinBox ( )
virtual

Member Function Documentation

◆ apply() [1/3]

bool ExpressionBinding::apply ( void  )
virtual

Reimplemented from Gui::ExpressionBinding.

◆ apply() [2/3]

bool ExpressionBinding::apply ( void  )
virtual

Reimplemented from Gui::ExpressionBinding.

◆ apply() [3/3]

◆ bind()

void QuantitySpinBox::bind ( const App::ObjectIdentifier _path)
virtual

◆ boundToName()

QString QuantitySpinBox::boundToName ( ) const

◆ clear()

void QuantitySpinBox::clear ( void  )
virtual

◆ clearSchema()

void QuantitySpinBox::clearSchema ( )

Clears the schemaand again use the system-wide schema.

◆ closeEvent()

void QuantitySpinBox::closeEvent ( QCloseEvent *  event)
protectedvirtual

References handlePendingEmit().

◆ decimals()

int QuantitySpinBox::decimals ( ) const

Gets the number of decimals.

◆ event()

◆ expressionText()

QString Gui::QuantitySpinBox::expressionText ( ) const

Gets the expression as a string.

◆ finishFormulaDialog

void QuantitySpinBox::finishFormulaDialog ( )
protectedslot

References setExpression(), and showFormulaDialog().

Referenced by openFormulaDialog().

◆ fixup()

void QuantitySpinBox::fixup ( QString &  str) const
virtual

Referenced by valueFromText().

◆ focusInEvent()

void QuantitySpinBox::focusInEvent ( QFocusEvent *  event)
protectedvirtual

◆ focusOutEvent()

void QuantitySpinBox::focusOutEvent ( QFocusEvent *  event)
protectedvirtual

References handlePendingEmit().

◆ handlePendingEmit

void QuantitySpinBox::handlePendingEmit ( )
protectedslot

◆ hasValidInput()

bool QuantitySpinBox::hasValidInput ( ) const

Gives the current state of the user input, gives true if it is a valid input with correct quantity or returns false if the input is a unparsable string or has a wrong unit.

◆ hideEvent()

void QuantitySpinBox::hideEvent ( QHideEvent *  event)
protectedvirtual

References handlePendingEmit().

◆ keyPressEvent()

void Gui::QuantitySpinBox::keyPressEvent ( QKeyEvent *  event)
protectedvirtual

◆ maximum()

double QuantitySpinBox::maximum ( void  ) const

Gets the value of the maximum property.

◆ minimum()

double QuantitySpinBox::minimum ( void  ) const

Gets the value of the minimum property.

◆ minimumSizeHint()

QSize QuantitySpinBox::minimumSizeHint ( ) const

◆ onChange

void Gui::QuantitySpinBox::onChange ( )
protectedvirtualslot

◆ openFormulaDialog

◆ paintEvent()

void Gui::QuantitySpinBox::paintEvent ( QPaintEvent *  event)
protectedvirtual

◆ rawValue()

double QuantitySpinBox::rawValue ( ) const

Get the current quantity without unit.

◆ resizeEvent()

◆ selectNumber()

void QuantitySpinBox::selectNumber ( void  )

Set the number portion selected.

Referenced by focusInEvent(), showEvent(), and stepBy().

◆ setBoundToByName()

void QuantitySpinBox::setBoundToByName ( const QString &  name)

Sets the path of the bound property.

Create an object identifier by name.

An identifier is written as document::documentobject.property.subproperty1...subpropertyN document# may be dropped, in this case the active document is used.

References bind(), App::Application::getActiveDocument(), App::GetApplication(), App::Application::getDocument(), and App::ObjectIdentifier::Component::SimpleComponent().

◆ setDecimals()

void QuantitySpinBox::setDecimals ( int  v)

Sets the number of decimals.

References Base::QuantityFormat::precision.

◆ setExpression()

void Gui::QuantitySpinBox::setExpression ( boost::shared_ptr< App::Expression expr)
virtual

◆ setMaximum()

void QuantitySpinBox::setMaximum ( double  max)

Sets the value of the maximum property.

References maximum.

Referenced by Gui::LocationWidget::LocationWidget().

◆ setMinimum()

void QuantitySpinBox::setMinimum ( double  min)

Sets the value of the minimum property.

References minimum.

Referenced by Gui::LocationWidget::LocationWidget().

◆ setRange()

void QuantitySpinBox::setRange ( double  min,
double  max 
)

References maximum, and minimum.

◆ setSchema()

void QuantitySpinBox::setSchema ( const Base::UnitSystem s)

Sets a specific unit schema to handle quantities.

The system-wide schema won't be used any more.

References Base::UnitsApi::createSchema().

◆ setSingleStep()

void QuantitySpinBox::setSingleStep ( double  val)

Set the value of the singleStep property.

References value.

◆ setUnit()

void QuantitySpinBox::setUnit ( const Base::Unit unit)

References unit.

Referenced by Gui::LocationWidget::LocationWidget(), and setUnitText().

◆ setUnitText()

void QuantitySpinBox::setUnitText ( const QString &  str)

Set the unit property.

References Base::Quantity::getUnit(), Base::Quantity::parse(), and setUnit().

◆ setValue [1/2]

◆ setValue [2/2]

void QuantitySpinBox::setValue ( double  value)
slot

Set a numerical value which gets converted to a quantity with the currently set unit type.

References setValue().

◆ showEvent()

void QuantitySpinBox::showEvent ( QShowEvent *  event)
protectedvirtual

References selectNumber().

◆ showFormulaDialog

void Gui::QuantitySpinBox::showFormulaDialog ( bool  )
signal

Gets emitted if formula dialog is about to be opened (true) or finished (false).

Referenced by finishFormulaDialog(), and openFormulaDialog().

◆ singleStep()

double QuantitySpinBox::singleStep ( void  ) const

Get the value of the singleStep property.

◆ sizeHint()

QSize QuantitySpinBox::sizeHint ( ) const

◆ stepBy()

void QuantitySpinBox::stepBy ( int  steps)
virtual

References minimum, and selectNumber().

◆ stepEnabled()

QAbstractSpinBox::StepEnabled QuantitySpinBox::stepEnabled ( ) const
protectedvirtual

◆ textChanged

void Gui::QuantitySpinBox::textChanged ( const QString &  )
signal

The new value is passed in text with unit.

Referenced by QuantitySpinBox().

◆ textFromValue()

QString QuantitySpinBox::textFromValue ( const Base::Quantity val) const

Referenced by minimumSizeHint(), and sizeHint().

◆ unit()

Base::Unit QuantitySpinBox::unit ( ) const

Sets the Unit this widget is working with.

After setting the Unit the widget will only accept user input with this unit type. Or if the user input a value without unit, this one will be added to the resulting Quantity.

◆ unitText()

QString QuantitySpinBox::unitText ( void  )

Get the unit property.

◆ userInput

void QuantitySpinBox::userInput ( const QString &  text)
protectedslot

References handlePendingEmit().

Referenced by QuantitySpinBox().

◆ validate()

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

◆ value()

◆ valueChanged [1/2]

void Gui::QuantitySpinBox::valueChanged ( const Base::Quantity )
signal

Gets emitted if the user has entered a VALID input Valid means the user inputted string obeys all restrictions like: minimum, maximum and/or the right Unit (if specified).

◆ valueChanged [2/2]

void Gui::QuantitySpinBox::valueChanged ( double  )
signal

Gets emitted if the user has entered a VALID input Valid means the user inputted string obeys all restrictions like: minimum, maximum and/or the right Unit (if specified).

◆ valueFromText()

Base::Quantity QuantitySpinBox::valueFromText ( const QString &  text) const

References fixup().

Property Documentation

◆ binding

QString Gui::QuantitySpinBox::binding
readwrite

◆ expression

QString Gui::QuantitySpinBox::expression
read

◆ maximum

double Gui::QuantitySpinBox::maximum
readwrite

Referenced by setMaximum(), and setRange().

◆ minimum

double Gui::QuantitySpinBox::minimum
readwrite

Referenced by setMinimum(), setRange(), and stepBy().

◆ rawValue

double Gui::QuantitySpinBox::rawValue
readwrite

◆ singleStep

double Gui::QuantitySpinBox::singleStep
readwrite

◆ unit

QString Gui::QuantitySpinBox::unit
readwrite

Referenced by setUnit().

◆ value


The documentation for this class was generated from the following files:
  • Sources/FreeCAD/src/Gui/QuantitySpinBox.h
  • Sources/FreeCAD/src/Gui/QuantitySpinBox.cpp