ocempgui.widgets.Box.Box

Package ocempgui :: Package widgets :: Module Box :: Class Box

[show private | hide private]

Type Box

 object --+                
          |                
INotifyable --+            
              |            
     BaseObject --+        
                  |        
     object --+   |        
              |   |        
         Sprite --+        
                  |        
         BaseWidget --+    
                      |    
              Container --+
                          |
                         Box

Box (width, height) -> Box

A container widget which allows absolute positioning of its widgets.

The Box widget places its attached children relative to it own topleft coordinates but does not layout them. Instead they are positioned absolutely, which includes possible overlapping blits outside of the visible Box area.

Default action (invoked by activate()): None

Mnemonic action (invoked by activate_mnemonic()): None

Method Summary
	`__init__(self, width, height)`
	`draw(self)` B.draw () -> None
	`draw_bg(self)` B.draw_bg () -> None
	`set_focus(self, focus)` B.set_focus (focus=True) -> None
Inherited from Container
	`add_child(self, *children)` C.add_child (...) -> None
	`calculate_size(self)` C.calculate_size (...) -> int, int
	`destroy(self)` C.destroy () -> None
	`dispose_widgets(self)` C.dispose_widgets (...) -> None
	`insert_child(self, pos, *children)` C.insert_child (...) -> None
	`remove_child(self, child)` C.remove_child (...) -> None
	`set_children(self, children)` C.set_children (...) -> None
	`set_depth(self, depth)` C.set_depth (...) -> None
	`set_event_manager(self, manager)` C.set_event_manager (...) -> None
	`set_indexable(self, indexable)` C.set_indexable (...) -> None
	`set_padding(self, padding)` C.set_padding (...) -> None
	`set_sensitive(self, sensitive)` C.set_sensitive (...) -> None
	`set_spacing(self, spacing)` C.set_spacing (...) -> None
	`update(self, **kwargs)` C.update (...) -> None
Inherited from BaseWidget
	`activate(self)` W.activate () -> None
	`activate_mnemonic(self, mnemonic)` W.activate_mnemonic (...) -> bool
	`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
	`notify(self, event)` W.notify (...) -> 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_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_state(self, state)` W.set_state (...) -> None
	`set_style(self, style)` W.set_style (...) -> None
	`set_tooltip(self, tooltip)` W.set_tooltip (...) -> None
	`unlock(self)` W.unlock () -> 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 Container
	`children`: List of the children for the Container.
	`padding`: The additional padding for the Container.
	`spacing`: The spacing between the children.
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)

B.draw () -> None

Draws the Box surface and places its children on it.

Overrides:: ocempgui.widgets.BaseWidget.BaseWidget.draw

draw_bg(self)

B.draw_bg () -> None

Draws the Box background surface and returns it.

Creates the visible surface of the Box and returns it to the caller.

Overrides:: ocempgui.widgets.BaseWidget.BaseWidget.draw_bg

set_focus(self, focus=True)

B.set_focus (focus=True) -> None

Overrides the set_focus() behaviour for the Box.

The Box class is not focusable by default. It is a layout class for other widgets, so it does not need to get the input focus and thus it will return false without doing anything.

Overrides:: ocempgui.widgets.BaseWidget.BaseWidget.set_focus

Generated by Epydoc 2.1 on Thu Jan 10 10:18:43 2008

http://epydoc.sf.net