wx.lib.agw.ribbon.art_msw.RibbonMSWArtProvider

Class Hierarchy

Inheritance diagram for class RibbonMSWArtProvider:

Known Subclasses

wx.lib.agw.ribbon.art_aui.RibbonAUIArtProvider, wx.lib.agw.ribbon.art_default.RibbonDefaultArtProvider

Methods Summary

__init__
Clone	Create a new art provider which is a clone of this one.
CloneTo
DrawButtonBarBackground	Draw the background for a RibbonButtonBar control.
DrawButtonBarButton	Draw a single button for a RibbonButtonBar control.
DrawButtonBarButtonForeground
DrawDropdownArrow
DrawGalleryBackground	Draw the background and chrome for a RibbonGallery control.
DrawGalleryBackgroundCommon
DrawGalleryButton
DrawGalleryItemBackground	Draw the background of a single item in a RibbonGallery control.
DrawMinimisedPanel	Draw a minimised ribbon panel.
DrawMinimisedPanelCommon
DrawPageBackground	Draw the background of a ribbon page.
DrawPanelBackground	Draw the background and chrome for a ribbon panel.
DrawPanelBorder
DrawPartialPageBackground
DrawPartialPageBackground1
DrawPartialPageBackground2
DrawScrollButton	Draw a ribbon-style scroll button.
DrawTab	Draw a single tab in the tab region of a ribbon bar.
DrawTabCtrlBackground	Draw the background of the tab region of a ribbon bar.
DrawTabSeparator	Draw a separator between two tabs in a ribbon bar.
DrawTool	Draw a single tool (for a RibbonToolBar control).
DrawToolBarBackground	Draw the background for a RibbonToolBar control.
DrawToolGroupBackground	Draw the background for a group of tools on a RibbonToolBar control.
GetBarTabWidth	Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
GetButtonBarButtonSize	Calculate the size of a button within a RibbonButtonBar.
GetColour	Get the value of a certain colour setting.
GetColourScheme	Get the current colour scheme.
GetFlags	Get the previously set style flags.
GetFont	Get the value of a certain font setting.
GetGalleryClientSize	Calculate the client size of a RibbonGallery control for a given size.
GetGallerySize	Calculate the size of a RibbonGallery control for a given client size.
GetMetric	Get the value of a certain integer setting.
GetMinimisedPanelMinimumSize	Calculate the size of a minimised ribbon panel.
GetPageBackgroundRedrawArea	Calculate the portion of a page background which needs to be redrawn when a page
GetPanelClientSize	Calculate the client size of a panel for a given overall size.
GetPanelExtButtonArea	Retrieve the extension button area rectangle.
GetPanelSize	Calculate the size of a panel for a given client size.
GetScrollButtonMinimumSize	Calculate the minimum size (in pixels) of a scroll button.
GetTabCtrlHeight	Calculate the height (in pixels) of the tab region of a ribbon bar.
GetToolSize	Calculate the size of a tool within a RibbonToolBar.
ReallyDrawTabSeparator
Reload
RemovePanelPadding
SetColour	Set the value of a certain colour setting to the value.
SetColourScheme	Set all applicable colour settings from a few base colours.
SetFlags	Set the style flags.
SetFont	Set the value of a certain font setting to the value.
SetMetric	Set the value of a certain integer setting to the value.

Class API

---

class RibbonMSWArtProvider(object)

Methods

---

__init__(self, set_colour_scheme=True)

---

Clone(self)

Create a new art provider which is a clone of this one.

---

CloneTo(self, copy)

---

DrawButtonBarBackground(self, dc, wnd, rect)

Draw the background for a RibbonButtonBar control.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto (which will typically be the button bar itself, though this is not guaranteed);
• rect – The rectangle within which to draw.

---

DrawButtonBarButton(self, dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small)

Draw a single button for a RibbonButtonBar control.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto;
• rect – The rectangle within which to draw. The size of this rectangle will be a size previously returned by GetButtonBarButtonSize, and the rectangle will be entirely within a rectangle on the same device context previously painted with DrawButtonBarBackground;
• kind – The kind of button to draw (normal, dropdown or hybrid);
• state – Combination of a size flag and state flags from the RibbonButtonBarButtonState enumeration;
• label – The label of the button;
• bitmap_large – The large bitmap of the button (or the large disabled bitmap when RIBBON_BUTTONBAR_BUTTON_DISABLED is set in state);
• bitmap_small – The small bitmap of the button (or the small disabled bitmap when RIBBON_BUTTONBAR_BUTTON_DISABLED is set in state).

---

DrawButtonBarButtonForeground(self, dc, rect, kind, state, label, bitmap_large, bitmap_small)

---

DrawDropdownArrow(self, dc, x, y, colour)

---

DrawGalleryBackground(self, dc, wnd, rect)

Draw the background and chrome for a RibbonGallery control.

This should draw the border, brackground, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto, which is always the gallery whose background and chrome is being drawn. Attributes used during drawing like the gallery hover state and individual button states can be queried from this parameter by RibbonGallery.IsHovered(), RibbonGallery.GetExtensionButtonState(), RibbonGallery.GetUpButtonState(), and RibbonGallery.GetDownButtonState();
• rect – The rectangle within which to draw. This rectangle is the entire area of the gallery control, not just the client rectangle.

---

DrawGalleryBackgroundCommon(self, dc, wnd, rect)

---

DrawGalleryButton(self, dc, rect, state, bitmaps)

---

DrawGalleryItemBackground(self, dc, wnd, rect, item)

Draw the background of a single item in a RibbonGallery control.

This is painted on top of a gallery background, and behind the items bitmap. Unlike DrawButtonBarButton and DrawTool, it is not expected to draw the item bitmap - that is done by the gallery control itself.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto, which is always the gallery which contains the item being drawn;
• rect – The rectangle within which to draw. The size of this rectangle will be the size of the item’s bitmap, expanded by gallery item padding values (RIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE, RIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE, RIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE, and RIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with DrawGalleryBackground;
• item – The item whose background is being painted. Typically the background will vary if the item is hovered, active, or selected; RibbonGallery.GetSelection(), RibbonGallery.GetActiveItem(), and RibbonGallery.GetHoveredItem() can be called to test if the given item is in one of these states.

---

DrawMinimisedPanel(self, dc, wnd, rect, bitmap)

Draw a minimised ribbon panel.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto, which is always the panel which is minimised. The panel label can be obtained from this window. The minimised icon obtained from querying the window may not be the size requested by GetMinimisedPanelMinimumSize - the argument contains the icon in the requested size;
• rect – The rectangle within which to draw. The size of the rectangle will be at least the size returned by GetMinimisedPanelMinimumSize;
• bitmap – A copy of the panel’s minimised bitmap rescaled to the size returned by GetMinimisedPanelMinimumSize.

---

DrawMinimisedPanelCommon(self, dc, wnd, true_rect)

---

DrawPageBackground(self, dc, wnd, rect)

Draw the background of a ribbon page.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto (which is commonly the RibbonPage whose background is being drawn, but doesn’t have to be);
• rect – The rectangle within which to draw.

See also

GetPageBackgroundRedrawArea

---

DrawPanelBackground(self, dc, wnd, rect)

Draw the background and chrome for a ribbon panel.

This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel. Note that when a panel is minimised, this function is not called - only DrawMinimisedPanel is called, so a background should be explicitly painted by that if required.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto, which is always the panel whose background and chrome is being drawn. The panel label and other panel attributes can be obtained by querying this;
• rect – The rectangle within which to draw.

---

DrawPanelBorder(self, dc, rect, primary_colour, secondary_colour)

---

DrawPartialPageBackground(self, dc, wnd, rect, allow_hovered_or_page=True, offset=None, hovered=False)

---

DrawPartialPageBackground1(self, dc, wnd, rect, page, offset, hovered=False)

---

DrawPartialPageBackground2(self, dc, wnd, rect, allow_hovered=True)

---

DrawScrollButton(self, dc, wnd, rect_, style)

Draw a ribbon-style scroll button.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto;
• rect – The rectangle within which to draw. The size of this rectangle will be at least the size returned by GetScrollButtonMinimumSize for a scroll button with the same style. For tab scroll buttons, this rectangle will be entirely within a rectangle on the same device context previously painted with DrawTabCtrlBackground, but this is not guaranteed for other types of button (for example, page scroll buttons will not be painted on an area previously painted with DrawPageBackground );
• style – A combination of flags from RibbonScrollButtonStyle, including a direction, a for flag, and one or more states.

---

DrawTab(self, dc, wnd, tab)

Draw a single tab in the tab region of a ribbon bar.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto (not the RibbonPage associated with the tab being drawn);
• tab – The rectangle within which to draw, and also the tab label, icon, and state (active and/or hovered). The drawing rectangle will be entirely within a rectangle on the same device context previously painted with DrawTabCtrlBackground. The rectangle’s width will be at least the minimum value returned by GetBarTabWidth, and height will be the value returned by GetTabCtrlHeight.

---

DrawTabCtrlBackground(self, dc, wnd, rect)

Draw the background of the tab region of a ribbon bar.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto;
• rect – The rectangle within which to draw.

---

DrawTabSeparator(self, dc, wnd, rect, visibility)

Draw a separator between two tabs in a ribbon bar.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto;
• rect – The rectangle within which to draw, which will be entirely within a rectangle on the same device context previously painted with DrawTabCtrlBackground;
• visibility – The opacity with which to draw the separator. Values are in the range [0, 1], with 0 being totally transparent, and 1 being totally opaque.

---

DrawTool(self, dc, wnd, rect, bitmap, kind, state)

Draw a single tool (for a RibbonToolBar control).

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto. In most cases this will be a RibbonToolBar, but it doesn’t have to be;
• rect – The rectangle within which to draw. The size of this rectangle will at least the size returned by GetToolSize, and the height of it will be equal for all tools within the same group. The rectangle will be entirely within a rectangle on the same device context previously painted with DrawToolGroupBackground;
• bitmap – The bitmap to use as the tool’s foreground. If the tool is a hybrid or dropdown tool, then the foreground should also contain a standard dropdown button;
• kind – The kind of tool to draw (normal, dropdown, or hybrid);
• state – A combination of RibbonToolBarToolState flags giving the state of the tool and it’s relative position within a tool group.

---

DrawToolBarBackground(self, dc, wnd, rect)

Draw the background for a RibbonToolBar control.

Parameters:

• dc – The device context to draw onto;
• wnd – The which is being drawn onto. In most cases this will be a RibbonToolBar, but it doesn’t have to be;
• rect – The rectangle within which to draw. Some of this rectangle will later be drawn over using DrawToolGroupBackground and DrawTool, but not all of it will (unless there is only a single group of tools).

---

DrawToolGroupBackground(self, dc, wnd, rect)

Draw the background for a group of tools on a RibbonToolBar control.

Parameters:

• dc – The device context to draw onto;
• wnd – The window which is being drawn onto. In most cases this will be a RibbonToolBar, but it doesn’t have to be;
• rect – The rectangle within which to draw. This rectangle is a union of the individual tools’ rectangles. As there are no gaps between tools, this rectangle will be painted over exactly once by calls to DrawTool. The group background could therefore be painted by DrawTool, though it can be conceptually easier and more efficient to draw it all at once here. The rectangle will be entirely within a rectangle on the same device context previously painted with DrawToolBarBackground.

---

GetBarTabWidth(self, dc, wnd, label, bitmap, ideal=None, small_begin_need_separator=None, small_must_have_separator=None, minimum=None)

Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The window onto which the tab will eventually be drawn;
• label – The tab’s label (or “” if it has none);
• bitmap – The tab’s icon (or NullBitmap if it has none);
• ideal – The ideal width (in pixels) of the tab;
• small_begin_need_separator – A size less than the size, at which a tab separator should begin to be drawn (i.e. drawn, but still fairly transparent);
• small_must_have_separator – A size less than the size, at which a tab separator must be drawn (i.e. drawn at full opacity);
• minimum – A size less than the size, and greater than or equal to zero, which is the minimum pixel width for the tab.

---

GetButtonBarButtonSize(self, dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size=None, normal_region=None, dropdown_region=None)

Calculate the size of a button within a RibbonButtonBar.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The window onto which the button will eventually be drawn (which is normally a RibbonButtonBar, though this is not guaranteed);
• kind – The kind of button;
• size – The size-class to calculate the size for. Buttons on a button bar can have three distinct sizes: RIBBON_BUTTONBAR_BUTTON_SMALL, RIBBON_BUTTONBAR_BUTTON_MEDIUM, and RIBBON_BUTTONBAR_BUTTON_LARGE. If the requested size-class is not applicable, then False should be returned;
• label – The label of the button;
• bitmap_size_large – The size of all “large” bitmaps on the button bar;
• bitmap_size_small – The size of all “small” bitmaps on the button bar;
• button_size – The size, in pixels, of the button;
• normal_region – The region of the button which constitutes the normal button;
• dropdown_region – The region of the button which constitutes the dropdown button.

Returns:

True if a size exists for the button, False otherwise.

---

GetColour(self, id)

Get the value of a certain colour setting.

can be one of the colour values of RibbonArtSetting.

Parameters:id – the colour id.

---

GetColourScheme(self, primary, secondary, tertiary)

Get the current colour scheme.

Returns three colours such that if SetColourScheme were called with them, the colour scheme would be restored to what it was when SetColourScheme was last called. In practice, this usually means that the returned values are the three colours given in the last call to SetColourScheme, however if SetColourScheme performs an idempotent operation upon the colours it is given (like clamping a component of the colour), then the returned values may not be the three colours given in the last call to SetColourScheme.

If SetColourScheme has not been called, then the returned values should result in a colour scheme similar to, if not identical to, the default colours of the art provider. Note that if SetColour is called, then GetColourScheme does not try and return a colour scheme similar to colours being used - it’s return values are dependant upon the last values given to SetColourScheme, as described above.

Parameters:

• primary – Pointer to a location to store the primary colour, or None;
• secondary – Pointer to a location to store the secondary colour, or None;
• tertiary – Pointer to a location to store the tertiary colour, or None.

---

GetFlags(self)

Get the previously set style flags.

---

GetFont(self, id)

Get the value of a certain font setting.

can be one of the font values of RibbonArtSetting.

Parameters:id – the font id.

---

GetGalleryClientSize(self, dc, wnd, size, client_offset=None, scroll_up_button=None, scroll_down_button=None, extension_button=None)

Calculate the client size of a RibbonGallery control for a given size.

This should act as the inverse to GetGallerySize, and decrement the given size by enough to fir the gallery border, buttons, and other chrome.

Parameters:

• dc – A device context to use if one is required for size calculations;
• wnd – The gallery in question;
• size – The overall size to calculate the client size for;
• client_offset – The position within the given size at which the returned client size begins;
• scroll_up_button – The rectangle within the given size which the scroll up button occupies;
• scroll_down_button – The rectangle within the given size which the scroll down button occupies;
• extension_button – The rectangle within the given size which the extension button occupies.

---

GetGallerySize(self, dc, wnd, client_size)

Calculate the size of a RibbonGallery control for a given client size.

This should increment the given size by enough to fit the gallery border, buttons, and any other chrome.

Parameters:

• dc – A device context to use if one is required for size calculations;
• wnd – The gallery in question;
• client_size – The client size.

See also

GetGalleryClientSize

---

GetMetric(self, id)

Get the value of a certain integer setting.

can be one of the size values of RibbonArtSetting.

Parameters:id – a metric id.

---

GetMinimisedPanelMinimumSize(self, dc, wnd, desired_bitmap_size=None, expanded_panel_direction=None)

Calculate the size of a minimised ribbon panel.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The ribbon panel in question. Attributes like the panel label can be queried from this;
• desired_bitmap_size – MISSING DESCRIPTION;
• expanded_panel_direction – MISSING DESCRIPTION.

---

GetPageBackgroundRedrawArea(self, dc, wnd, page_old_size, page_new_size)

Calculate the portion of a page background which needs to be redrawn when a page is resized.

To optimise the drawing of page backgrounds, as small an area as possible should be returned. Of couse, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The page which is being resized;
• page_old_size – The size of the page prior to the resize (which has already been painted);
• page_new_size – The size of the page after the resize.

---

GetPanelClientSize(self, dc, wnd, size, client_offset=None)

Calculate the client size of a panel for a given overall size.

This should act as the inverse to GetPanelSize, and decrement the given size by enough to fit the panel label and other chrome.

Parameters:

• dc – A device context to use if one is required for size calculations;
• wnd – The ribbon panel in question;
• size – The overall size to calculate client size for;
• client_offset – The offset where the returned client size begins within the given (may be None).

See also

GetPanelSize

---

GetPanelExtButtonArea(self, dc, wnd, rect)

Retrieve the extension button area rectangle.

Parameters:

• dc – The device context used to measure text extents;
• wnd – The panel where the extension button resides;
• rect – The panel client rectangle.

---

GetPanelSize(self, dc, wnd, client_size, client_offset=None)

Calculate the size of a panel for a given client size.

This should increment the given size by enough to fit the panel label and other chrome.

Parameters:

• dc – A device context to use if one is required for size calculations;
• wnd – The ribbon panel in question;
• client_size – The client size;
• client_offset – The offset where the client rectangle begins within the panel (may be None).

See also

GetPanelClientSize

---

GetScrollButtonMinimumSize(self, dc, wnd, style)

Calculate the minimum size (in pixels) of a scroll button.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The window onto which the scroll button will eventually be drawn;
• style – A combination of flags from RibbonScrollButtonStyle, including a direction, and a for flag (state flags may be given too, but should be ignored, as a button should retain a constant size, regardless of its state).

---

GetTabCtrlHeight(self, dc, wnd, pages)

Calculate the height (in pixels) of the tab region of a ribbon bar.

Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The window onto which the tabs will eventually be drawn;
• pages – The tabs which will acquire the returned height.

---

GetToolSize(self, dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region=None)

Calculate the size of a tool within a RibbonToolBar.

Parameters:

• dc – A device context to use when one is required for size calculations;
• wnd – The window onto which the tool will eventually be drawn;
• bitmap_size – The size of the tool’s foreground bitmap;
• kind – The kind of tool (normal, dropdown, or hybrid);
• is_first – True if the tool is the first within its group. False otherwise;
• is_last – True if the tool is the last within its group. False otherwise;
• dropdown_region – For dropdown and hybrid tools, the region within the returned size which counts as the dropdown part.

---

ReallyDrawTabSeparator(self, wnd, rect, visibility)

---

Reload(self, setting)

---

RemovePanelPadding(self, rect)

---

SetColour(self, id, colour)

Set the value of a certain colour setting to the value.

can be one of the colour values of RibbonArtSetting, though not all colour settings will have an affect on every art provider.

Parameters:

• id – the colour id;
• colour – the colour.

See also

SetColourScheme

---

SetColourScheme(self, primary, secondary, tertiary)

Set all applicable colour settings from a few base colours.

Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either.

Parameters:

• primary – MISSING DESCRIPTION;
• secondary – MISSING DESCRIPTION;
• tertiary – MISSING DESCRIPTION.

See also

SetColour, GetColourScheme

---

SetFlags(self, flags)

Set the style flags.

Normally called automatically by RibbonBar.SetArtProvider() with the ribbon bar’s style flags, so that the art provider has the same flags as the bar which it is serving.

Parameters:flags – MISSING DESCRIPTION.

---

SetFont(self, id, font)

Set the value of a certain font setting to the value.

can be one of the font values of RibbonArtSetting.

Parameters:

• id – a font id;
• font – the new font.

---

SetMetric(self, id, new_val)

Set the value of a certain integer setting to the value.

can be one of the size values of RibbonArtSetting.

Parameters:

• id – a metric id;
• new_val – the new value of the metric setting.