#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 | 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 | |
virtual bool | apply () |
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) |
~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 | 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::Expression > | getExpression () const |
std::string | getExpressionString (bool no_throw=true) const |
const App::ObjectIdentifier & | getPath () const |
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 | |
boost::signals2::scoped_connection | connection |
QPalette | defaultPalette |
int | iconHeight |
QLabel * | iconLabel |
bool | m_autoApply |
Constructor & Destructor Documentation
◆ QuantitySpinBox()
|
explicit |
◆ ~QuantitySpinBox()
|
virtual |
Member Function Documentation
◆ apply() [1/3]
bool ExpressionBinding::apply |
◆ apply() [2/3]
bool ExpressionBinding::apply |
◆ apply() [3/3]
|
virtual |
Reimplemented from Gui::ExpressionBinding.
References Gui::ExpressionBinding::apply(), Gui::Command::Doc, Base::Persistence::getClassTypeId(), Gui::ExpressionBinding::getPath(), Base::Persistence::getTypeId(), Base::Quantity::getValue(), Gui::ExpressionBinding::isBound(), Base::Type::isDerivedFrom(), App::Property::isReadOnly(), Base::toRadians(), and value.
◆ bind()
|
virtual |
Reimplemented from Gui::ExpressionBinding.
References Gui::ExpressionBinding::bind(), and Gui::ExpressionBinding::iconLabel.
Referenced by setBoundToByName().
◆ boundToName()
QString QuantitySpinBox::boundToName | ( | ) | const |
Gets the path of the bound property.
References Gui::ExpressionBinding::getPath(), Gui::ExpressionBinding::isBound(), and App::ObjectIdentifier::toString().
◆ clear()
|
virtual |
◆ clearSchema()
void QuantitySpinBox::clearSchema | ( | ) |
Clears the schemaand again use the system-wide schema.
◆ closeEvent()
|
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
|
protectedslot |
References setExpression(), and showFormulaDialog().
Referenced by openFormulaDialog().
◆ fixup()
|
virtual |
Referenced by valueFromText().
◆ focusInEvent()
|
protectedvirtual |
◆ focusOutEvent()
|
protectedvirtual |
References handlePendingEmit().
◆ handlePendingEmit
|
protectedslot |
Referenced by closeEvent(), focusOutEvent(), hideEvent(), QuantitySpinBox(), and userInput().
◆ 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()
|
protectedvirtual |
References handlePendingEmit().
◆ keyPressEvent()
|
protectedvirtual |
◆ maximum()
double Gui::QuantitySpinBox::maximum | ( | ) | const |
Gets the value of the maximum property.
◆ minimum()
double Gui::QuantitySpinBox::minimum | ( | ) | const |
Gets the value of the minimum property.
◆ minimumSizeHint()
QSize QuantitySpinBox::minimumSizeHint | ( | ) | const |
References Gui::ExpressionBinding::iconHeight, and textFromValue().
◆ onChange
|
protectedvirtualslot |
References Base::Tools::fromStdString(), and DraftVecUtils::toString().
◆ openFormulaDialog
|
protectedslot |
◆ rawValue()
double Gui::QuantitySpinBox::rawValue | ( | ) | const |
Get the current quantity without unit.
◆ resizeEvent()
|
protectedvirtual |
◆ selectNumber()
void QuantitySpinBox::selectNumber | ( | ) |
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()
|
virtual |
Reimplemented from Gui::ExpressionBinding.
References Gui::ExpressionBinding::setExpression().
Referenced by finishFormulaDialog().
◆ 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()
◆ 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]
|
slot |
Sets the field with a quantity.
References Base::Quantity::setValue(), and value.
Referenced by Gui::TaskCSysDragger::open(), Gui::PrefUnitSpinBox::restorePreferences(), PartGui::FilletRadiusDelegate::setEditorData(), Gui::LocationWidget::setPosition(), and setValue().
◆ setValue [2/2]
|
slot |
Set a numerical value which gets converted to a quantity with the currently set unit type.
References setValue().
◆ showEvent()
|
protectedvirtual |
References selectNumber().
◆ showFormulaDialog
|
signal |
Gets emitted if formula dialog is about to be opened (true) or finished (false).
Referenced by finishFormulaDialog(), and openFormulaDialog().
◆ singleStep()
double Gui::QuantitySpinBox::singleStep | ( | ) | const |
Get the value of the singleStep property.
◆ sizeHint()
QSize QuantitySpinBox::sizeHint | ( | ) | const |
References Gui::ExpressionBinding::iconHeight, and textFromValue().
◆ stepBy()
|
virtual |
References minimum, and selectNumber().
◆ stepEnabled()
|
protectedvirtual |
◆ textFromValue()
QString QuantitySpinBox::textFromValue | ( | const Base::Quantity & | val | ) | const |
Referenced by minimumSizeHint(), and sizeHint().
◆ unit()
Base::Unit Gui::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
|
protectedslot |
References handlePendingEmit().
Referenced by QuantitySpinBox().
◆ validate()
|
virtual |
◆ value()
Base::Quantity Gui::QuantitySpinBox::value | ( | ) | const |
Get the current quantity.
Referenced by Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::evaluate(), and Mod.PartDesign.WizardShaft.SegmentFunction.IntervalFunction::lowervalue().
◆ valueChanged [1/2]
|
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]
|
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
|
readwrite |
◆ expression
|
read |
◆ maximum
|
readwrite |
Referenced by setMaximum(), and setRange().
◆ minimum
|
readwrite |
Referenced by setMinimum(), setRange(), and stepBy().
◆ rawValue
|
readwrite |
Referenced by Gui::PrefUnitSpinBox::restorePreferences(), and Gui::PrefUnitSpinBox::savePreferences().
◆ singleStep
|
readwrite |
◆ unit
|
readwrite |
Referenced by setUnit().
◆ value
|
readwrite |
Referenced by apply(), PathScripts.PathSetupSheetOpPrototype.Property::displayString(), PathScripts.PathSetupSheetOpPrototype.PropertyQuantity::displayString(), Mod.PartDesign.WizardShaft.SegmentFunction.SegmentFunction::evaluate(), Gui::LocationWidget::getPosition(), PathScripts.PathSetupSheetOpPrototype.Property::getValue(), Mod.PartDesign.WizardShaft.SegmentFunction.IntervalFunction::lowervalue(), Gui::PrefQuantitySpinBox::pushToHistory(), PartGui::FilletRadiusDelegate::setModelData(), setSingleStep(), PathScripts.PathSetupSheetOpPrototype.Property::setValue(), and setValue().
The documentation for this class was generated from the following files:
- src/Gui/QuantitySpinBox.h
- src/Gui/QuantitySpinBox.cpp