eagle.Spin

Module eagle :: Class Spin

[show private | hide private]

Type Spin

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.

Method Summary
	`__init__(self, id, label, value, min, max, step, digits, callback, persistent, expand_policy, active, visible)` Spin constructor.
	`__setup_connections__(self)`
	`__setup_gui__(self)`
	`set_value(self, value)` Set data to this widget.
Inherited from _EGWidLabelEntry
	`__configure_orientation__(self, setting)`
	`__repr__(self)`
	`__str__(self)`
	`get_label(self)`
	`get_value(self)` Get data from this widget.
	`set_label(self, label)`
Inherited from _EGWidget
	`__get_widgets__(self)` Return a list of internal widgets this Eagle widget contains.
	`_get_widgets(self)`
	`_set_widgets(self, value)`
	`disable(self)` Same as `set_active`( False )
	`enable(self, active)` Set the widget as active.
	`focus(self)` Give keyboard focus to this widget.
	`get_active(self)` Return True if it's active (enabled) or False inactive (disabled).
	`get_visible(self)` Return true if widget is visible (shown).
	`hide(self)` Make widget invisible.
	`is_active(self)` Return True if it's active (enabled) or False inactive (disabled).
	`is_enabled(self)` Return True if it's active (enabled) or False inactive (disabled).
	`is_visible(self)` Return true if widget is visible (shown).
	`set_active(self, active)` Set the widget as active.
	`set_inactive(self)` Same as `set_active`( False )
	`set_visible(self, visible)` Show or hide widget based on value of 'visible'.
	`show(self)` Make widget visible.
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value

Property Summary
	`callback`
	`digits`
	`max`
	`min`
	`step`
	`value`
Inherited from _EGWidLabelEntry
	`label`
Inherited from _EGWidget
	`_widgets`
	`active`
	`app`
	`visible`
Inherited from _EGObject
	`id`

Class Variable Summary
`float`	`default_max` = 9.9999999999999995e+59
`float`	`default_min` = -9.9999999999999995e+59
Inherited from _EGDataWidget
`bool`	`persistent` = `False`
Inherited from _EGWidget
`int`	`ORIENTATION_HORIZONTAL` = 1
`int`	`ORIENTATION_VERTICAL` = 0

Method Details

init(self, id, label='', value=None, min=None, max=None, step=None, digits=3, callback=None, persistent=False, expand_policy=None, active=True, visible=True)
(Constructor)

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:: eagle._EGWidLabelEntry.__init__

set_value(self, value)

Set data to this widget.

Overrides:: eagle._EGWidLabelEntry.set_value (inherited documentation)

Property Details

callback

Get Method:: get(...)
Set Method:: set(...)

digits

Get Method:: get(...)
Set Method:: set(...)

max

Get Method:: get(...)
Set Method:: set(...)

min

Get Method:: get(...)
Set Method:: set(...)

step

Get Method:: get(...)
Set Method:: set(...)

value

Get Method:: get(...)
Set Method:: set(...)

Class Variable Details

default_max

Type:: float
Value:: 9.9999999999999995e+59

default_min

Type:: float
Value:: -9.9999999999999995e+59

Generated by Epydoc 2.1 on Sun Apr 22 21:30:28 2007

http://epydoc.sf.net