Package wx :: Package lib :: Module foldpanelbar :: Class CaptionBarStyle

[frames | no frames]

## Class CaptionBarStyle

This class encapsulates the styles you wish to set for the `CaptionBar` (this is the part of the FoldPanel where the caption is displayed). It can either be applied at creation time be reapplied when styles need to be changed.

At construction time, all styles are set to their default transparency. This means none of the styles will be applied to the `CaptionBar` in question, meaning it will be created using the default internals. When setting i.e the color, font or panel style, these styles become active to be used.

Method Summary
| ``__init__`(self)` Default constructor for this class.
| ``CaptionColourUsed`(self)` Checks if the caption colour of the caption bar is set.
| ``CaptionFontUsed`(self)` Checks if the caption bar font is set.
| ``CaptionStyleUsed`(self)` Checks if the caption style of the caption bar is set.
| ``FirstColourUsed`(self)` Checks if the first colour of the caption bar is set.
| ``GetCaptionColour`(self)` Returns the caption colour for the caption bar.
| ``GetCaptionFont`(self)` Returns the font for the caption bar.
| ``GetCaptionStyle`(self)` Returns the caption style for the caption bar.
| ``GetFirstColour`(self)` Returns the first colour for the caption bar.
| ``GetSecondColour`(self)` Returns the second colour for the caption bar.
| ``ResetDefaults`(self)` Resets default CaptionBarStyle.
| ``SecondColourUsed`(self)` Checks if the second colour of the caption bar is set.
| ``SetCaptionColour`(self, colour)` Sets caption colour for the caption bar.
| ``SetCaptionFont`(self, font)` Sets font for the caption bar.
| ``SetCaptionStyle`(self, style)` Sets caption style for the caption bar.
| ``SetFirstColour`(self, colour)` Sets first colour for the caption bar.
| ``SetSecondColour`(self, colour)` Sets second colour for the caption bar.

Method Details

### __init__(self)
(Constructor)

Default constructor for this class.

### CaptionColourUsed(self)

Checks if the caption colour of the caption bar is set.

### CaptionFontUsed(self)

Checks if the caption bar font is set.

### CaptionStyleUsed(self)

Checks if the caption style of the caption bar is set.

### FirstColourUsed(self)

Checks if the first colour of the caption bar is set.

### GetCaptionColour(self)

Returns the caption colour for the caption bar.

Please be warned this will result in an assertion failure when this property is not previously set. See also SetCaptionColour(), CaptionColourUsed()

### GetCaptionFont(self)

Returns the font for the caption bar.

Please be warned this will result in an assertion failure when this property is not previously set.

  See Also:

  `SetCaptionFont`, `CaptionFontUsed`

### GetCaptionStyle(self)

Returns the caption style for the caption bar.

Please be warned this will result in an assertion failure when this property is not previously set.

  See Also:

  `SetCaptionStyle`, `CaptionStyleUsed`

### GetFirstColour(self)

Returns the first colour for the caption bar.

Please be warned this will result in an assertion failure when this property is not previously set.

  See Also:

  `SetFirstColour`, `FirstColourUsed`

### GetSecondColour(self)

Returns the second colour for the caption bar.

Please be warned this will result in an assertion failure when this property is not previously set.

  See Also:

  `SetSecondColour`, `SecondColourUsed`

### ResetDefaults(self)

Resets default CaptionBarStyle.

### SecondColourUsed(self)

Checks if the second colour of the caption bar is set.

### SetCaptionColour(self, colour)

Sets caption colour for the caption bar.

If this is not set, the colour property is undefined and will not be used. Use `CaptionColourUsed` to check if this style is used.

### SetCaptionFont(self, font)

Sets font for the caption bar.

If this is not set, the font property is undefined and will not be used. Use `CaptionFontUsed` to check if this style is used.

### SetCaptionStyle(self, style)

Sets caption style for the caption bar.

If this is not set, the property is undefined and will not be used. Use CaptionStyleUsed() to check if this style is used. The following styles can be applied:

> - CAPTIONBAR_GRADIENT_V: Draws a vertical gradient from top to bottom
> - CAPTIONBAR_GRADIENT_H: Draws a horizontal gradient from left to right
> - CAPTIONBAR_SINGLE: Draws a single filled rectangle to draw the caption
> - CAPTIONBAR_RECTANGLE: Draws a single colour with a rectangle around the caption
> - CAPTIONBAR_FILLED_RECTANGLE: Draws a filled rectangle and a border around it

### SetFirstColour(self, colour)

Sets first colour for the caption bar.

If this is not set, the colour property is undefined and will not be used. Use `FirstColourUsed` to check if this style is used.

### SetSecondColour(self, colour)

Sets second colour for the caption bar.

If this is not set, the colour property is undefined and will not be used. Use `SecondColourUsed` to check if this style is used.

Generated by Epydoc 2.1.20050511.rpd on Thu Mar 22 12:09:46 2007 | http://epydoc.sf.net