AGW Logo

Navigation

agw_title RibbonControl

hierarchy Inheritance Diagram

Inheritance diagram for: RibbonControl

Inheritance diagram of RibbonControl


method_summary Methods Summary

__init__
DoGetNextLargerSizeImplementation of GetNextLargerSize.
DoGetNextSmallerSizeImplementation of GetNextSmallerSize.
GetArtProviderGet the art provider to be used.
GetNextLargerSizeIf sizing is not continuous, then return a suitable size for the control which is larger then the given size.
GetNextSmallerSizeIf sizing is not continuous, then return a suitable size for the control which is smaller than the given size.
IsSizingContinuous
returns:True if this window can take any size (greater than its minimum size),
RibbonControl.Realise Alias for Realize.
RibbonControl.Realize Perform initial size and layout calculations after children have been added,
RibbonControl.SetArtProvider Set the art provider to be used.

API Class API

class RibbonControl(wx.PyControl)[source]

__init__(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name="RibbonControl")[source]

DoGetNextLargerSize(direction, size)[source]

Implementation of GetNextLargerSize.

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

Parameters:
  • direction – MISSING DESCRIPTION;
  • relative_to – MISSING DESCRIPTION.

DoGetNextSmallerSize(direction, size)[source]

Implementation of GetNextSmallerSize.

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

Parameters:
  • direction – MISSING DESCRIPTION;
  • relative_to – MISSING DESCRIPTION.

GetArtProvider()[source]

Get the art provider to be used.

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


GetNextLargerSize(direction, relative_to=None)[source]

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

Parameters:
  • direction – The direction(s) in which the size should increase;
  • relative_to – The size for which a larger size should be found.
Returns:

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

See also

IsSizingContinuous, DoGetNextLargerSize


GetNextSmallerSize(direction, relative_to=None)[source]

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

Parameters:
  • direction – The direction(s) in which the size should reduce;
  • relative_to – The size for which a smaller size should be found.
Returns:

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

See also

IsSizingContinuous, DoGetNextSmallerSize


IsSizingContinuous()[source]
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, GetNextLargerSize


Realise()[source]

Alias for Realize.


Realize()[source]

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


SetArtProvider(art)[source]

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 RibbonControl. In most cases, controls will not take ownership of the given pointer, with the notable exception being RibbonBar.SetArtProvider().

Parameters:art – MISSING DESCRIPTION.

AGW

Tree

Table Of Contents

Previous topic

ribbon.control

Next topic

ribbon.gallery

Navigation

© Copyright 2012, Andrea Gavana. Created using Sphinx 1.2pre.