# wx.lib.agw.foldpanelbar.CaptionBar¶

This class is a graphical caption component that consists of a caption and a clickable arrow.

The CaptionBar fires an event EVT_CAPTIONBAR which is a CaptionBarEvent. This event can be caught and the parent window can act upon the collapsed or expanded state of the bar (which is actually just the icon which changed). The parent panel can reduce size or expand again.

## Class Hierarchy¶

Inheritance diagram for class CaptionBar:

## Known Superclasses¶

wx.Window

## Methods Summary¶

 __init__ Default class constructor. ApplyCaptionStyle Applies the style defined in cbstyle to the CaptionBar. Collapse This sets the internal state/representation to collapsed. DoGetBestSize Returns the best size for this panel, based upon the font DrawHorizontalGradient Gradient fill from colour 1 to colour 2 from left to right. DrawSingleColour Single colour fill for CaptionBar. DrawSingleRectangle Single rectangle for CaptionBar. DrawVerticalGradient Gradient fill from colour 1 to colour 2 from top to bottom. Expand This sets the internal state/representation to expanded. FillCaptionBackground Fills the background of the caption with either a gradient or GetCaptionStyle Returns the current style of the captionbar in a CaptionBarStyle class. IsCollapsed Returns wether the status of the bar is expanded or collapsed. IsVertical Returns wether the CaptionBar has a default orientation or not. OnChar Handles the wx.EVT_CHAR event for CaptionBar. OnMouseEvent Handles the wx.EVT_MOUSE_EVENTS event for CaptionBar. OnPaint Handles the wx.EVT_PAINT event for CaptionBar. OnSize Handles the wx.EVT_SIZE event for CaptionBar. RedrawIconBitmap Redraws the icons (if they exists). SetBoldFont Sets the CaptionBar font weight to bold. SetCaptionStyle Sets CaptionBar styles with CaptionBarStyle class. SetNormalFont Sets the CaptionBar font weight to normal. SetRightIndent Sets the amount of pixels on the right from which the bitmap

## Class API¶

class CaptionBar(wx.Window)

This class is a graphical caption component that consists of a caption and a clickable arrow.

The CaptionBar fires an event EVT_CAPTIONBAR which is a CaptionBarEvent. This event can be caught and the parent window can act upon the collapsed or expanded state of the bar (which is actually just the icon which changed). The parent panel can reduce size or expand again.

### Methods¶

__init__(self, parent, id, pos, size, caption="", foldIcons=None, cbstyle=None, rightIndent=FPB_BMP_RIGHTSPACE, iconWidth=16, iconHeight=16, collapsed=False)

Default class constructor.

Parameters
• parent – the CaptionBar parent window;

• id – an identifier for the control: a value of -1 is taken to mean a default;

• pos – the control position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxPython, depending on platform;

• size – the control size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxPython, depending on platform;

• caption – the string to be displayed in CaptionBar;

• foldIcons – an instance of wx.ImageList containing the icons to display next to the caption text;

• cbstyle – the CaptionBar window style. Must be an instance of CaptionBarStyle;

• rightIndent – number of pixels of the bmp to be aligned from the right filled with space;

• iconWidth – the CaptionBar icon width;

• iconHeight – the CaptionBar icon height;

• collapsedTrue if the CaptionBar should start in the collapsed state, False otherwise.

ApplyCaptionStyle(self, cbstyle=None, applyDefault=True)

Applies the style defined in cbstyle to the CaptionBar.

Parameters

Collapse(self)

This sets the internal state/representation to collapsed.

Note

This does not trigger a CaptionBarEvent to be sent to the parent.

DoGetBestSize(self)

Returns the best size for this panel, based upon the font assigned to this window, and the caption string.

Note

Overridden from wx.Window.

DrawHorizontalGradient(self, dc, rect)

Gradient fill from colour 1 to colour 2 from left to right.

Parameters

DrawSingleColour(self, dc, rect)

Single colour fill for CaptionBar.

Parameters

DrawSingleRectangle(self, dc, rect)

Single rectangle for CaptionBar.

Parameters

DrawVerticalGradient(self, dc, rect)

Gradient fill from colour 1 to colour 2 from top to bottom.

Parameters

Expand(self)

This sets the internal state/representation to expanded.

Note

This does not trigger a CaptionBarEvent to be sent to the parent.

FillCaptionBackground(self, dc)

Fills the background of the caption with either a gradient or a solid colour.

Parameters

dc – an instance of wx.DC.

GetCaptionStyle(self)

Returns the current style of the captionbar in a CaptionBarStyle class.

Note

This can be used to change and set back the changes.

IsCollapsed(self)

Returns wether the status of the bar is expanded or collapsed.

IsVertical(self)

Returns wether the CaptionBar has a default orientation or not. Default is vertical.

OnChar(self, event)

Handles the wx.EVT_CHAR event for CaptionBar.

Parameters

event – a KeyEvent event to be processed.

Note

This method currently does nothing.

OnMouseEvent(self, event)

Handles the wx.EVT_MOUSE_EVENTS event for CaptionBar.

Parameters

event – a MouseEvent event to be processed.

Note

This method catches the mouse click-double click. If clicked on the arrow (single) or double on the caption we change state and an event must be fired to let this panel collapse or expand.

OnPaint(self, event)

Handles the wx.EVT_PAINT event for CaptionBar.

Parameters

event – a PaintEvent event to be processed.

OnSize(self, event)

Handles the wx.EVT_SIZE event for CaptionBar.

Parameters

event – a wx.SizeEvent event to be processed.

RedrawIconBitmap(self)

Redraws the icons (if they exists).

SetBoldFont(self)

Sets the CaptionBar font weight to bold.

SetCaptionStyle(self, cbstyle=None, applyDefault=True)

Sets CaptionBar styles with CaptionBarStyle class.

Parameters

Note

All styles that are actually set, are applied. If you set applyDefault to True, all other (not defined) styles will be set to default. If it is False, the styles which are not set in the CaptionBarStyle will be ignored.

SetNormalFont(self)

Sets the CaptionBar font weight to normal.

SetRightIndent(self, pixels)

Sets the amount of pixels on the right from which the bitmap is trailing.

Parameters

pixels – the number of pixels on the right from which the bitmap is trailing. If this is 0, it will be drawn all the way to the right, default is equal to FPB_BMP_RIGHTSPACE. Assign this before assigning an image list to prevent a redraw.