Module FoldPanelBar :: Class FoldPanelBar
[show private | hide private]
[frames | no frames]

Type FoldPanelBar

object --+                
         |                
    Object --+            
             |            
    EvtHandler --+        
                 |        
            Window --+    
                     |    
                 Panel --+
                         |
                        FoldPanelBar


Method Summary
  __init__(self, parent, id, pos, size, style, extraStyle)
Default Class Constructor.
  AddFoldPanel(self, caption, collapsed, foldIcons, cbstyle)
Adds a fold panel to the list of panels.
  AddFoldPanelSeparator(self, panel, colour, Spacing, leftSpacing, rightSpacing)
Adds a separator line to the current FoldPanel.
  AddFoldPanelWindow(self, panel, window, flags, Spacing, leftSpacing, rightSpacing)
Adds a wxWindow derived class to the referenced FoldPanel.
  ApplyCaptionStyle(self, foldpanel, cbstyle)
Sets the style of the caption bar (called CaptionBar) of the FoldPanel.
  ApplyCaptionStyleAll(self, cbstyle)
Sets the style of all the caption bars of the FoldPanel.
  Collapse(self, foldpanel)
Collapses the given FoldPanel reference, and updates the foldpanel bar.
  Expand(self, foldpanel)
Expands the given FoldPanel reference, and updates the foldpanel bar.
  GetCaptionStyle(self, foldpanel)
Returns the currently used caption style for the FoldPanel.
  GetCount(self)
Returns the number of panels in the FoldPanelBar.
  GetFoldPanel(self, item)
Returns the panel associated with the index "item".
  GetPanelsLength(self, collapsed, expanded)
Returns the length of the panels that are expanded and collapsed.
  IsVertical(self)
Returns wether the CaptionBar Has Default Orientation Or Not.
  OnPressCaption(self, event)
Handles the EVT_CAPTIONBAR event in the FoldPanelBar.
  OnSizePanel(self, event)
Handles the EVT_SIZE method for the FoldPanelBar.
  RedisplayFoldPanelItems(self)
Resizes the fold panels so they match the width.
  RefreshPanelsFrom(self, item)
Refreshes all the panels from given index down to last one.
  RepositionCollapsedToBottom(self)
Repositions all the collapsed panels to the bottom.
    Inherited from Panel
  __repr__(self)
  Create(*args, **kwargs)
Create(self, Window parent, int id=-1, Point pos=DefaultPosition, Size size=DefaultSize, long style=wxTAB_TRAVERSAL|wxNO_BORDER, String name=PanelNameStr) -> bool Create the GUI part of the Window for 2-phase creation mode.
  GetClassDefaultAttributes(*args, **kwargs)
GetClassDefaultAttributes(int variant=WINDOW_VARIANT_NORMAL) -> VisualAttributes (Static method)
  InitDialog(*args, **kwargs)
InitDialog(self)
  SetFocus(*args, **kwargs)
SetFocus(self)
  SetFocusIgnoringChildren(*args, **kwargs)
SetFocusIgnoringChildren(self)
    Inherited from Window
  AcceptsFocus(*args, **kwargs)
AcceptsFocus(self) -> bool
  AcceptsFocusFromKeyboard(*args, **kwargs)
AcceptsFocusFromKeyboard(self) -> bool
  AddChild(*args, **kwargs)
AddChild(self, Window child)
  AssociateHandle(*args, **kwargs)
AssociateHandle(self, long handle)
  CaptureMouse(*args, **kwargs)
CaptureMouse(self)
  Center(*args, **kwargs)
Center(self, int direction=BOTH)
  CenterOnParent(*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
  CenterOnScreen(*args, **kwargs)
CenterOnScreen(self, int dir=BOTH)
  Centre(*args, **kwargs)
Center(self, int direction=BOTH)
  CentreOnParent(*args, **kwargs)
CenterOnParent(self, int dir=BOTH)
  CentreOnScreen(*args, **kwargs)
CenterOnScreen(self, int dir=BOTH)
  ClearBackground(*args, **kwargs)
ClearBackground(self)
  ClientToScreen(*args, **kwargs)
ClientToScreen(self, Point pt) -> Point
  ClientToScreenXY(*args, **kwargs)
ClientToScreenXY(int x, int y) -> (x,y)
  Close(*args, **kwargs)
Close(self, bool force=False) -> bool
  ConvertDialogPointToPixels(*args, **kwargs)
ConvertDialogPointToPixels(self, Point pt) -> Point
  ConvertDialogSizeToPixels(*args, **kwargs)
ConvertDialogSizeToPixels(self, Size sz) -> Size
  ConvertPixelPointToDialog(*args, **kwargs)
ConvertPixelPointToDialog(self, Point pt) -> Point
  ConvertPixelSizeToDialog(*args, **kwargs)
ConvertPixelSizeToDialog(self, Size sz) -> Size
  Destroy(*args, **kwargs)
Destroy(self) -> bool
  DestroyChildren(*args, **kwargs)
DestroyChildren(self) -> bool
  Disable(*args, **kwargs)
Disable(self) -> bool
  DissociateHandle(*args, **kwargs)
DissociateHandle(self)
  DLG_PNT(*args, **kwargs)
DLG_PNT(self, Point pt) -> Point
  DLG_SZE(*args, **kwargs)
DLG_SZE(self, Size sz) -> Size
  DragAcceptFiles(*args, **kwargs)
DragAcceptFiles(self, bool accept)
  Enable(*args, **kwargs)
Enable(self, bool enable=True) -> bool
  FindFocus(*args, **kwargs)
FindFocus() -> Window (Static method)
  FindWindowById(*args, **kwargs)
FindWindowById(self, long winid) -> Window
  FindWindowByName(*args, **kwargs)
FindWindowByName(self, String name) -> Window
  Fit(*args, **kwargs)
Fit(self)
  FitInside(*args, **kwargs)
FitInside(self)
  Freeze(*args, **kwargs)
Freeze(self)
  GetAcceleratorTable(*args, **kwargs)
GetAcceleratorTable(self) -> AcceleratorTable
  GetAdjustedBestSize(*args, **kwargs)
GetAdjustedBestSize(self) -> Size
  GetAutoLayout(*args, **kwargs)
GetAutoLayout(self) -> bool
  GetBackgroundColour(*args, **kwargs)
GetBackgroundColour(self) -> Colour
  GetBackgroundStyle(*args, **kwargs)
GetBackgroundStyle(self) -> int
  GetBestFittingSize(*args, **kwargs)
GetBestFittingSize(self) -> Size
  GetBestSize(*args, **kwargs)
GetBestSize(self) -> Size
  GetBestSizeTuple(*args, **kwargs)
GetBestSizeTuple() -> (width, height)
  GetBestVirtualSize(*args, **kwargs)
GetBestVirtualSize(self) -> Size
  GetBorder(*args)
GetBorder(self, long flags) -> int GetBorder(self) -> int
  GetCapture(*args, **kwargs)
GetCapture() -> Window (Static method)
  GetCaret(*args, **kwargs)
GetCaret(self) -> Caret
  GetCharHeight(*args, **kwargs)
GetCharHeight(self) -> int
  GetCharWidth(*args, **kwargs)
GetCharWidth(self) -> int
  GetChildren(*args, **kwargs)
GetChildren(self) -> PyObject
  GetClientAreaOrigin(*args, **kwargs)
GetClientAreaOrigin(self) -> Point
  GetClientRect(*args, **kwargs)
GetClientRect(self) -> Rect
  GetClientSize(*args, **kwargs)
GetClientSize(self) -> Size
  GetClientSizeTuple(*args, **kwargs)
GetClientSizeTuple() -> (width, height)
  GetConstraints(*args, **kwargs)
GetConstraints(self) -> LayoutConstraints
  GetContainingSizer(*args, **kwargs)
GetContainingSizer(self) -> Sizer
  GetCursor(*args, **kwargs)
GetCursor(self) -> Cursor
  GetDefaultAttributes(*args, **kwargs)
GetDefaultAttributes(self) -> VisualAttributes
  GetDefaultItem(*args, **kwargs)
GetDefaultItem(self) -> Window
  GetDropTarget(*args, **kwargs)
GetDropTarget(self) -> DropTarget
  GetEventHandler(*args, **kwargs)
GetEventHandler(self) -> EvtHandler
  GetExtraStyle(*args, **kwargs)
GetExtraStyle(self) -> long
  GetFont(*args, **kwargs)
GetFont(self) -> Font
  GetForegroundColour(*args, **kwargs)
GetForegroundColour(self) -> Colour
  GetFullTextExtent(*args, **kwargs)
GetFullTextExtent(String string, Font font=None) -> (width, height, descent, externalLeading) Get the width, height, decent and leading of the text using the current or specified font.
  GetGrandParent(*args, **kwargs)
GetGrandParent(self) -> Window
  GetHandle(*args, **kwargs)
GetHandle(self) -> long
  GetHelpText(*args, **kwargs)
GetHelpText(self) -> String
  GetId(*args, **kwargs)
GetId(self) -> int
  GetLabel(*args, **kwargs)
GetLabel(self) -> String
  GetMaxHeight(*args, **kwargs)
GetMaxHeight(self) -> int
  GetMaxSize(*args, **kwargs)
GetMaxSize(self) -> Size
  GetMaxWidth(*args, **kwargs)
GetMaxWidth(self) -> int
  GetMinHeight(*args, **kwargs)
GetMinHeight(self) -> int
  GetMinSize(*args, **kwargs)
GetMinSize(self) -> Size
  GetMinWidth(*args, **kwargs)
GetMinWidth(self) -> int
  GetName(*args, **kwargs)
GetName(self) -> String
  GetParent(*args, **kwargs)
GetParent(self) -> Window
  GetPosition(*args, **kwargs)
GetPosition(self) -> Point
  GetPositionTuple(*args, **kwargs)
GetPositionTuple() -> (x,y)
  GetRect(*args, **kwargs)
GetRect(self) -> Rect
  GetScrollPos(*args, **kwargs)
GetScrollPos(self, int orientation) -> int
  GetScrollRange(*args, **kwargs)
GetScrollRange(self, int orientation) -> int
  GetScrollThumb(*args, **kwargs)
GetScrollThumb(self, int orientation) -> int
  GetSize(*args, **kwargs)
GetSize(self) -> Size
  GetSizer(*args, **kwargs)
GetSizer(self) -> Sizer
  GetSizeTuple(*args, **kwargs)
GetSizeTuple() -> (width, height)
  GetTextExtent(*args, **kwargs)
GetTextExtent(String string) -> (width, height)
  GetThemeEnabled(*args, **kwargs)
GetThemeEnabled(self) -> bool
  GetTitle(*args, **kwargs)
GetTitle(self) -> String
  GetToolTip(*args, **kwargs)
GetToolTip(self) -> ToolTip
  GetUpdateClientRect(*args, **kwargs)
GetUpdateClientRect(self) -> Rect
  GetUpdateRegion(*args, **kwargs)
GetUpdateRegion(self) -> Region
  GetValidator(*args, **kwargs)
GetValidator(self) -> Validator
  GetVirtualSize(*args, **kwargs)
GetVirtualSize(self) -> Size
  GetVirtualSizeTuple(*args, **kwargs)
GetVirtualSizeTuple() -> (width, height)
  GetWindowStyle(*args, **kwargs)
GetWindowStyleFlag(self) -> long
  GetWindowStyleFlag(*args, **kwargs)
GetWindowStyleFlag(self) -> long
  GetWindowVariant(*args, **kwargs)
GetWindowVariant(self) -> int
  HasCapture(*args, **kwargs)
HasCapture(self) -> bool
  HasFlag(*args, **kwargs)
HasFlag(self, int flag) -> bool
  HasScrollbar(*args, **kwargs)
HasScrollbar(self, int orient) -> bool
  HasTransparentBackground(*args, **kwargs)
HasTransparentBackground(self) -> bool
  Hide(*args, **kwargs)
Hide(self) -> bool
  HitTest(*args, **kwargs)
HitTest(self, Point pt) -> int
  HitTestXY(*args, **kwargs)
HitTestXY(self, int x, int y) -> int
  InheritAttributes(*args, **kwargs)
InheritAttributes(self)
  InheritsBackgroundColour(*args, **kwargs)
InheritsBackgroundColour(self) -> bool
  InvalidateBestSize(*args, **kwargs)
InvalidateBestSize(self)
  IsBeingDeleted(*args, **kwargs)
IsBeingDeleted(self) -> bool
  IsEnabled(*args, **kwargs)
IsEnabled(self) -> bool
  IsExposed(*args, **kwargs)
IsExposed(self, int x, int y, int w=1, int h=1) -> bool
  IsExposedPoint(*args, **kwargs)
IsExposedPoint(self, Point pt) -> bool
  IsExposedRect(*args, **kwargs)
IsExposedRect(self, Rect rect) -> bool
  IsRetained(*args, **kwargs)
IsRetained(self) -> bool
  IsShown(*args, **kwargs)
IsShown(self) -> bool
  IsTopLevel(*args, **kwargs)
IsTopLevel(self) -> bool
  Layout(*args, **kwargs)
Layout(self) -> bool
  LineDown(*args, **kwargs)
LineDown(self) -> bool
  LineUp(*args, **kwargs)
LineUp(self) -> bool
  Lower(*args, **kwargs)
Lower(self)
  MakeModal(*args, **kwargs)
MakeModal(self, bool modal=True)
  Move(*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
  MoveAfterInTabOrder(*args, **kwargs)
MoveAfterInTabOrder(self, Window win)
  MoveBeforeInTabOrder(*args, **kwargs)
MoveBeforeInTabOrder(self, Window win)
  MoveXY(*args, **kwargs)
MoveXY(self, int x, int y, int flags=SIZE_USE_EXISTING)
  Navigate(*args, **kwargs)
Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool
  NewControlId(*args, **kwargs)
NewControlId() -> int (Static method)
  NextControlId(*args, **kwargs)
NextControlId(int winid) -> int (Static method)
  OnPaint(*args, **kwargs)
OnPaint(self, PaintEvent event)
  PageDown(*args, **kwargs)
PageDown(self) -> bool
  PageUp(*args, **kwargs)
PageUp(self) -> bool
  PopEventHandler(*args, **kwargs)
PopEventHandler(self, bool deleteHandler=False) -> EvtHandler
  PopupMenu(*args, **kwargs)
PopupMenu(self, Menu menu, Point pos=DefaultPosition) -> bool
  PopupMenuXY(*args, **kwargs)
PopupMenuXY(self, Menu menu, int x=-1, int y=-1) -> bool
  PostCreate(self, pre)
Phase 3 of the 2-phase create <wink!> Call this method after precreating the window with the 2-phase create method.
  PrepareDC(*args, **kwargs)
PrepareDC(self, DC dc)
  PrevControlId(*args, **kwargs)
PrevControlId(int winid) -> int (Static method)
  PushEventHandler(*args, **kwargs)
PushEventHandler(self, EvtHandler handler)
  Raise(*args, **kwargs)
Raise(self)
  Refresh(*args, **kwargs)
Refresh(self, bool eraseBackground=True, Rect rect=None)
  RefreshRect(*args, **kwargs)
RefreshRect(self, Rect rect, bool eraseBackground=True)
  RegisterHotKey(*args, **kwargs)
RegisterHotKey(self, int hotkeyId, int modifiers, int keycode) -> bool
  ReleaseMouse(*args, **kwargs)
ReleaseMouse(self)
  RemoveChild(*args, **kwargs)
RemoveChild(self, Window child)
  RemoveEventHandler(*args, **kwargs)
RemoveEventHandler(self, EvtHandler handler) -> bool
  Reparent(*args, **kwargs)
Reparent(self, Window newParent) -> bool
  ScreenToClient(*args, **kwargs)
ScreenToClient(self, Point pt) -> Point
  ScreenToClientXY(*args, **kwargs)
ScreenToClientXY(int x, int y) -> (x,y)
  ScrollLines(*args, **kwargs)
ScrollLines(self, int lines) -> bool
  ScrollPages(*args, **kwargs)
ScrollPages(self, int pages) -> bool
  ScrollWindow(*args, **kwargs)
ScrollWindow(self, int dx, int dy, Rect rect=None)
  SetAcceleratorTable(*args, **kwargs)
SetAcceleratorTable(self, AcceleratorTable accel)
  SetAutoLayout(*args, **kwargs)
SetAutoLayout(self, bool autoLayout)
  SetBackgroundColour(*args, **kwargs)
SetBackgroundColour(self, Colour colour) -> bool
  SetBackgroundStyle(*args, **kwargs)
SetBackgroundStyle(self, int style) -> bool Returns the background style of the window.
  SetBestFittingSize(*args, **kwargs)
SetBestFittingSize(self, Size size=DefaultSize)
  SetCaret(*args, **kwargs)
SetCaret(self, Caret caret)
  SetClientRect(*args, **kwargs)
SetClientRect(self, Rect rect)
  SetClientSize(*args, **kwargs)
SetClientSize(self, Size size)
  SetClientSizeWH(*args, **kwargs)
SetClientSizeWH(self, int width, int height)
  SetConstraints(*args, **kwargs)
SetConstraints(self, LayoutConstraints constraints)
  SetContainingSizer(*args, **kwargs)
SetContainingSizer(self, Sizer sizer)
  SetCursor(*args, **kwargs)
SetCursor(self, Cursor cursor) -> bool
  SetDefaultItem(*args, **kwargs)
SetDefaultItem(self, Window child) -> Window
  SetDimensions(*args, **kwargs)
SetDimensions(self, int x, int y, int width, int height, int sizeFlags=SIZE_AUTO) Sets the position and size of the window in pixels.
  SetDropTarget(*args, **kwargs)
SetDropTarget(self, DropTarget dropTarget)
  SetEventHandler(*args, **kwargs)
SetEventHandler(self, EvtHandler handler)
  SetExtraStyle(*args, **kwargs)
SetExtraStyle(self, long exStyle)
  SetFocusFromKbd(*args, **kwargs)
SetFocusFromKbd(self)
  SetFont(*args, **kwargs)
SetFont(self, Font font) -> bool
  SetForegroundColour(*args, **kwargs)
SetForegroundColour(self, Colour colour) -> bool
  SetHelpText(*args, **kwargs)
SetHelpText(self, String text)
  SetHelpTextForId(*args, **kwargs)
SetHelpTextForId(self, String text)
  SetId(*args, **kwargs)
SetId(self, int winid)
  SetLabel(*args, **kwargs)
SetLabel(self, String label)
  SetMaxSize(*args, **kwargs)
SetMaxSize(self, Size maxSize)
  SetMinSize(*args, **kwargs)
SetMinSize(self, Size minSize)
  SetName(*args, **kwargs)
SetName(self, String name)
  SetOwnBackgroundColour(*args, **kwargs)
SetOwnBackgroundColour(self, Colour colour)
  SetOwnFont(*args, **kwargs)
SetOwnFont(self, Font font)
  SetOwnForegroundColour(*args, **kwargs)
SetOwnForegroundColour(self, Colour colour)
  SetPosition(*args, **kwargs)
Move(self, Point pt, int flags=SIZE_USE_EXISTING)
  SetRect(*args, **kwargs)
SetRect(self, Rect rect, int sizeFlags=SIZE_AUTO)
  SetScrollbar(*args, **kwargs)
SetScrollbar(self, int orientation, int position, int thumbSize, int range, bool refresh=True) Sets the scrollbar properties of a built-in scrollbar.
  SetScrollPos(*args, **kwargs)
SetScrollPos(self, int orientation, int pos, bool refresh=True)
  SetSize(*args, **kwargs)
SetSize(self, Size size)
  SetSizeHints(*args, **kwargs)
SetSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1, int incW=-1, int incH=-1) Allows specification of minimum and maximum window sizes, and window size increments.
  SetSizeHintsSz(*args, **kwargs)
SetSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize, Size incSize=DefaultSize)
  SetSizer(*args, **kwargs)
SetSizer(self, Sizer sizer, bool deleteOld=True)
  SetSizerAndFit(*args, **kwargs)
SetSizerAndFit(self, Sizer sizer, bool deleteOld=True)
  SetSizeWH(*args, **kwargs)
SetSizeWH(self, int width, int height)
  SetThemeEnabled(*args, **kwargs)
SetThemeEnabled(self, bool enableTheme) This function tells a window if it should use the system's "theme" code to draw the windows' background instead if its own background drawing code.
  SetTitle(*args, **kwargs)
SetTitle(self, String title)
  SetTmpDefaultItem(*args, **kwargs)
SetTmpDefaultItem(self, Window win)
  SetToolTip(*args, **kwargs)
SetToolTip(self, ToolTip tip)
  SetToolTipString(*args, **kwargs)
SetToolTipString(self, String tip)
  SetValidator(*args, **kwargs)
SetValidator(self, Validator validator)
  SetVirtualSize(*args, **kwargs)
SetVirtualSize(self, Size size)
  SetVirtualSizeHints(*args, **kwargs)
SetVirtualSizeHints(self, int minW, int minH, int maxW=-1, int maxH=-1)
  SetVirtualSizeHintsSz(*args, **kwargs)
SetVirtualSizeHintsSz(self, Size minSize, Size maxSize=DefaultSize)
  SetVirtualSizeWH(*args, **kwargs)
SetVirtualSizeWH(self, int w, int h)
  SetWindowStyle(*args, **kwargs)
SetWindowStyleFlag(self, long style)
  SetWindowStyleFlag(*args, **kwargs)
SetWindowStyleFlag(self, long style)
  SetWindowVariant(*args, **kwargs)
SetWindowVariant(self, int variant)
  ShouldInheritColours(*args, **kwargs)
ShouldInheritColours(self) -> bool
  Show(*args, **kwargs)
Show(self, bool show=True) -> bool
  Thaw(*args, **kwargs)
Thaw(self)
  TransferDataFromWindow(*args, **kwargs)
TransferDataFromWindow(self) -> bool
  TransferDataToWindow(*args, **kwargs)
TransferDataToWindow(self) -> bool
  UnregisterHotKey(*args, **kwargs)
UnregisterHotKey(self, int hotkeyId) -> bool
  Update(*args, **kwargs)
Update(self)
  UpdateWindowUI(*args, **kwargs)
UpdateWindowUI(self, long flags=UPDATE_UI_NONE)
  UseBgCol(*args, **kwargs)
UseBgCol(self) -> bool
  Validate(*args, **kwargs)
Validate(self) -> bool
  WarpPointer(*args, **kwargs)
WarpPointer(self, int x, int y)
    Inherited from EvtHandler
  _setOORInfo(*args, **kwargs)
_setOORInfo(self, PyObject _self, bool incref=True)
  AddPendingEvent(*args, **kwargs)
AddPendingEvent(self, Event event)
  Bind(self, event, handler, source, id, id2)
Bind an event to an event handler.
  Connect(*args, **kwargs)
Connect(self, int id, int lastId, int eventType, PyObject func)
  Disconnect(*args, **kwargs)
Disconnect(self, int id, int lastId=-1, wxEventType eventType=wxEVT_NULL) -> bool
  GetEvtHandlerEnabled(*args, **kwargs)
GetEvtHandlerEnabled(self) -> bool
  GetNextHandler(*args, **kwargs)
GetNextHandler(self) -> EvtHandler
  GetPreviousHandler(*args, **kwargs)
GetPreviousHandler(self) -> EvtHandler
  ProcessEvent(*args, **kwargs)
ProcessEvent(self, Event event) -> bool
  ProcessPendingEvents(*args, **kwargs)
ProcessPendingEvents(self)
  SetEvtHandlerEnabled(*args, **kwargs)
SetEvtHandlerEnabled(self, bool enabled)
  SetNextHandler(*args, **kwargs)
SetNextHandler(self, EvtHandler handler)
  SetPreviousHandler(*args, **kwargs)
SetPreviousHandler(self, EvtHandler handler)
  Unbind(self, event, source, id, id2)
Disconencts the event handler binding for event from self.
    Inherited from Object
  GetClassName(*args, **kwargs)
GetClassName(self) -> String
    Inherited from object
  __delattr__(...)
x.__delattr__('name') <==> del x.name
  __getattribute__(...)
x.__getattribute__('name') <==> x.name
  __hash__(x)
x.__hash__() <==> hash(x)
  __new__(T, S, ...)
T.__new__(S, ...) -> a new object with type S, a subtype of T
  __reduce__(...)
helper for pickle
  __reduce_ex__(...)
helper for pickle
  __setattr__(...)
x.__setattr__('name', value) <==> x.name = value
  __str__(x)
x.__str__() <==> str(x)

Class Variable Summary
CaptionBarStyle EmptyCaptionBarStyle = <FoldPanelBar.CaptionBarStyle ins...

Instance Method Details

__init__(self, parent, id=-1, pos=wx.Point(-1, -1), size=wx.Size(-1, -1), style=2621440, extraStyle=0)
(Constructor)

Default Class Constructor.
Overrides:
wx._windows.Panel.__init__

AddFoldPanel(self, caption='', collapsed=False, foldIcons=<wx._gdi.ImageList; proxy of C++ wxImageList instance at ..., cbstyle=<FoldPanelBar.CaptionBarStyle instance at 0x009718F0>)

Adds a fold panel to the list of panels.

If the flag collapsed is set to True, the panel is collapsed initially. The FoldPanel item which is returned, can be used as a reference to perform actions upon the fold panel like collapsing it, expanding it, or deleting it from the list.

Use this foldpanel to add windows to it. Please consult FoldPanelBar.AddFoldPanelWindow() and wxFoldPanelBar.AddFoldPanelSeparator() how to add wxWindow items to the panels.

AddFoldPanelSeparator(self, panel, colour=wx.Colour(0, 0, 0), Spacing=8, leftSpacing=2, rightSpacing=2)

Adds a separator line to the current FoldPanel.

The seperator is a simple line which is drawn and is no real component. It can be used to separate groups of controls which belong to each other. The colour is adjustable, and it takes the same Spacing, leftSpacing and rightSpacing as AddFoldPanelWindow().

AddFoldPanelWindow(self, panel, window, flags=1, Spacing=8, leftSpacing=2, rightSpacing=2)

Adds a wxWindow derived class to the referenced FoldPanel.

IMPORTANT: Make the to be created window, child of the FoldPanel. See example that follows. The flags to be used are:
    - wxFPB_ALIGN_WIDTH: Which means the wxWindow to be added will be alligned to fit the width of the
      FoldPanel when it is resized. Very handy for sizer items, buttons and text boxes.
    - wxFPB_ALIGN_LEFT: Alligns left instead of fitting the width of the child window to be added. Use either
      this one or wxFPB_ALIGN_WIDTH.

The wxWindow to be added can be slightly indented from left and right so it is more visibly placed
in the FoldPanel. Use Spacing > 0 to give the control an y offset from the previous wxWindow added,
use leftSpacing to give it a slight indent from the left, and rightSpacing also reserves a little space
on the right so the wxWindow can be properly placed in the FoldPanel.

The following example adds a FoldPanel to the FoldPanelBar and adds two wxWindow derived controls
to the FoldPanel:

# CODE

    # create the FoldPanelBar
    >>> m_pnl = FoldPanelBar(self, wx.ID_ANY, wx.DefaultPosition, wx.DefaultSize, wxFPB_DEFAULT_STYLE, wxFPB_COLLAPSE_TO_BOTTOM)

    # add a foldpanel to the control. "Test me" is the caption and it is initially not collapsed.
    >>> item = m_pnl.AddFoldPanel("Test me", False)

    # now add a button to the fold panel. Mind that the button should be made child of the
    # FoldPanel and not of the main form.
    >>> m_pnl.AddFoldPanelWindow(item, wx.Button(item, ID_COLLAPSEME, "Collapse Me"))

    # add a separator between the two controls. This is purely a visual line that can have a certain
    # color and also the indents and width alligning like a control.
    >>> m_pnl.AddFoldPanelSeparator(item)

    # now add a text ctrl. Also very easy. Align this on width so that when the control gets wider
    # the text control also sizes along.
    >>> m_pnl.AddFoldPanelWindow(item, wx.TextCtrl(item, wx.ID_ANY, "Comment"), wxFPB_ALIGN_WIDTH, wxFPB_DEFAULT_SPACING, 20)

# ENDCODE

ApplyCaptionStyle(self, foldpanel, cbstyle)

Sets the style of the caption bar (called CaptionBar) of the FoldPanel.

The changes are applied immediately. All styles not set in the CaptionBarStyle class are not applied. Use the CaptionBar reference to indicate what captionbar you want to apply the style to. To apply one style to all CaptionBar items, use ApplyCaptionStyleAll()

ApplyCaptionStyleAll(self, cbstyle)

Sets the style of all the caption bars of the FoldPanel. The changes are applied immediately.

Collapse(self, foldpanel)

Collapses the given FoldPanel reference, and updates the foldpanel bar.

In the wxFPB_COLLAPSE_TO_BOTTOM style, all collapsed captions are put at the bottom of the control. In the normal mode, they stay where they are.

Expand(self, foldpanel)

Expands the given FoldPanel reference, and updates the foldpanel bar.

In the wxFPB_COLLAPSE_TO_BOTTOM style, they will be removed from the bottom and the order where the panel originally was placed is restored.

GetCaptionStyle(self, foldpanel)

Returns the currently used caption style for the FoldPanel.

It is returned as a CaptionBarStyle class. After modifying it, it can be set again.

GetCount(self)

Returns the number of panels in the FoldPanelBar.

GetFoldPanel(self, item)

Returns the panel associated with the index "item".

See the example at the bottom of the module, especially the events for the "Collapse Me" and "Expand Me" buttons.

GetPanelsLength(self, collapsed, expanded)

Returns the length of the panels that are expanded and collapsed.

This is useful to determine quickly what size is used to display, and what is left at the bottom (right) to align the collapsed panels.

IsVertical(self)

Returns wether the CaptionBar Has Default Orientation Or Not.

Default is vertical.

OnPressCaption(self, event)

Handles the EVT_CAPTIONBAR event in the FoldPanelBar.

OnSizePanel(self, event)

Handles the EVT_SIZE method for the FoldPanelBar.

RedisplayFoldPanelItems(self)

Resizes the fold panels so they match the width.

RefreshPanelsFrom(self, item)

Refreshes all the panels from given index down to last one.

RepositionCollapsedToBottom(self)

Repositions all the collapsed panels to the bottom.

When it is not possible to align them to the bottom, stick them behind the visible panels. The Rect holds the slack area left between last repositioned panel and the bottom panels. This needs to get a refresh.

Class Variable Details

EmptyCaptionBarStyle

Type:
CaptionBarStyle
Value:
<FoldPanelBar.CaptionBarStyle instance at 0x009718F0>                  

Generated by Epydoc 2.1 on Thu Mar 24 21:26:20 2005 http://epydoc.sf.net