aui.py

Wxpython Implemented on Windows CE, Source code

        DestroyOnClose indicates whether a pane should be detroyed when it is
        closed.

        """
        return _aui.PaneInfo_DestroyOnClose(*args, **kwargs)

    def TopDockable(*args, **kwargs):
        """
        TopDockable(self, bool b=True) -> PaneInfo

        TopDockable indicates whether a pane can be docked at the top of the
        frame.

        """
        return _aui.PaneInfo_TopDockable(*args, **kwargs)

    def BottomDockable(*args, **kwargs):
        """
        BottomDockable(self, bool b=True) -> PaneInfo

        BottomDockable indicates whether a pane can be docked at the bottom of
        the frame.

        """
        return _aui.PaneInfo_BottomDockable(*args, **kwargs)

    def LeftDockable(*args, **kwargs):
        """
        LeftDockable(self, bool b=True) -> PaneInfo

        LeftDockable indicates whether a pane can be docked on the left of the
        frame.

        """
        return _aui.PaneInfo_LeftDockable(*args, **kwargs)

    def RightDockable(*args, **kwargs):
        """
        RightDockable(self, bool b=True) -> PaneInfo

        RightDockable indicates whether a pane can be docked on the right of
        the frame.

        """
        return _aui.PaneInfo_RightDockable(*args, **kwargs)

    def Floatable(*args, **kwargs):
        """
        Floatable(self, bool b=True) -> PaneInfo

        Floatable indicates whether a frame can be floated.

        """
        return _aui.PaneInfo_Floatable(*args, **kwargs)

    def Movable(*args, **kwargs):
        """
        Movable(self, bool b=True) -> PaneInfo

        Movable indicates whether a frame can be moved.

        """
        return _aui.PaneInfo_Movable(*args, **kwargs)

    def Dockable(*args, **kwargs):
        """
        Dockable(self, bool b=True) -> PaneInfo

        Dockable indicates whether a pane can be docked at any position of the
        frame.

        """
        return _aui.PaneInfo_Dockable(*args, **kwargs)

    def DefaultPane(*args, **kwargs):
        """
        DefaultPane(self) -> PaneInfo

        DefaultPane specifies that the pane should adopt the default pane
        settings.

        """
        return _aui.PaneInfo_DefaultPane(*args, **kwargs)

    def CentrePane(*args, **kwargs):
        """
        CentrePane(self) -> PaneInfo

        CentrePane specifies that the pane should adopt the default center
        pane settings.

        """
        return _aui.PaneInfo_CentrePane(*args, **kwargs)

    def CenterPane(*args, **kwargs):
        """
        CenterPane(self) -> PaneInfo

        CenterPane specifies that the pane should adopt the default center
        pane settings.

        """
        return _aui.PaneInfo_CenterPane(*args, **kwargs)

    def ToolbarPane(*args, **kwargs):
        """
        ToolbarPane(self) -> PaneInfo

        ToolbarPane specifies that the pane should adopt the default toolbar
        pane settings.

        """
        return _aui.PaneInfo_ToolbarPane(*args, **kwargs)

    def SetFlag(*args, **kwargs):
        """
        SetFlag(self, int flag, bool option_state) -> PaneInfo

        SetFlag turns the property given by flag on or off with the
        option_state parameter.

        """
        return _aui.PaneInfo_SetFlag(*args, **kwargs)

    def HasFlag(*args, **kwargs):
        """
        HasFlag(self, int flag) -> bool

        HasFlag returns ``True`` if the the property specified by flag is
        active for the pane.

        """
        return _aui.PaneInfo_HasFlag(*args, **kwargs)

    optionFloating = _aui.PaneInfo_optionFloating
    optionHidden = _aui.PaneInfo_optionHidden
    optionLeftDockable = _aui.PaneInfo_optionLeftDockable
    optionRightDockable = _aui.PaneInfo_optionRightDockable
    optionTopDockable = _aui.PaneInfo_optionTopDockable
    optionBottomDockable = _aui.PaneInfo_optionBottomDockable
    optionFloatable = _aui.PaneInfo_optionFloatable
    optionMovable = _aui.PaneInfo_optionMovable
    optionResizable = _aui.PaneInfo_optionResizable
    optionPaneBorder = _aui.PaneInfo_optionPaneBorder
    optionCaption = _aui.PaneInfo_optionCaption
    optionGripper = _aui.PaneInfo_optionGripper
    optionDestroyOnClose = _aui.PaneInfo_optionDestroyOnClose
    optionToolbar = _aui.PaneInfo_optionToolbar
    optionActive = _aui.PaneInfo_optionActive
    optionGripperTop = _aui.PaneInfo_optionGripperTop
    buttonClose = _aui.PaneInfo_buttonClose
    buttonMaximize = _aui.PaneInfo_buttonMaximize
    buttonMinimize = _aui.PaneInfo_buttonMinimize
    buttonPin = _aui.PaneInfo_buttonPin
    buttonCustom1 = _aui.PaneInfo_buttonCustom1
    buttonCustom2 = _aui.PaneInfo_buttonCustom2
    buttonCustom3 = _aui.PaneInfo_buttonCustom3
    actionPane = _aui.PaneInfo_actionPane
    name = property(_aui.PaneInfo_name_get, _aui.PaneInfo_name_set)
    caption = property(_aui.PaneInfo_caption_get, _aui.PaneInfo_caption_set)
    window = property(_aui.PaneInfo_window_get, _aui.PaneInfo_window_set)
    frame = property(_aui.PaneInfo_frame_get, _aui.PaneInfo_frame_set)
    state = property(_aui.PaneInfo_state_get, _aui.PaneInfo_state_set)
    dock_direction = property(_aui.PaneInfo_dock_direction_get, _aui.PaneInfo_dock_direction_set)
    dock_layer = property(_aui.PaneInfo_dock_layer_get, _aui.PaneInfo_dock_layer_set)
    dock_row = property(_aui.PaneInfo_dock_row_get, _aui.PaneInfo_dock_row_set)
    dock_pos = property(_aui.PaneInfo_dock_pos_get, _aui.PaneInfo_dock_pos_set)
    best_size = property(_aui.PaneInfo_best_size_get, _aui.PaneInfo_best_size_set)
    min_size = property(_aui.PaneInfo_min_size_get, _aui.PaneInfo_min_size_set)
    max_size = property(_aui.PaneInfo_max_size_get, _aui.PaneInfo_max_size_set)
    floating_pos = property(_aui.PaneInfo_floating_pos_get, _aui.PaneInfo_floating_pos_set)
    floating_size = property(_aui.PaneInfo_floating_size_get, _aui.PaneInfo_floating_size_set)
    dock_proportion = property(_aui.PaneInfo_dock_proportion_get, _aui.PaneInfo_dock_proportion_set)
    buttons = property(_aui.PaneInfo_buttons_get, _aui.PaneInfo_buttons_set)
    rect = property(_aui.PaneInfo_rect_get, _aui.PaneInfo_rect_set)
_aui.PaneInfo_swigregister(PaneInfo)
cvar = _aui.cvar

class FrameManager(_core.EvtHandler):
    """
    FrameManager manages the panes associated with it for a particular
    `wx.Frame`, using a pane's `PaneInfo` information to determine each
    pane's docking and floating behavior. FrameManager uses wxWidgets'
    sizer mechanism to plan the layout of each frame. It uses a
    replaceable `DockArt` class to do all drawing, so all drawing is
    localized in one area, and may be customized depending on an
    application's specific needs.

    """
    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    __repr__ = _swig_repr
    def __init__(self, *args, **kwargs): 
        """
        __init__(self, Window managed_wnd=None, int flags=AUI_MGR_DEFAULT) -> FrameManager

        Constructor.

            :param managed_wnd: Specifies the `wx.Window` which should be
                managed.  If not set in the call to this constructor then
                `SetManagedWindow` should be called later.

            :param flags: Specifies options which allow the frame management
                behavior to be modified.

        """
        _aui.FrameManager_swiginit(self,_aui.new_FrameManager(*args, **kwargs))
    __swig_destroy__ = _aui.delete_FrameManager
    __del__ = lambda self : None;
    def UnInit(*args, **kwargs):
        """
        UnInit(self)

        UnInit uninitializes the framework and should be called before a
        managed frame is destroyed. UnInit is usually called in the managed
        window's destructor.

        """
        return _aui.FrameManager_UnInit(*args, **kwargs)

    def SetFlags(*args, **kwargs):
        """
        SetFlags(self, int flags)

        SetFlags is used to specify the FrameManager's behavioral
        settings. The flags parameter is described in the docs for `__init__`

        """
        return _aui.FrameManager_SetFlags(*args, **kwargs)

    def GetFlags(*args, **kwargs):
        """
        GetFlags(self) -> int

        GetFlags returns the current FrameManager's flags.

        """
        return _aui.FrameManager_GetFlags(*args, **kwargs)

    def SetManagedWindow(*args, **kwargs):
        """
        SetManagedWindow(self, Window managed_wnd)

        SetManagedWindow is called to specify the window which is to be
        managed by the FrameManager.  It is normally a `wx.Frame` but it is
        possible to also allow docking within any container window.  This only
        needs to be called if the window was not given to the manager in the
        constructor.

        """
        return _aui.FrameManager_SetManagedWindow(*args, **kwargs)

    def GetManagedWindow(*args, **kwargs):
        """
        GetManagedWindow(self) -> Window

        GetManagedWindow returns the window currently being managed by the
        FrameManager.

        """
        return _aui.FrameManager_GetManagedWindow(*args, **kwargs)

    def SetArtProvider(*args, **kwargs):
        """
        SetArtProvider(self, DockArt art_provider)

        SetArtProvider instructs FrameManager to use the art provider
        specified for all drawing calls. This allows plugable look-and-feel
        features. The previous art provider object, if any, will be destroyed
        by FrameManager.

        :note: If you wish to use a custom `DockArt` class to override drawing
            or metrics then you shoudl derive your class from the `PyDockArt`
            class, which has been instrumented for reflecting virtual calls to
            Python methods.

        """
        return _aui.FrameManager_SetArtProvider(*args, **kwargs)

    def GetArtProvider(*args, **kwargs):
        """
        GetArtProvider(self) -> DockArt

        GetArtProvider returns the current art provider being used.

        """
        return _aui.FrameManager_GetArtProvider(*args, **kwargs)

    def _GetPaneByWidget(*args, **kwargs):
        """_GetPaneByWidget(self, Window window) -> PaneInfo"""
        return _aui.FrameManager__GetPaneByWidget(*args, **kwargs)

    def _GetPaneByName(*args, **kwargs):
        """_GetPaneByName(self, String name) -> PaneInfo"""
        return _aui.FrameManager__GetPaneByName(*args, **kwargs)

    def GetAllPanes(*args, **kwargs):
        """
        GetAllPanes(self) -> list

        GetAllPanes returns a list of `PaneInfo` objects for all panes managed
        by the frame manager.

        """
        return _aui.FrameManager_GetAllPanes(*args, **kwargs)

    def _AddPane1(*args, **kwargs):
        """_AddPane1(self, Window window, PaneInfo pane_info) -> bool"""
        return _aui.FrameManager__AddPane1(*args, **kwargs)

    def AddPaneAtPos(*args, **kwargs):
        """AddPaneAtPos(self, Window window, PaneInfo pane_info, Point drop_pos) -> bool"""
        return _aui.FrameManager_AddPaneAtPos(*args, **kwargs)

    def _AddPane2(*args, **kwargs):
        """_AddPane2(self, Window window, int direction=LEFT, String caption=wxEmptyString) -> bool"""
        return _aui.FrameManager__AddPane2(*args, **kwargs)

    def InsertPane(*args, **kwargs):
        """
        InsertPane(self, Window window, PaneInfo insert_location, int insert_level=AUI_INSERT_PANE) -> bool

        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``.

        """
        return _aui.FrameManager_InsertPane(*args, **kwargs)

    def DetachPane(*args, **kwargs):
        """
        DetachPane(self, Window window) -> bool

        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.

        """
        return _aui.FrameManager_DetachPane(*args, **kwargs)

    def SavePerspective(*args, **kwargs):
        """
        SavePerspective(self) -> String

        SavePerspective saves the entire user interface layout into an encoded
        string, which can then be stored someplace by the application.  When a
        perspective is restored using `LoadPerspective`, the entire user
        interface will return to the state it was when the perspective was