wx.ribbon.RibbonControl¶

wx.ribbon.RibbonControl serves as a base class for all controls which share the ribbon characteristics of having a ribbon art provider, and (optionally) non-continuous resizing.

Despite what the name may imply, it is not the top-level control for creating a ribbon interface - that is wx.ribbon.RibbonBar.

Ribbon controls often have a region which is “transparent”, and shows the contents of the ribbon page or panel behind it. If implementing a new ribbon control, then it may be useful to realise that this effect is done by the art provider when painting the background of the control, and hence in the paint handler for the new control, you should call a draw background method on the art provider ( wx.ribbon.RibbonArtProvider.DrawButtonBarBackground and wx.ribbon.RibbonArtProvider.DrawToolBarBackground typically just redraw what is behind the rectangle being painted) if you want transparent regions.

Class Hierarchy¶

Inheritance diagram for class RibbonControl:

Known Subclasses¶

wx.ribbon.RibbonBar, wx.ribbon.RibbonButtonBar, wx.ribbon.RibbonGallery, wx.ribbon.RibbonPage, wx.ribbon.RibbonPanel, wx.ribbon.RibbonToolBar

Methods Summary¶

`__init__`	Constructor.
`DoGetNextLargerSize`	Implementation of `GetNextLargerSize` .
`DoGetNextSmallerSize`	Implementation of `GetNextSmallerSize` .
`GetAncestorRibbonBar`	Get the first ancestor which is a wx.ribbon.RibbonBar (or derived) or `None` if not having such parent.
`GetArtProvider`	Get the art provider to be used.
`GetBestSizeForParentSize`	Finds the best width and height given the parent’s width and height.
`GetClassDefaultAttributes`
`GetNextLargerSize`	If sizing is not continuous, then return a suitable size for the control which is larger than the current size.
`GetNextSmallerSize`	If sizing is not continuous, then return a suitable size for the control which is smaller than the current size.
`IsSizingContinuous`
`Realise`	Alias for `Realize` .
`Realize`	Perform initial size and layout calculations after children have been added, and/or realize children.
`SetArtProvider`	Set the art provider to be used.

Properties Summary¶

`AncestorRibbonBar`	See `GetAncestorRibbonBar`
`ArtProvider`	See `GetArtProvider` and `SetArtProvider`

Class API¶

class wx.ribbon.RibbonControl(Control)¶

Possible constructors:

RibbonControl()

RibbonControl(parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize,
              style=0, validator=DefaultValidator, name=ControlNameStr)

RibbonControl serves as a base class for all controls which share the ribbon characteristics of having a ribbon art provider, and (optionally) non-continuous resizing.

Methods¶

__init__(self, *args, **kw)¶

Overloaded Implementations:

__init__ (self)

Constructor.

__init__ (self, parent, id=ID_ANY, pos=DefaultPosition, size=DefaultSize, style=0, validator=DefaultValidator, name=ControlNameStr)

Constructor.

If parent is a wx.ribbon.RibbonControl with a not None art provider, then the art provider of new control is set to that of parent.

Parameters

parent (wx.Window) –
id (wx.WindowID) –
pos (wx.Point) –
size (wx.Size) –
style (long) –
validator (wx.Validator) –
name (string) –

DoGetNextLargerSize(self, direction, relative_to)¶

Implementation of GetNextLargerSize .

Controls which have non-continuous sizing must override this virtual function rather than GetNextLargerSize .

Parameters

direction (Orientation) –
relative_to (wx.Size) –

Return type

Size

DoGetNextSmallerSize(self, direction, relative_to)¶

Implementation of GetNextSmallerSize .

Controls which have non-continuous sizing must override this virtual function rather than GetNextSmallerSize .

Parameters

direction (Orientation) –
relative_to (wx.Size) –

Return type

Size

GetAncestorRibbonBar(self)¶

Get the first ancestor which is a wx.ribbon.RibbonBar (or derived) or None if not having such parent.

Return type: wx.ribbon.RibbonBar

New in version 2.9.4.

GetArtProvider(self)¶

Get the art provider to be used.

Note that until an art provider has been set in some way, this function may return None.

Return type: wx.ribbon.RibbonArtProvider

GetBestSizeForParentSize(self, parentSize)¶

Finds the best width and height given the parent’s width and height.

Used to implement the wx.ribbon.RIBBON_PANEL_FLEXIBLE panel style.

Parameters: parentSize (wx.Size) –
Return type: Size

static GetClassDefaultAttributes(variant=WINDOW_VARIANT_NORMAL)¶

Parameters: variant (WindowVariant) –
Return type: VisualAttributes

GetNextLargerSize(self, *args, **kw)¶

Overloaded Implementations:

GetNextLargerSize (self, direction)

If sizing is not continuous, then return a suitable size for the control which is larger than the current size.

Parameters: direction (Orientation) – The direction(s) in which the size should increase.
Return type: Size
Returns: The current size if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as the current size in the other direction (if any).

See also

IsSizingContinuous

GetNextLargerSize (self, direction, relative_to)

If sizing is not continuous, then return a suitable size for the control which is larger than the given size.

Parameters

direction (Orientation) – The direction(s) in which the size should increase.
relative_to (wx.Size) – The size for which a larger size should be found.

Return type

Size

Returns

relative_to if there is no larger size, otherwise a suitable size which is larger in the given direction(s), and the same as relative_to in the other direction (if any).

See also

IsSizingContinuous

See also

DoGetNextLargerSize

GetNextSmallerSize(self, *args, **kw)¶

Overloaded Implementations:

GetNextSmallerSize (self, direction)

If sizing is not continuous, then return a suitable size for the control which is smaller than the current size.

Parameters: direction (Orientation) – The direction(s) in which the size should reduce.
Return type: Size
Returns: The current size if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as the current size in the other direction (if any).

See also

IsSizingContinuous

GetNextSmallerSize (self, direction, relative_to)

If sizing is not continuous, then return a suitable size for the control which is smaller than the given size.

Parameters

direction (Orientation) – The direction(s) in which the size should reduce.
relative_to (wx.Size) – The size for which a smaller size should be found.

Return type

Size

Returns

relative_to if there is no smaller size, otherwise a suitable size which is smaller in the given direction(s), and the same as relative_to in the other direction (if any).

See also

IsSizingContinuous

See also

DoGetNextSmallerSize

IsSizingContinuous(self)¶

Return type: bool
Returns: True if this window can take any size (greater than its minimum size), False if it can only take certain sizes.

See also

GetNextSmallerSize

See also

GetNextLargerSize

Realise(self)¶

Alias for Realize .

Return type: bool

Realize(self)¶

Perform initial size and layout calculations after children have been added, and/or realize children.

Return type: bool

SetArtProvider(self, art)¶

Set the art provider to be used.

In many cases, setting the art provider will also set the art provider on all child windows which extend wx.ribbon.RibbonControl.

In most cases, controls will not take ownership of the given pointer, with the notable exception being wx.ribbon.RibbonBar.SetArtProvider .

Parameters: art (wx.ribbon.RibbonArtProvider) –

Properties¶

AncestorRibbonBar¶: See GetAncestorRibbonBar

ArtProvider¶: See GetArtProvider and SetArtProvider

Navigation

wx.ribbon.RibbonControl¶

Class Hierarchy¶

Known Subclasses¶

Methods Summary¶

Properties Summary¶

Class API¶

Methods¶

Properties¶