Home       Trees       Index       Help   
Package ocempgui :: Package widgets :: Module CheckButton :: Class CheckButton
[show private | hide private]
[frames | no frames]

Type CheckButton

 object --+                        
          |                        
INotifyable --+                    
              |                    
     BaseObject --+                
                  |                
     object --+   |                
              |   |                
         Sprite --+                
                  |                
         BaseWidget --+            
                      |            
                    Bin --+        
                          |        
                 ButtonBase --+    
                              |    
                   ToggleButton --+
                                  |
                                 CheckButton

CheckButton (text) -> CheckButton

A button widget class with a check displaying its state.

The CheckButton widget has the same functionality as the ToggleButton widget, but uses a different look. It places a small check box besides its Label, which displays the state of the CheckButton.

Default action (invoked by activate()): See the ToggleButton class.

Mnemonic action (invoked by activate_mnemonic()): See the ToggleButton class.
Method Summary
  __init__(self, text)
  draw(self)
C.draw () -> None
  draw_bg(self)
C.draw_bg () -> Surface
    Inherited from ToggleButton
  activate(self)
T.activate () -> None
  get_text(self)
T.get_text () -> string
  notify(self, event)
T.notify (event) -> None
  set_active(self, active)
T.set_active (...) -> None
  set_border(self, border)
T.set_border (...) -> None
  set_child(self, child)
B.set_child (...) -> None
  set_state(self, state)
T.set_state (...) -> None
  set_text(self, text)
T.set_text (...) -> None
    Inherited from ButtonBase
  activate_mnemonic(self, mnemonic)
B.activate_mnemonic (...) -> bool
    Inherited from Bin
  destroy(self)
B.destroy () -> None
  set_depth(self, depth)
B.set_depth (...) -> None
  set_event_manager(self, manager)
B.set_event_manager (...) -> None
  set_indexable(self, indexable)
B.set_indexable (...) -> None
  set_padding(self, padding)
B.set_padding (...) -> None
  set_sensitive(self, sensitive)
B.set_sensitive (...) -> None
  update(self, **kwargs)
B.update (...) -> None
    Inherited from BaseWidget
  check_sizes(self, width, height)
W.check_sizes (...) -> int, int
  create_style(self)
W.create_style () -> WidgetStyle
  debug_update(self)
For debugging usage only
  get_style(self)
W.get_style () -> WidgetStyle
  initclass(cls)
B.initclass () -> None (Class method)
  lock(self)
W.lock () -> None
  rect_to_client(self, rect)
W.rect_to_client (...) -> pygame.Rect
  set_dirty(self, dirty, update)
W.set_dirty (...) -> None
  set_entered(self, entered)
W.set_entered (...) -> None
  set_event_area(self, area)
W.set_event_area (...) -> None
  set_focus(self, focus)
W.set_focus (...) -> bool
  set_index(self, index)
W.set_index (...) -> None
  set_maximum_size(self, width, height)
W.set_maximum_size (...) -> None
  set_minimum_size(self, width, height)
W.set_minimum_size (...) -> None
  set_opacity(self, opacity)
W.set_opacity (...) -> None
  set_position(self, x, y)
W.set_position (...) -> None
  set_size(self, width, height)
W.set_size (...) -> None
  set_style(self, style)
W.set_style (...) -> None
  set_tooltip(self, tooltip)
W.set_tooltip (...) -> None
  unlock(self)
W.unlock () -> None
  _get_rect(self)
W._get_rect () -> pygame.Rect
  _get_rect_attr(self, attr)
W._get_rect_attr (...) -> var
  _set_rect_attr(self, attr, value)
W._set_rect_attr (...) -> None
    Inherited from BaseObject
  connect_signal(self, signal, callback, *data)
B.connect_signal (...) -> EventCallback
  disconnect_signal(self, event)
B.disconnect_signal (...) -> None
  emit(self, signal, data)
B.emit (...) -> bool
  run_signal_handlers(self, signal, *data)
B.run_signal_handlers (...) -> None
    Inherited from Sprite
  __repr__(self)
  add(self, *groups)
add(group or list of of groups, ...) add a sprite to container
  add_internal(self, group)
  alive(self)
alive() -> bool check to see if the sprite is in any groups
  groups(self)
groups() -> list of groups list used sprite containers
  kill(self)
kill() remove this sprite from all groups
  remove(self, *groups)
remove(group or list of groups, ...) remove a sprite from container
  remove_internal(self, group)
    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
  __str__(x)
x.__str__() <==> str(x)

Property Summary
    Inherited from ToggleButton
  active: The state of the ToggleButton.
  border: The border style to set for the ToggleButton.
  text: The text of the ToggleButton.
    Inherited from Bin
  child: The widget hold by the Bin.
  padding: Additional padding between child and borders.
    Inherited from BaseWidget
  bottom
  bottomleft
  bottomright
  center
  centerx
  centery
  controls: Widgets associated with the widget.
  depth: The z-axis layer depth of the widget.
  dirty: Indicates, whether the widget need to be redrawn.
  entered: Indicates, whether the widget is entered.
  eventarea: The area, which gets the events.
  focus: The focus of the widget.
  h
  height
  image: The visible surface of the widget.
  index: The tab index position of the widget.
  indexable: The IIndexable, the widget is attached to.
  left
  locked: Indicates, whether the widget is locked.
  maxsize: The maximum size to occupy by the widget.
  midbottom
  midleft
  midright
  midtop
  minsize: The guaranteed size of the widget.
  opacity: The opacity of the widget.
  position: The position of the topleft corner.
  rect: The area occupied by the widget.
  right
  sensitive: The sensitivity of the widget.
  size
  state: The current state of the widget.
  style: The style of the widget.
  tooltip: The tool tip text to display for the widget.
  top
  topleft
  topright
  w
  width
  x
  y
    Inherited from BaseObject
  manager: The event manager to use by the object.

Instance Method Details

draw(self)

C.draw () -> None

Draws the CheckButton surface.

Creates the visible surface of the CheckButton and places a check box and its Label on it.
Overrides:
ocempgui.widgets.ToggleButton.ToggleButton.draw

draw_bg(self)

C.draw_bg () -> Surface

Draws the CheckButton background surface and returns it.

Creates the visible surface of the CheckButton and returns it to the caller.
Overrides:
ocempgui.widgets.ToggleButton.ToggleButton.draw_bg

   Home       Trees       Index       Help   
Generated by Epydoc 2.1 on Thu Jan 10 10:18:44 2008 http://epydoc.sf.net