Class FrameManager

Default Class Constructor. frame specifies the wx.Frame which should be managed.
flags specifies options which allow the frame management behavior to be modified.

Returns:

EvtHandler

Overrides: wx._core.EvtHandler.__init__

GetPane() looks up a PaneInfo structure based
on the supplied window pointer.  Upon failure, GetPane()
returns an empty PaneInfo, a condition which can be checked
by calling PaneInfo.IsOk().

The pane info's structure may then be modified.  Once a pane's
info is modified, FrameManager.Update() must be called to
realize the changes in the UI.

AG: Added To Handle 2 Different Versions Of GetPane() For
wxPython/Python.         

SetFlags() is used to specify FrameManager's settings flags. flags specifies
options which allow the frame management behavior to be modified.

SetFrame() is usually called once when the frame
manager class is being initialized.  "frame" specifies
the frame which should be managed by the frame manager.

UnInit() must be called, usually in the destructor
of the frame class.   If it is not called, usually this
will result in a crash upon program exit.

SetArtProvider() instructs FrameManager to use the
specified art provider for all drawing calls.  This allows
plugable look-and-feel features.

AddPane() tells the frame manager to start managing a child window. There
are two versions of this function. The first verison allows the full spectrum
of pane parameter possibilities (AddPane1). The second version is used for
simpler user interfaces which do not require as much configuration (AddPane2).
In wxPython, simply call AddPane.

InsertPane() is used to insert either a previously unmanaged pane window
into the frame manager, or to insert a currently managed pane somewhere else.
InsertPane() will push all panes, rows, or docks aside and insert the window
into the position specified by insert_location. Because insert_location can
specify either a pane, dock row, or dock layer, the insert_level parameter is
used to disambiguate this. The parameter insert_level can take a value of
AUI_INSERT_PANE, AUI_INSERT_ROW or AUI_INSERT_DOCK.

DetachPane() tells the FrameManager to stop managing the pane specified
by window. The window, if in a floated frame, is reparented to the frame
managed by FrameManager.

SavePerspective() saves all pane information as a single string.
This string may later be fed into LoadPerspective() to restore
all pane settings.  This save and load mechanism allows an
exact pane configuration to be saved and restored at a later time.

Update() updates the layout.  Whenever changes are made to
one or more panes, this function should be called.  It is the
external entry point for running the layout engine.

DoFrameLayout() is an internal function which invokes wxSizer.Layout
on the frame's main sizer, then measures all the various UI items
and updates their internal rectangles.  This should always be called
instead of calling self._frame.Layout() directly

GetPanePart() looks up the pane border UI part of the
pane specified.  This allows the caller to get the exact rectangle
of the pane in question, including decorations like caption and border.

GetDockPixelOffset() is an internal function which returns
a dock's offset in pixels from the left side of the window
(for horizontal docks) or from the top of the window (for
vertical docks).  This value is necessary for calculating
fixel-pane/toolbar offsets when they are dragged.

ProcessDockResult() is a utility function used by DoDrop() - it checks
if a dock operation is allowed, the new dock position is copied into
the target info.  If the operation was allowed, the function returns True.

DoDrop() is an important function.  It basically takes a mouse position,
and determines where the panes new position would be.  If the pane is to be
dropped, it performs the drop operation using the specified dock and pane
arrays.  By specifying copy dock and pane arrays when calling, a "what-if"
scenario can be performed, giving precise coordinates for drop hints.

DrawHintRect() draws a drop hint rectangle. First calls DoDrop() to
determine the exact position the pane would be at were if dropped.  If
the pame would indeed become docked at the specified drop point,
DrawHintRect() then calls ShowHint() to indicate this drop rectangle.
"pane_window" is the window pointer of the pane being dragged, pt is
the mouse position, in client coordinates.

Render() draws all of the pane captions, sashes,
backgrounds, captions, grippers, pane borders and buttons.
It renders the entire user interface.