Package wx :: Class ScrollBar
[frames | no frames]

Type ScrollBar

object --+                
         |                
    Object --+            
             |            
    EvtHandler --+        
                 |        
            Window --+    
                     |    
               Control --+
                         |
                        ScrollBar


Proxy of C++ ScrollBar class
Method Summary
Control __init__(self, parent, id, pos, size, style, validator, name)
Create a Control.
  __repr__(self)
bool Create(self, parent, id, pos, size, style, validator, name)
Do the 2nd phase and create the GUI control.
VisualAttributes GetClassDefaultAttributes(variant)
Get the default attributes for this class. (Static method)
int GetPageSize(self)
int GetRange(self)
int GetThumbLength(self)
int GetThumbPosition(self)
int GetThumbSize(self)
bool IsVertical(self)
  SetScrollbar(self, orientation, position, thumbSize, range, refresh)
  SetThumbPosition(self, viewStart)

Instance Method Details

__init__(self, parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=SB_HORIZONTAL, validator=DefaultValidator, name=ScrollBarNameStr)
(Constructor)

Create a Control. Normally you should only call this from a subclass' __init__ as a plain old wx.Control is not very useful.
Parameters:
parent
           (type=Window)
id
           (type=int)
pos
           (type=Point)
size
           (type=Size)
style
           (type=long)
validator
           (type=Validator)
name
           (type=String)
Returns:
Control
Overrides:
wx.Control.__init__ (inherited documentation)

Create(self, parent, id=-1, pos=DefaultPosition, size=DefaultSize, style=SB_HORIZONTAL, validator=DefaultValidator, name=ScrollBarNameStr)

Do the 2nd phase and create the GUI control.
Parameters:
parent
           (type=Window)
id
           (type=int)
pos
           (type=Point)
size
           (type=Size)
style
           (type=long)
validator
           (type=Validator)
name
           (type=String)
Returns:
bool
Overrides:
wx.Control.Create

SetScrollbar(self, position, thumbSize, range, pageSize, refresh=True)

Sets the scrollbar properties of a built-in scrollbar.
Parameters:
orientation - Determines the scrollbar whose page size is to be set. May be wx.HORIZONTAL or wx.VERTICAL.
           (type=int)
position - The position of the scrollbar in scroll units.
           (type=int)
thumbSize - The size of the thumb, or visible portion of the scrollbar, in scroll units.
           (type=int)
range - The maximum position of the scrollbar.
           (type=int)
refresh - True to redraw the scrollbar, false otherwise.
           (type=bool)
Overrides:
wx.Window.SetScrollbar (inherited documentation)

Static Method Details

GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)

Get the default attributes for this class. This is useful if you want to use the same font or colour in your own control as in a standard control -- which is a much better idea than hard coding specific colours or fonts which might look completely out of place on the user's system, especially if it uses themes.

The variant parameter is only relevant under Mac currently and is ignore under other platforms. Under Mac, it will change the size of the returned font. See wx.Window.SetWindowVariant for more about this.

Parameters:
variant
           (type=int)
Returns:
VisualAttributes

Generated by Epydoc 2.1.20040428.rpd on Tue Apr 26 14:24:48 2005 http://epydoc.sf.net