Qudi
Public Member Functions | Public Attributes | Static Public Attributes | List of all members
qtwidgets.scientific_spinbox.ScienSpinBox Class Reference
Inheritance diagram for qtwidgets.scientific_spinbox.ScienSpinBox:
Inheritance graph
[legend]
Collaboration diagram for qtwidgets.scientific_spinbox.ScienSpinBox:
Collaboration graph
[legend]

Public Member Functions

def __init__ (self, args, kwargs)
 
def dynamic_stepping (self)
 
def dynamic_stepping (self, use_dynamic_stepping)
 
def update_value (self)
 
def value (self)
 Getter method to obtain the current value as int. More...
 
def setValue (self, value)
 
def setProperty (self, prop, val)
 For compatibility with QtDesigner. More...
 
def check_range (self, value)
 
def minimum (self)
 
def setMinimum (self, minimum)
 
def maximum (self)
 
def setMaximum (self, maximum)
 
def setRange (self, minimum, maximum)
 
def prefix (self)
 
def setPrefix (self, prefix)
 Set a string to be shown as non-editable prefix in the spinbox. More...
 
def suffix (self)
 
def setSuffix (self, suffix)
 
def singleStep (self)
 
def setSingleStep (self, step, dynamic_stepping=True)
 Method to set the stepping behaviour of the spinbox (e.g. More...
 
def minimalStep (self)
 
def setMinimalStep (self, step)
 
def cleanText (self)
 
def update_display (self)
 
def keyPressEvent (self, event)
 
def focusInEvent (self, event)
 
def focusOutEvent (self, event)
 
def validate (self, text, position)
 Access method to the validator. More...
 
def fixup (self, text)
 
def valueFromText (self, text)
 
def textFromValue (self, value)
 
def stepEnabled (self)
 Enables stepping (mouse wheel, arrow up/down, clicking, PgUp/Down) by default.
 
def stepBy (self, steps)
 
def selectAll (self)
 

Public Attributes

 validator
 
 dynamic_stepping
 

Static Public Attributes

 valueChanged = QtCore.Signal(object)
 

Member Function Documentation

◆ setPrefix()

def qtwidgets.scientific_spinbox.ScienSpinBox.setPrefix (   self,
  prefix 
)

Set a string to be shown as non-editable prefix in the spinbox.

Parameters
prefixstr, the prefix string to be set

◆ setProperty()

def qtwidgets.scientific_spinbox.ScienSpinBox.setProperty (   self,
  prop,
  val 
)

For compatibility with QtDesigner.

Somehow the value gets initialized through this method.

Parameters
prop
val

◆ setSingleStep()

def qtwidgets.scientific_spinbox.ScienSpinBox.setSingleStep (   self,
  step,
  dynamic_stepping = True 
)

Method to set the stepping behaviour of the spinbox (e.g.

when moving the mouse wheel).

   When dynamic_stepping=True the spinbox will perform logarithmic steps according to the
   values' current order of magnitude. The step parameter is then ignored.
   Will always increment the second most significant digit by one.

   When dynamic_stepping=False the step parameter specifies an absolute step size. Meaning each
   time a step is performed this value is added/substracted from the current value.

   @param step: int, the absolute step size to set
   @param dynamic_stepping: bool, flag indicating the use of dynamic stepping (True) or
                                  constant stepping (False)

◆ validate()

def qtwidgets.scientific_spinbox.ScienSpinBox.validate (   self,
  text,
  position 
)

Access method to the validator.

See IntegerValidator class for more information.

   @param text: str, string to be validated.
   @param position: int, current text cursor position
   @return: (enum QValidator::State) the returned validator state,
            (str) the input string, (int) the cursor position

◆ value()

def qtwidgets.scientific_spinbox.ScienSpinBox.value (   self)

Getter method to obtain the current value as int.

Returns
: int, the current value of the SpinBox

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