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

Type GridSizer

object --+        
         |        
    Object --+    
             |    
         Sizer --+
                 |
                GridSizer

Known Subclasses:
FlexGridSizer

A grid sizer is a sizer which lays out its children in a two-dimensional table with all cells having the same size. In other words, the width of each cell within the grid is the width of the widest item added to the sizer and the height of each grid cell is the height of the tallest item. An optional vertical and/or horizontal gap between items can also be specified (in pixels.)

Items are placed in the cells of the grid in the order they are added, in row-major order. In other words, the first row is filled first, then the second, and so on until all items have been added. (If neccessary, additional rows will be added as items are added.) If you need to have greater control over the cells that items are placed in then use the wx.GridBagSizer.


Method Summary
GridSizer __init__(self, rows, cols, vgap, hgap)
Constructor for a wx.GridSizer.
  __repr__(self)
(rows, cols) CalcRowsCols()
Calculates how many rows and columns will be in the sizer based on the current number of items and also the rows, cols specified in the constructor.
int GetCols(self)
Returns the number of columns in the sizer, as specified in the constructor.
int GetHGap(self)
Returns the horizontal gap (in pixels) between cells in the sizer.
int GetRows(self)
Returns the number of rows in the sizer, as specified in the constructor.
int GetVGap(self)
Returns the vertical gap (in pixels) between the cells in the sizer.
  SetCols(self, cols)
Sets the number of columns in the sizer.
  SetHGap(self, gap)
Sets the horizontal gap (in pixels) between cells in the sizer
  SetRows(self, rows)
Sets the number of rows in the sizer.
  SetVGap(self, gap)
Sets the vertical gap (in pixels) between the cells in the sizer.
    Inherited from Sizer
wx.SizerItem Add(self, item, proportion, flag, border, userData)
Appends a child item to the sizer.
  AddItem(self, item)
Adds a wx.SizerItem to the sizer.
  AddMany(self, items)
AddMany is a convenience method for adding several items to a sizer at one time.
  AddSizer(self, *args, **kw)
Compatibility alias for Add.
  AddSpacer(self, *args, **kw)
Compatibility alias for Add.
  AddWindow(self, *args, **kw)
Compatibility alias for Add.
Size CalcMin(self)
This method is where the sizer will do the actual calculation of its children's minimal sizes.
  Clear(self, deleteWindows)
Clear all items from the sizer, optionally destroying the window items as well.
  DeleteWindows(self)
Destroy all windows managed by the sizer.
bool Detach(self, item)
Detaches an item from the sizer without destroying it.
Size Fit(self, window)
Tell the sizer to resize the window to match the sizer's minimal size.
  FitInside(self, window)
Tell the sizer to resize the virtual size of the window to match the sizer's minimal size.
list GetChildren(self)
Returns a list of all the wx.SizerItem objects managed by the sizer.
wx.SizerItem GetItem(self, item)
Returns the wx.SizerItem which holds the item given.
Size GetMinSize(self)
Returns the minimal size of the sizer.
  GetMinSizeTuple(self)
Point GetPosition(self)
Returns the current position of the sizer's managed space.
  GetPositionTuple(self)
Size GetSize(self)
Returns the current size of the space managed by the sizer.
  GetSizeTuple(self)
  Hide(self, item, recursive)
A convenience method for Show (item, False, recursive).
wx.SizerItem Insert(self, before, item, proportion, flag, border, userData)
Inserts a new item into the list of items managed by this sizer before the item at index before.
  InsertItem(self, index, item)
Inserts a wx.SizerItem to the sizer at the position given by index.
  InsertSizer(self, *args, **kw)
Compatibility alias for Insert.
  InsertSpacer(self, *args, **kw)
Compatibility alias for Insert.
  InsertWindow(self, *args, **kw)
Compatibility alias for Insert.
  IsShown(self, item)
Determines if the item is currently shown.
  Layout(self)
This method will force the recalculation and layout of the items controlled by the sizer using the current space allocated to the sizer.
wx.SizerItem Prepend(self, item, proportion, flag, border, userData)
Adds a new item to the begining of the list of sizer items managed by this sizer.
  PrependItem(self, item)
Prepends a wx.SizerItem to the sizer.
  PrependSizer(self, *args, **kw)
Compatibility alias for Prepend.
  PrependSpacer(self, *args, **kw)
Compatibility alias for Prepend.
  PrependWindow(self, *args, **kw)
Compatibility alias for Prepend.
  RecalcSizes(self)
Using the sizes calculated by CalcMin reposition and resize all the items managed by this sizer.
bool Remove(self, item)
Removes an item from the sizer and destroys it.
  RemovePos(self, *args, **kw)
Compatibility alias for Remove.
  RemoveSizer(self, *args, **kw)
Compatibility alias for Remove.
  RemoveWindow(self, *args, **kw)
Compatibility alias for Remove.
  SetDimension(self, x, y, width, height)
Call this to force the sizer to take the given dimension and thus force the items owned by the sizer to resize themselves according to the rules defined by the parameter in the Add, Insert or Prepend methods.
  SetItemMinSize(self, item, size)
Sets the minimum size that will be allocated for an item in the sizer.
  SetMinSize(self, size)
Call this to give the sizer a minimal size.
  SetSizeHints(self, window)
Tell the sizer to set (and Fit) the minimal size of the window to match the sizer's minimal size.
  SetVirtualSizeHints(self, window)
Tell the sizer to set the minimal size of the window virtual area to match the sizer's minimal size.
bool Show(self, item, show, recursive)
Shows or hides an item managed by the sizer.
  ShowItems(self, show)
Recursively call wx.SizerItem.Show on all sizer items.
    Inherited from Object
  Destroy(self)
Deletes the C++ object this Python object is a proxy for.
String GetClassName(self)
Returns the class name of the C++ class using wxRTTI.
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
Return hash(x)...
  __new__(T, S, ...)
Return 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)
Return str(x)...

Method Details

__init__(self, rows=1, cols=0, vgap=0, hgap=0)
(Constructor)

Constructor for a wx.GridSizer. rows and cols determine the number of columns and rows in the sizer - if either of the parameters is zero, it will be calculated to from the total number of children in the sizer, thus making the sizer grow dynamically. vgap and hgap define extra space between all children.

Parameters:
rows
           (type=int)

cols
           (type=int)

vgap
           (type=int)

hgap
           (type=int)

Returns:
GridSizer
Overrides:
wx.Sizer.__init__

CalcRowsCols()

Calculates how many rows and columns will be in the sizer based on the current number of items and also the rows, cols specified in the constructor.

Returns:
(rows, cols)

GetCols(self)

Returns the number of columns in the sizer, as specified in the constructor.

Returns:
int

GetHGap(self)

Returns the horizontal gap (in pixels) between cells in the sizer.

Returns:
int

GetRows(self)

Returns the number of rows in the sizer, as specified in the constructor.

Returns:
int

GetVGap(self)

Returns the vertical gap (in pixels) between the cells in the sizer.

Returns:
int

SetCols(self, cols)

Sets the number of columns in the sizer.

Parameters:
cols
           (type=int)

SetHGap(self, gap)

Sets the horizontal gap (in pixels) between cells in the sizer

Parameters:
gap
           (type=int)

SetRows(self, rows)

Sets the number of rows in the sizer.

Parameters:
rows
           (type=int)

SetVGap(self, gap)

Sets the vertical gap (in pixels) between the cells in the sizer.

Parameters:
gap
           (type=int)


Generated by Epydoc 2.1.20050511.rpd on Sat Jun 16 17:02:16 2007 http://epydoc.sf.net