Module eagle :: Class Spin
[hide private]
[frames] | no frames]

Class Spin
source code

object --+                
         |                
 _EGObject --+            
             |            
     _EGWidget --+        
                 |        
     _EGDataWidget --+    
                     |    
      _EGWidLabelEntry --+
                         |
                        Spin
Known Subclasses:
IntSpin

Spin button entry.

Spin buttons are numeric user input that checks if value is inside a specified range. It also provides small buttons to help incrementing/ decrementing value.

Instance Methods [hide private]
  __init__(self, id, label="", value=None, min=None, max=None, step=None, digits=3, callback=None, persistent=False, expand_policy=None)
Spin constructor.
  __setup_gui__(self)
  __setup_connections__(self)
  set_value(self, value)

Inherited from _EGWidLabelEntry: __configure_orientation__, __repr__, __str__, get_label, get_value, set_label

Inherited from _EGWidget: __get_widgets__, hide, set_active, set_inactive, show

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__


Class Variables [hide private]
default_min  
default_max  
value  
min  
max  
step  
digits  
callback  

Inherited from _EGWidLabelEntry: label

Inherited from _EGDataWidget: persistent

Inherited from _EGWidget: ORIENTATION_HORIZONTAL, ORIENTATION_VERTICAL, app

Inherited from _EGObject: id

Inherited from object: __class__


Method Details [hide private]

__init__(self, id, label="", value=None, min=None, max=None, step=None, digits=3, callback=None, persistent=False, expand_policy=None)
(Constructor)

source code 
Spin constructor.
Parameters:
  • id - unique identifier.
  • label - what to show on a label on the left side of the widget.
  • value - initial content.
  • min - minimum value. If None, default_min will be used.
  • max - maximum value. If None, default_max will be used.
  • step - step to use to decrement/increment using buttons.
  • digits - how many digits to show.
  • callback - function (or list of functions) that will be called when this widget have its data changed. Function will receive as parameters:
    • App reference
    • Widget reference
    • new value
  • persistent - if this widget should save its data between sessions.
  • expand_policy - how this widget should fit space, see ExpandPolicy.Policy.Rule.
Overrides: _EGWidLabelEntry.__init__

__setup_gui__(self)

source code 
Overrides: _EGWidLabelEntry.__setup_gui__

__setup_connections__(self)

source code 

set_value(self, value)

source code 
Overrides: _EGWidLabelEntry.set_value

Class Variable Details [hide private]

default_min

Value:
-1e60                                                                  
      

default_max

Value:
1e60                                                                   
      

value

Value:
_gen_ro_property("value")                                              
      

min

Value:
_gen_ro_property("min")                                                
      

max

Value:
_gen_ro_property("max")                                                
      

step

Value:
_gen_ro_property("step")                                               
      

digits

Value:
_gen_ro_property("digits")                                             
      

callback

Value:
_gen_ro_property("callback")