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

Class CheckBox
source code

object --+            
         |            
 _EGObject --+        
             |        
     _EGWidget --+    
                 |    
     _EGDataWidget --+
                     |
                    CheckBox

Check box.

Check box is an component that have only two values: True (checked) or False (unchecked).

Instance Methods [hide private]
  __init__(self, id, label="", state=False, callback=None, persistent=False)
Check box constructor.
  __setup_gui__(self)
  __setup_connections__(self)
  __get_resize_mode__(self)
Return a tuple with ( horizontal, vertical ) resize mode
  get_value(self)
Get data from this widget.
  set_value(self, value)
Set data to this widget.
  set_label(self, label)
  get_label(self)

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

Inherited from _EGObject: __repr__, __str__

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


Class Variables [hide private]

Inherited from _EGDataWidget: persistent

Inherited from object: __class__


Properties [hide private]
state  
label  

Inherited from _EGWidget: app

Inherited from _EGObject: id


Method Details [hide private]

__init__(self, id, label="", state=False, callback=None, persistent=False)
(Constructor)

source code 
Check box constructor.
Parameters:
  • id - unique identifier.
  • label - what to show on a label on the left side of the widget.
  • state - initial state.
  • 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.
Overrides: _EGDataWidget.__init__

__setup_gui__(self)

source code 

__setup_connections__(self)

source code 

__get_resize_mode__(self)

source code 
Return a tuple with ( horizontal, vertical ) resize mode
Overrides: _EGWidget.__get_resize_mode__

get_value(self)

source code 
Get data from this widget.
Overrides: _EGDataWidget.get_value
(inherited documentation)

set_value(self, value)

source code 
Set data to this widget.
Overrides: _EGDataWidget.set_value
(inherited documentation)

set_label(self, label)

source code 

get_label(self)

source code 

Property Details [hide private]

state

Get Method:
unreachable.get(self)
Set Method:
unreachable.set(self, value)
Delete Method:
None

label

Get Method:
eagle.CheckBox.get_label(self)
Set Method:
eagle.CheckBox.set_label(self, label)
Delete Method:
None