Table Of Contents

Previous topic

DivisionControlPoint

Next topic

PopupDivisionMenu

This Page

phoenix_title 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

class_hierarchy Inheritance Diagram

Inheritance diagram for class DivisionShape

Inheritance diagram of DivisionShape


method_summary Methods Summary

__init__  
AdjustLeft Adjust a side.
AdjustRight Adjust a side.
AdjustTop Adjust a side.
CalculateSize  
Divide Divide this division into two further divisions,
EditEdge  
GetBottomSide Return the division on the bottom side of this division.
GetHandleSide Return the side which the handle appears on.
GetLeftSide Return the division on the left side of this division.
GetLeftSideColour Return the colour used for drawing the left side of the division.
GetLeftSidePen Return the pen used for drawing the left side of the division.
GetLeftSideStyle Return the style used for the left side of the division.
GetRightSide Return the division on the right side of this division.
GetTopSide Return the division on the top side of this division.
GetTopSideColour Return the colour used for drawing the top side of the division.
GetTopSidePen Return the pen used for drawing the top side of the division.
GetTopSideStyle Return the style used for the top side of the division.
MakeControlPoints  
MakeMandatoryControlPoints  
OnBeginDragLeft  
OnDragLeft  
OnDraw  
OnDrawContents  
OnEndDragLeft  
OnMovePre  
OnRightClick  
PopupMenu  
ResetControlPoints  
ResetMandatoryControlPoints  
ResizeAdjoining Resize adjoining divisions at the given side.
SetBottomSide Set the the division on the bottom side of this division.
SetHandleSide Sets the side which the handle appears on.
SetLeftSide Set the the division on the left side of this division.
SetLeftSideColour Set the colour for drawing the left side of the division.
SetLeftSidePen Set the colour for drawing the left side of the division.
SetLeftSideStyle  
SetRightSide Set the the division on the right side of this division.
SetSize  
SetTopSide Set the the division on the top side of this division.
SetTopSideColour Set the colour for drawing the top side of the division.
SetTopSidePen Set the colour for drawing the top side of the division.
SetTopSideStyle  

api Class API



class DivisionShape(CompositeShape)

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

Methods



__init__(self)


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)


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)


MakeMandatoryControlPoints(self)


OnBeginDragLeft(self, x, y, keys = 0, attachment = 0)


OnDragLeft(self, draw, x, y, keys = 0, attachment = 0)


OnDraw(self, dc)


OnDrawContents(self, dc)


OnEndDragLeft(self, x, y, keys = 0, attachment = 0)


OnMovePre(self, dc, x, y, oldx, oldy, display = True)


OnRightClick(self, x, y, keys = 0, attachment = 0)


PopupMenu(self, x, y)


ResetControlPoints(self)


ResetMandatoryControlPoints(self)


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.



SetLeftSideStyle(self, style)


SetRightSide(self, shape)

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



SetSize(self, w, h, recursive = True)


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)