aui.py

Wxpython Implemented on Windows CE, Source code

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

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

    def LoadPerspective(*args, **kwargs):
        """
        LoadPerspective(self, String perspective, bool update=True) -> bool

        LoadPerspective loads a saved perspective. If ``update`` is ``True``,
        `Update` is automatically invoked, thus realizing the saved
        perspective on screen.

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

    def Update(*args, **kwargs):
        """
        Update(self)

        Update shoudl be called called after any number of changes are made to
        any of the managed panes.  Update must be invoked after `AddPane` or
        `InsertPane` are called in order to "realize" or "commit" the
        changes. In addition, any number of changes may be made to `PaneInfo`
        structures (retrieved with `GetPane` or `GetAllPanes`), but to realize
        the changes, Update must be called. This construction allows pane
        flicker to be avoided by updating the whole layout at one time.

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

    def OnRender(*args, **kwargs):
        """OnRender(self, FrameManagerEvent evt)"""
        return _aui.FrameManager_OnRender(*args, **kwargs)

    def OnPaneButton(*args, **kwargs):
        """OnPaneButton(self, FrameManagerEvent evt)"""
        return _aui.FrameManager_OnPaneButton(*args, **kwargs)

    def GetPane(self, item):
        """
        GetPane(self, window_or_info item) -> PaneInfo

        GetPane is used to search for a `PaneInfo` object either by
        widget reference or by pane name, which acts as a unique id
        for a window pane. The returned `PaneInfo` object may then be
        modified to change a pane's look, state or position. After one
        or more modifications to the `PaneInfo`, `FrameManager.Update`
        should be called to realize the changes to the user interface.

        If the lookup failed (meaning the pane could not be found in
        the manager) GetPane returns an empty `PaneInfo`, a condition
        which can be checked by calling `PaneInfo.IsOk`.
        """
        if isinstance(item, wx.Window):
            return self._GetPaneByWidget(item)
        else:
            return self._GetPaneByName(item)

    def AddPane(self, window, info=None, caption=None):
        """
        AddPane(self, window, info=None, caption=None) -> bool

        AddPane tells the frame manager to start managing a child
        window. There are two versions of this function. The first
        verison accepts a `PaneInfo` object for the ``info`` parameter
        and allows the full spectrum of pane parameter
        possibilities. (Say that 3 times fast!)

        The second version is used for simpler user interfaces which
        do not require as much configuration.  In this case the
        ``info`` parameter specifies the direction property of the
        pane info, and defaults to ``wx.LEFT``.  The pane caption may
        also be specified as an extra parameter in this form.
        """
        if type(info) == PaneInfo:
            return self._AddPane1(window, info)
        else:
            
            if info is None:
                info = wx.LEFT
            if caption is None:
                caption = ""
            return self._AddPane2(window, info, caption)

_aui.FrameManager_swigregister(FrameManager)

class FrameManagerEvent(_core.Event):
    """Proxy of C++ FrameManagerEvent class"""
    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, EventType type=wxEVT_NULL) -> FrameManagerEvent"""
        _aui.FrameManagerEvent_swiginit(self,_aui.new_FrameManagerEvent(*args, **kwargs))
    def Clone(*args, **kwargs):
        """Clone(self) -> Event"""
        return _aui.FrameManagerEvent_Clone(*args, **kwargs)

    def SetPane(*args, **kwargs):
        """SetPane(self, PaneInfo p)"""
        return _aui.FrameManagerEvent_SetPane(*args, **kwargs)

    def SetButton(*args, **kwargs):
        """SetButton(self, int b)"""
        return _aui.FrameManagerEvent_SetButton(*args, **kwargs)

    def SetDC(*args, **kwargs):
        """SetDC(self, DC pdc)"""
        return _aui.FrameManagerEvent_SetDC(*args, **kwargs)

    def GetPane(*args, **kwargs):
        """GetPane(self) -> PaneInfo"""
        return _aui.FrameManagerEvent_GetPane(*args, **kwargs)

    def GetButton(*args, **kwargs):
        """GetButton(self) -> int"""
        return _aui.FrameManagerEvent_GetButton(*args, **kwargs)

    def GetDC(*args, **kwargs):
        """GetDC(self) -> DC"""
        return _aui.FrameManagerEvent_GetDC(*args, **kwargs)

    def Veto(*args, **kwargs):
        """Veto(self, bool veto=True)"""
        return _aui.FrameManagerEvent_Veto(*args, **kwargs)

    def GetVeto(*args, **kwargs):
        """GetVeto(self) -> bool"""
        return _aui.FrameManagerEvent_GetVeto(*args, **kwargs)

    def SetCanVeto(*args, **kwargs):
        """SetCanVeto(self, bool can_veto)"""
        return _aui.FrameManagerEvent_SetCanVeto(*args, **kwargs)

    def CanVeto(*args, **kwargs):
        """CanVeto(self) -> bool"""
        return _aui.FrameManagerEvent_CanVeto(*args, **kwargs)

    pane = property(_aui.FrameManagerEvent_pane_get, _aui.FrameManagerEvent_pane_set)
    button = property(_aui.FrameManagerEvent_button_get, _aui.FrameManagerEvent_button_set)
    veto_flag = property(_aui.FrameManagerEvent_veto_flag_get, _aui.FrameManagerEvent_veto_flag_set)
    canveto_flag = property(_aui.FrameManagerEvent_canveto_flag_get, _aui.FrameManagerEvent_canveto_flag_set)
    dc = property(_aui.FrameManagerEvent_dc_get, _aui.FrameManagerEvent_dc_set)
_aui.FrameManagerEvent_swigregister(FrameManagerEvent)

class DockInfo(object):
    """Proxy of C++ DockInfo class"""
    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) -> DockInfo"""
        _aui.DockInfo_swiginit(self,_aui.new_DockInfo(*args, **kwargs))
    def IsOk(*args, **kwargs):
        """IsOk(self) -> bool"""
        return _aui.DockInfo_IsOk(*args, **kwargs)

    def IsHorizontal(*args, **kwargs):
        """IsHorizontal(self) -> bool"""
        return _aui.DockInfo_IsHorizontal(*args, **kwargs)

    def IsVertical(*args, **kwargs):
        """IsVertical(self) -> bool"""
        return _aui.DockInfo_IsVertical(*args, **kwargs)

    panes = property(_aui.DockInfo_panes_get, _aui.DockInfo_panes_set)
    rect = property(_aui.DockInfo_rect_get, _aui.DockInfo_rect_set)
    dock_direction = property(_aui.DockInfo_dock_direction_get, _aui.DockInfo_dock_direction_set)
    dock_layer = property(_aui.DockInfo_dock_layer_get, _aui.DockInfo_dock_layer_set)
    dock_row = property(_aui.DockInfo_dock_row_get, _aui.DockInfo_dock_row_set)
    size = property(_aui.DockInfo_size_get, _aui.DockInfo_size_set)
    min_size = property(_aui.DockInfo_min_size_get, _aui.DockInfo_min_size_set)
    resizable = property(_aui.DockInfo_resizable_get, _aui.DockInfo_resizable_set)
    toolbar = property(_aui.DockInfo_toolbar_get, _aui.DockInfo_toolbar_set)
    fixed = property(_aui.DockInfo_fixed_get, _aui.DockInfo_fixed_set)
_aui.DockInfo_swigregister(DockInfo)

class DockUIPart(object):
    """Proxy of C++ DockUIPart class"""
    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    def __init__(self): raise AttributeError, "No constructor defined"
    __repr__ = _swig_repr
    typeCaption = _aui.DockUIPart_typeCaption
    typeGripper = _aui.DockUIPart_typeGripper
    typeDock = _aui.DockUIPart_typeDock
    typeDockSizer = _aui.DockUIPart_typeDockSizer
    typePane = _aui.DockUIPart_typePane
    typePaneSizer = _aui.DockUIPart_typePaneSizer
    typeBackground = _aui.DockUIPart_typeBackground
    typePaneBorder = _aui.DockUIPart_typePaneBorder
    typePaneButton = _aui.DockUIPart_typePaneButton
    type = property(_aui.DockUIPart_type_get, _aui.DockUIPart_type_set)
    orientation = property(_aui.DockUIPart_orientation_get, _aui.DockUIPart_orientation_set)
    dock = property(_aui.DockUIPart_dock_get, _aui.DockUIPart_dock_set)
    pane = property(_aui.DockUIPart_pane_get, _aui.DockUIPart_pane_set)
    button = property(_aui.DockUIPart_button_get, _aui.DockUIPart_button_set)
    cont_sizer = property(_aui.DockUIPart_cont_sizer_get, _aui.DockUIPart_cont_sizer_set)
    sizer_item = property(_aui.DockUIPart_sizer_item_get, _aui.DockUIPart_sizer_item_set)
    rect = property(_aui.DockUIPart_rect_get, _aui.DockUIPart_rect_set)
_aui.DockUIPart_swigregister(DockUIPart)

class PaneButton(object):
    """Proxy of C++ PaneButton class"""
    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    def __init__(self): raise AttributeError, "No constructor defined"
    __repr__ = _swig_repr
    button_id = property(_aui.PaneButton_button_id_get, _aui.PaneButton_button_id_set)
_aui.PaneButton_swigregister(PaneButton)

wxEVT_AUI_PANEBUTTON = _aui.wxEVT_AUI_PANEBUTTON
wxEVT_AUI_PANECLOSE = _aui.wxEVT_AUI_PANECLOSE
wxEVT_AUI_RENDER = _aui.wxEVT_AUI_RENDER
EVT_AUI_PANEBUTTON = wx.PyEventBinder( wxEVT_AUI_PANEBUTTON )
EVT_AUI_PANECLOSE = wx.PyEventBinder( wxEVT_AUI_PANECLOSE )
EVT_AUI_RENDER = wx.PyEventBinder( wxEVT_AUI_RENDER )

class DockArt(object):
    """
    DockArt is an art provider class which does all of the drawing for
    `FrameManager`.  This allows the library caller to customize or replace the
    dock art and drawing routines by deriving a new class from `PyDockArt`. The
    active dock art class can be set via `FrameManager.SetArtProvider`.

    """
    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    def __init__(self): raise AttributeError, "No constructor defined"
    __repr__ = _swig_repr
    __swig_destroy__ = _aui.delete_DockArt
    __del__ = lambda self : None;
    def GetMetric(*args, **kwargs):
        """GetMetric(self, int id) -> int"""
        return _aui.DockArt_GetMetric(*args, **kwargs)

    def SetMetric(*args, **kwargs):
        """SetMetric(self, int id, int new_val)"""
        return _aui.DockArt_SetMetric(*args, **kwargs)

    def SetFont(*args, **kwargs):
        """SetFont(self, int id, Font font)"""
        return _aui.DockArt_SetFont(*args, **kwargs)

    def GetFont(*args, **kwargs):
        """GetFont(self, int id) -> Font"""
        return _aui.DockArt_GetFont(*args, **kwargs)

    def GetColour(*args, **kwargs):
        """GetColour(self, int id) -> Colour"""
        return _aui.DockArt_GetColour(*args, **kwargs)

    def SetColour(*args, **kwargs):
        """SetColour(self, int id, wxColor colour)"""
        return _aui.DockArt_SetColour(*args, **kwargs)

    def GetColor(*args, **kwargs):
        """GetColor(self, int id) -> Colour"""
        return _aui.DockArt_GetColor(*args, **kwargs)

    def SetColor(*args, **kwargs):
        """SetColor(self, int id, Colour color)"""
        return _aui.DockArt_SetColor(*args, **kwargs)

    def DrawSash(*args, **kwargs):
        """DrawSash(self, DC dc, int orientation, Rect rect)"""
        return _aui.DockArt_DrawSash(*args, **kwargs)

    def DrawBackground(*args, **kwargs):
        """DrawBackground(self, DC dc, int orientation, Rect rect)"""
        return _aui.DockArt_DrawBackground(*args, **kwargs)

    def DrawCaption(*args, **kwargs):
        """DrawCaption(self, DC dc, String text, Rect rect, PaneInfo pane)"""
        return _aui.DockArt_DrawCaption(*args, **kwargs)

    def DrawGripper(*args, **kwargs):
        """DrawGripper(self, DC dc, Rect rect, PaneInfo pane)"""
        return _aui.DockArt_DrawGripper(*args, **kwargs)

    def DrawBorder(*args, **kwargs):
        """DrawBorder(self, DC dc, Rect rect, PaneInfo pane)"""
        return _aui.DockArt_DrawBorder(*args, **kwargs)

    def DrawPaneButton(*args, **kwargs):
        """DrawPaneButton(self, DC dc, int button, int button_state, Rect rect, PaneInfo pane)"""
        return _aui.DockArt_DrawPaneButton(*args, **kwargs)

_aui.DockArt_swigregister(DockArt)

class DefaultDockArt(DockArt):
    """
    DefaultDockArt is the type of art class constructed by default for the
    `FrameManager`.
    """
    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) -> DefaultDockArt

        DefaultDockArt is the type of art class constructed by default for the
        `FrameManager`.
        """
        _aui.DefaultDockArt_swiginit(self,_aui.new_DefaultDockArt(*args, **kwargs))
_aui.DefaultDockArt_swigregister(DefaultDockArt)

class FloatingPane(_windows.MiniFrame):
    """Proxy of C++ FloatingPane class"""
    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 parent, FrameManager owner_mgr, PaneInfo pane, 
            int id=ID_ANY) -> FloatingPane
        """
        _aui.FloatingPane_swiginit(self,_aui.new_FloatingPane(*args, **kwargs))
    __swig_destroy__ = _aui.delete_FloatingPane
    __del__ = lambda self : None;
    def SetPaneWindow(*args, **kwargs):
        """SetPaneWindow(self, PaneInfo pane)"""
        return _aui.FloatingPane_SetPaneWindow(*args, **kwargs)

_aui.FloatingPane_swigregister(FloatingPane)

class PyDockArt(DefaultDockArt):
    """
    This version of the `DockArt` class has been instrumented to be
    subclassable in Python and to reflect all calls to the C++ base class
    methods to the Python methods implemented in the derived class.
    """
    thisown = property(lambda x: x.this.own(), lambda x, v: x.this.own(v), doc='The membership flag')
    def __init__(self): raise AttributeError, "No constructor defined"
    __repr__ = _swig_repr
_aui.PyDockArt_swigregister(PyDockArt)