ocempgui.widgets.ScrolledWindow.ScrolledWindow

Package ocempgui :: Package widgets :: Module ScrolledWindow :: Class ScrolledWindow

[show private | hide private]

Type ScrolledWindow

 object --+                
          |                
INotifyable --+            
              |            
     BaseObject --+        
                  |        
     object --+   |        
              |   |        
         Sprite --+        
                  |        
         BaseWidget --+    
                      |    
                    Bin --+
                          |
                         ScrolledWindow

Known Subclasses:: ScrolledList

ScrolledWindow (width, height) -> ScrolledWindow

A widget class, which supports horizontal and vertical scrolling.

The ScrolledWindow is a viewport, which enables its child to be
scrolled horizontally and vertically. It offers various scrolling
types, which customize the bahviour of the supplied scrollbars.

The scrolling behaviour of the ScrolledWindow can be adjusted
through the 'scrolling' attribute or set_scrolling() method and can
be one of the SCROLL_TYPES constants.

Default action (invoked by activate()):
Gives the ScrolledWindow the input focus.

Mnemonic action (invoked by activate_mnemonic()):
None

Signals:
SIG_KEYDOWN   - Invoked, when a key is pressed while the ScrolledWindow
                has the input focus.
SIG_MOUSEDOWN - Invoked, when a mouse button is pressed over the
                ScrolledWindow.

Attributes:
scrolling  - The scrolling behaviour of the ScrolledWindow.
vscrollbar - The vertical scrollbar of the ScrolledWindow.
hscrollbar - The horizontal scrollbar of the ScrolledWindow.

Method Summary
	`__init__(self, width, height)`
	`activate(self)` S.activate () -> None
	`draw(self)` W.draw () -> None
	`draw_bg(self)` S.draw_bg () -> Surface
	`notify(self, event)` S.notify (...) -> None
	`set_child(self, child)` B.set_child (...) -> None
	`set_scrolling(self, scrolling)` S.set_scrolling (...) -> None
	`_scroll_child(self)` S._scroll_child () -> None
	`_update_scrollbars(self)` S._update_scrollbars (...) -> bool, 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
	`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
	`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_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
	`_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
	`hscrollbar`: The herizontal scrollbar.
	`scrolling`: The scrolling behaviour for the ScrolledWindow.
	`vscrollbar`: The vertical scrollbar.
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

activate(self)

S.activate () -> None

Activates the ScrolledWindow default action.

Activates the ScrolledWindow default action. This usually means giving the ScrolledWindow the input focus.

Overrides:: ocempgui.widgets.BaseWidget.BaseWidget.activate

draw(self)

W.draw () -> None

Draws the ScrolledWindow surface.

Creates the visible surface of the ScrolledWindow.

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

draw_bg(self)

S.draw_bg () -> Surface

Draws the ScrolledWindow background surface and returns it.

Creates the visible background surface of the ScrolledWindow and returns it to the caller.

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

notify(self, event)

S.notify (...) -> None

Notifies the ScrolledWindow about an event.

Overrides:: ocempgui.widgets.BaseWidget.BaseWidget.notify

set_child(self, child=None)

B.set_child (...) -> None

Sets the child to display in the ScrolledList.

Creates a parent-child relationship from the ScrolledList to a widget. If the widget does not support native scrolling, it will be packed into a ViewPort.

Overrides:: ocempgui.widgets.Bin.Bin.set_child

set_scrolling(self, scrolling)

S.set_scrolling (...) -> None

Sets the scrolling behaviour for the ScrolledWindow.

The scrolling can be a value of the SCROLL_TYPES list. SCROLL_AUTO causes the ScrolledList to display its scrollbars on demand only, SCROLL_ALWAYS will show the scrollbars permanently and SCROLL_NEVER will disable the scrollbars.

Raises a ValueError, if the passed argument is not a value of the SCROLL_TYPES tuple.

_scroll_child(self)

S._scroll_child () -> None

Scrolls the child of the ScrolledWindow.

_update_scrollbars(self)

S._update_scrollbars (...) -> bool, bool

Updates the size and maximum values of the attached scrollbars.

Updates the size and values of the attached scrollbars and returns boolean values about their visibility in the order hscrollbar, vscrollbar.

Property Details

hscrollbar

The herizontal scrollbar.

Get Method:: unknown-696476644(...)

scrolling

The scrolling behaviour for the ScrolledWindow.

Get Method:: unknown-696476476(...)
Set Method:: unknown-696476532(...)

vscrollbar

The vertical scrollbar.

Get Method:: unknown-696476588(...)

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

http://epydoc.sf.net