Package wx :: Package lib :: Package ogl :: Class DivisionShape
[frames | no frames]

Type DivisionShape

     object --+                
              |                
ShapeEvtHandler --+            
                  |            
              Shape --+        
                      |        
         RectangleShape --+    
                          |    
             CompositeShape --+
                              |
                             DivisionShape


A division shape is like a composite in that it can contain further objects, but is used exclusively to divide another shape into regions, or divisions. A wxDivisionShape is never free-standing.

Derived from:
wxCompositeShape

Method Summary
  __init__(self)
  AdjustLeft(self, left, test)
Adjust a side.
  AdjustRight(self, right, test)
Adjust a side.
  AdjustTop(self, top, test)
Adjust a side.
  CalculateSize(self)
Calculates the size and position of the composite based on child sizes and positions.
  Divide(self, direction)
Divide this division into two further divisions, horizontally (direction is wxHORIZONTAL) or vertically (direction is wxVERTICAL).
  EditEdge(self, side)
  GetBottomSide(self)
Return the division on the bottom side of this division.
  GetHandleSide(self)
Return the side which the handle appears on.
  GetLeftSide(self)
Return the division on the left side of this division.
  GetLeftSideColour(self)
Return the colour used for drawing the left side of the division.
  GetLeftSidePen(self)
Return the pen used for drawing the left side of the division.
  GetLeftSideStyle(self)
Return the style used for the left side of the division.
  GetRightSide(self)
Return the division on the right side of this division.
  GetTopSide(self)
Return the division on the top side of this division.
  GetTopSideColour(self)
Return the colour used for drawing the top side of the division.
  GetTopSidePen(self)
Return the pen used for drawing the top side of the division.
  GetTopSideStyle(self)
Return the style used for the top side of the division.
  MakeControlPoints(self)
Make a list of control points (draggable handles) appropriate to the shape.
  MakeMandatoryControlPoints(self)
Make the mandatory control points.
  OnBeginDragLeft(self, x, y, keys, attachment)
  OnDragLeft(self, draw, x, y, keys, attachment)
  OnDraw(self, dc)
  OnDrawContents(self, dc)
  OnEndDragLeft(self, x, y, keys, attachment)
  OnMovePre(self, dc, x, y, oldx, oldy, display)
  OnRightClick(self, x, y, keys, attachment)
  PopupMenu(self, x, y)
  ResetControlPoints(self)
Reset the positions of the control points (for instance when the shape's shape has changed).
  ResetMandatoryControlPoints(self)
Reset the mandatory control points.
  ResizeAdjoining(self, side, newPos, test)
Resize adjoining divisions at the given side.
  SetBottomSide(self, shape)
Set the the division on the bottom side of this division.
  SetHandleSide(self, side)
Sets the side which the handle appears on.
  SetLeftSide(self, shape)
Set the the division on the left side of this division.
  SetLeftSideColour(self, colour)
Set the colour for drawing the left side of the division.
  SetLeftSidePen(self, pen)
Set the colour for drawing the left side of the division.
  SetLeftSideStyle(self, style)
  SetRightSide(self, shape)
Set the the division on the right side of this division.
  SetSize(self, w, h, recursive)
  SetTopSide(self, shape)
Set the the division on the top side of this division.
  SetTopSideColour(self, colour)
Set the colour for drawing the top side of the division.
  SetTopSidePen(self, pen)
Set the colour for drawing the top side of the division.
  SetTopSideStyle(self, style)

Class Variable Summary

Method Details

AdjustLeft(self, left, test)

Adjust a side.

Returns FALSE if it's not physically possible to adjust it to this point.

AdjustRight(self, right, test)

Adjust a side.

Returns FALSE if it's not physically possible to adjust it to this point.

AdjustTop(self, top, test)

Adjust a side.

Returns FALSE if it's not physically possible to adjust it to this point.

CalculateSize(self)

Calculates the size and position of the composite based on child sizes and positions.

Overrides:
wx.lib.ogl.CompositeShape.CalculateSize (inherited documentation)

Divide(self, direction)

Divide this division into two further divisions, horizontally (direction is wxHORIZONTAL) or vertically (direction is wxVERTICAL).

GetBottomSide(self)

Return the division on the bottom side of this division.

GetHandleSide(self)

Return the side which the handle appears on.

GetLeftSide(self)

Return the division on the left side of this division.

GetLeftSideColour(self)

Return the colour used for drawing the left side of the division.

GetLeftSidePen(self)

Return the pen used for drawing the left side of the division.

GetLeftSideStyle(self)

Return the style used for the left side of the division.

GetRightSide(self)

Return the division on the right side of this division.

GetTopSide(self)

Return the division on the top side of this division.

GetTopSideColour(self)

Return the colour used for drawing the top side of the division.

GetTopSidePen(self)

Return the pen used for drawing the top side of the division.

GetTopSideStyle(self)

Return the style used for the top side of the division.

MakeControlPoints(self)

Make a list of control points (draggable handles) appropriate to the shape.

Overrides:
wx.lib.ogl.Shape.MakeControlPoints (inherited documentation)

MakeMandatoryControlPoints(self)

Make the mandatory control points.

For example, the control point on a dividing line should appear even if the divided rectangle shape's handles should not appear (because it is the child of a composite, and children are not resizable).

Overrides:
wx.lib.ogl.Shape.MakeMandatoryControlPoints (inherited documentation)

ResetControlPoints(self)

Reset the positions of the control points (for instance when the shape's shape has changed).

Overrides:
wx.lib.ogl.Shape.ResetControlPoints (inherited documentation)

ResetMandatoryControlPoints(self)

Reset the mandatory control points.

Overrides:
wx.lib.ogl.Shape.ResetMandatoryControlPoints (inherited documentation)

ResizeAdjoining(self, side, newPos, test)

Resize adjoining divisions at the given side.

If test is TRUE, just see whether it's possible for each adjoining region, returning FALSE if it's not.

side can be one of:

  • DIVISION_SIDE_NONE
  • DIVISION_SIDE_LEFT
  • DIVISION_SIDE_TOP
  • DIVISION_SIDE_RIGHT
  • DIVISION_SIDE_BOTTOM

SetBottomSide(self, shape)

Set the the division on the bottom side of this division.

SetHandleSide(self, side)

Sets the side which the handle appears on.

Either DIVISION_SIDE_LEFT or DIVISION_SIDE_TOP.

SetLeftSide(self, shape)

Set the the division on the left side of this division.

SetLeftSideColour(self, colour)

Set the colour for drawing the left side of the division.

SetLeftSidePen(self, pen)

Set the colour for drawing the left side of the division.

SetRightSide(self, shape)

Set the the division on the right side of this division.

SetTopSide(self, shape)

Set the the division on the top side of this division.

SetTopSideColour(self, colour)

Set the colour for drawing the top side of the division.

SetTopSidePen(self, pen)

Set the colour for drawing the top side of the division.


Generated by Epydoc 2.1.20050511.rpd on Mon Feb 16 12:55:16 2009 http://epydoc.sf.net