Package fife :: Package extensions :: Package pychan :: Package widgets' :: Module scrollarea :: Class ScrollArea

Class ScrollArea

   object --+    
            |    
widget.Widget --+
                |
               ScrollArea

A wrapper around another (content) widget.

New Attributes

content: The wrapped widget.
vertical_scrollbar: Boolean: Set this to False to hide the Vertical scrollbar
horizontal_scrollbar: Boolean: Set this to False to hide the Horizontal scrollbar

Instance Methods

[hide private]

__init__(self, parent=None, name=None, size=None, min_size=None, max_size=None, helptext=None, position=None, style=None, hexpand=None, vexpand=None, font=None, base_color=None, background_color=None, foreground_color=None, selection_color=None, border_size=None, position_technique=None, is_focusable=None, comment=None, content=None, vertical_scrollbar=None, horizontal_scrollbar=None)
x.__init__(...) initializes x; see x.__class__.__doc__ for signature

source code

addChild(self, widget)
This function adds a widget as child widget and is only implemented in container widgets.

source code

removeChild(self, widget)
This function removes a direct child widget and is only implemented in container widgets.

source code

_setContent(self, content)

source code

_getContent(self)

source code

deepApply(self, visitorFunc, leaves_first=True)
Recursively apply a callable to all contained widgets and then the widget itself.

source code

resizeToContent(self, recurse=True)
Try to shrink the widget, so that it fits closely around its content.

source code

_visibilityToScrollPolicy(self, visibility)

source code

_scrollPolicyToVisibility(self, policy)

source code

_setHorizontalScrollbar(self, visibility)

source code

_setVerticalScrollbar(self, visibility)

source code

_getHorizontalScrollbar(self)

source code

_getVerticalScrollbar(self)

source code

sizeChanged(self)

source code

getVerticalMaxScroll(self)

source code

getHorizontalMaxScroll(self)

source code

_getHorizontalScrollAmount(self)

source code

_setHorizontalScrollAmount(self, scroll_amount)

source code

_getVerticalScrollAmount(self)

source code

_setVerticalScrollAmount(self, scroll_amount)

source code

Inherited from widget.Widget: __repr__, __str__, adaptLayout, addChildren, afterHide, beforeShow, capture, collectData, collectDataAsDict, distributeData, distributeInitialData, execute, expandContent, findChild, findChildByName, findChildren, getAbsolutePos, getData, getNamedChildren, hide, insertChild, insertChildBefore, isCaptured, isVisible, listNamedWidgets, mapEvents, match, removeAllChildren, removeChildren, requestFocus, setData, setInitialData, show, stylize

Inherited from widget.Widget (private): _getBorderSize, _getFont, _getHeight, _getMaxHeight, _getMaxWidth, _getMinHeight, _getMinWidth, _getName, _getParent, _getPosition, _getSize, _getStyle, _getWidth, _getX, _getY, _isFocusable, _recursiveExpandContent, _recursiveResizeToContent, _setBorderSize, _setFocusable, _setFont, _setHeight, _setMaxHeight, _setMaxWidth, _setMinHeight, _setMinWidth, _setName, _setParent, _setPosition, _setSize, _setStyle, _setWidth, _setX, _setY

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

Class Variables

[hide private]

ATTRIBUTES = Widget.ATTRIBUTES+ [BoolAttr("vertical_scrollbar"...

DEFAULT_HEXPAND = 1

DEFAULT_VEXPAND = 1

content = property(_getContent, _setContent)

vertical_scrollbar = property(_getVerticalScrollbar, _setVerti...

horizontal_scrollbar = property(_getHorizontalScrollbar, _setH...

horizontal_scroll_amount = property(_getHorizontalScrollAmount...

vertical_scroll_amount = property(_getVerticalScrollAmount, _s...

Inherited from widget.Widget: DEFAULT_BORDER_SIZE, DEFAULT_COMMENT, DEFAULT_FONT, DEFAULT_HELPTEXT, DEFAULT_MAX_SIZE, DEFAULT_MIN_SIZE, DEFAULT_NAME, DEFAULT_POSITION, DEFAULT_POSITION_TECHNIQUE, DEFAULT_SIZE, HIDE_SHOW_ERROR, background_color, base_color, border_size, font, foreground_color, height, is_focusable, max_height, max_width, min_height, min_width, name, parent, position, selection_color, size, style, width, x, y

Properties

[hide private]

Inherited from object: __class__

Method Details

[hide private]

init(self, parent=None, name=None, size=None, min_size=None, max_size=None, helptext=None, position=None, style=None, hexpand=None, vexpand=None, font=None, base_color=None, background_color=None, foreground_color=None, selection_color=None, border_size=None, position_technique=None, is_focusable=None, comment=None, content=None, vertical_scrollbar=None, horizontal_scrollbar=None)
(Constructor)

source code

x.__init__(...) initializes x; see x.__class__.__doc__ for signature

Overrides: object.__init__: (inherited documentation)

addChild(self, widget)

source code

This function adds a widget as child widget and is only implemented in container widgets.

You'll need to call adaptLayout if the container is already shown, to adapt the layout to the new widget. This doesn't happen automatically.

Overrides: widget.Widget.addChild: (inherited documentation)

removeChild(self, widget)

source code

This function removes a direct child widget and is only implemented in container widgets.

You'll need to call adaptLayout if the container is already shown, to adapt the layout to the removed widget. This doesn't happen automatically.

Overrides: widget.Widget.removeChild: (inherited documentation)

deepApply(self, visitorFunc, leaves_first=True)

source code

Recursively apply a callable to all contained widgets and then the widget itself.

Overrides: widget.Widget.deepApply: (inherited documentation)

resizeToContent(self, recurse=True)

source code

Try to shrink the widget, so that it fits closely around its content. Do not call directly.

Overrides: widget.Widget.resizeToContent: (inherited documentation)

sizeChanged(self)

source code

Overrides: widget.Widget.sizeChanged

Class Variable Details

[hide private]

ATTRIBUTES

Value:

Widget.ATTRIBUTES+ [BoolAttr("vertical_scrollbar"), BoolAttr("horizont
al_scrollbar")]

vertical_scrollbar

Value:

property(_getVerticalScrollbar, _setVerticalScrollbar)

horizontal_scrollbar

Value:

property(_getHorizontalScrollbar, _setHorizontalScrollbar)

horizontal_scroll_amount

Value:

property(_getHorizontalScrollAmount, _setHorizontalScrollAmount)

vertical_scroll_amount

Value:

property(_getVerticalScrollAmount, _setVerticalScrollAmount)