Version: 3.3.4
Loading...
Searching...
No Matches
wxRibbonAUIArtProvider Class Reference

#include <wx/ribbon/art.h>

Inheritance diagram for wxRibbonAUIArtProvider:

Detailed Description

An art provider styled after the wxAUI docking framework.

Like wxRibbonMSWArtProvider it uses gradient fills, but differs in its layout of panel labels (placed at the top rather than the bottom) and general styling.

Library:  wxRibbon
Category:  Ribbon User Interface
See also
wxRibbonMSWArtProvider, wxRibbonMSWFlatArtProvider

Public Member Functions

 wxRibbonAUIArtProvider ()
Public Member Functions inherited from wxRibbonMSWArtProvider
 wxRibbonMSWArtProvider (bool set_colour_scheme=true)
 Constructor.
Public Member Functions inherited from wxRibbonArtProvider
 wxRibbonArtProvider ()
 Constructor.
virtual ~wxRibbonArtProvider ()
 Destructor.
virtual wxRibbonArtProvider * Clone () const =0
 Create a new art provider which is a clone of this one.
virtual void SetFlags (long flags)=0
 Set the style flags.
virtual long GetFlags () const =0
 Get the previously set style flags.
virtual int GetMetric (int id) const =0
 Get the value of a certain integer setting.
virtual void SetMetric (int id, int new_val)=0
 Set the value of a certain integer setting to the value new_val.
virtual void SetFont (int id, const wxFont &font)=0
 Set the value of a certain font setting to the value font.
virtual wxFont GetFont (int id) const =0
 Get the value of a certain font setting.
virtual wxColour GetColour (int id) const =0
 Get the value of a certain colour setting.
virtual void SetColour (int id, const wxColour &colour)=0
 Set the value of a certain colour setting to the value colour.
wxColour GetColor (int id) const
void SetColor (int id, const wxColour &color)
virtual void GetColourScheme (wxColour *primary, wxColour *secondary, wxColour *tertiary) const =0
 Get the current colour scheme.
virtual void SetColourScheme (const wxColour &primary, const wxColour &secondary, const wxColour &tertiary)=0
 Set all applicable colour settings from a few base colours.
virtual void UpdateColoursFromSystem ()
 Called when the system colours change to allow the art provider to update its colours.
virtual void DrawTabCtrlBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)=0
 Draw the background of the tab region of a ribbon bar.
virtual void DrawTab (wxDC &dc, wxWindow *wnd, const wxRibbonPageTabInfo &tab)=0
 Draw a single tab in the tab region of a ribbon bar.
virtual void DrawTabSeparator (wxDC &dc, wxWindow *wnd, const wxRect &rect, double visibility)=0
 Draw a separator between two tabs in a ribbon bar.
virtual void DrawPageBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)=0
 Draw the background of a ribbon page.
virtual void DrawScrollButton (wxDC &dc, wxWindow *wnd, const wxRect &rect, long style)=0
 Draw a ribbon-style scroll button.
virtual void DrawPanelBackground (wxDC &dc, wxRibbonPanel *wnd, const wxRect &rect)=0
 Draw the background and chrome for a ribbon panel.
virtual void DrawGalleryBackground (wxDC &dc, wxRibbonGallery *wnd, const wxRect &rect)=0
 Draw the background and chrome for a wxRibbonGallery control.
virtual void DrawGalleryItemBackground (wxDC &dc, wxRibbonGallery *wnd, const wxRect &rect, wxRibbonGalleryItem *item)=0
 Draw the background of a single item in a wxRibbonGallery control.
virtual void DrawMinimisedPanel (wxDC &dc, wxRibbonPanel *wnd, const wxRect &rect, wxBitmap &bitmap)=0
 Draw a minimised ribbon panel.
virtual void DrawButtonBarBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)=0
 Draw the background for a wxRibbonButtonBar control.
virtual void DrawButtonBarButton (wxDC &dc, wxWindow *wnd, const wxRect &rect, wxRibbonButtonKind kind, long state, const wxString &label, const wxBitmap &bitmap_large, const wxBitmap &bitmap_small)=0
 Draw a single button for a wxRibbonButtonBar control.
virtual void DrawToolBarBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)=0
 Draw the background for a wxRibbonToolBar control.
virtual void DrawToolGroupBackground (wxDC &dc, wxWindow *wnd, const wxRect &rect)=0
 Draw the background for a group of tools on a wxRibbonToolBar control.
virtual void DrawTool (wxDC &dc, wxWindow *wnd, const wxRect &rect, const wxBitmap &bitmap, wxRibbonButtonKind kind, long state)=0
 Draw a single tool (for a wxRibbonToolBar control).
virtual void DrawToggleButton (wxDC &dc, wxRibbonBar *wnd, const wxRect &rect, wxRibbonDisplayMode mode)=0
 Draw toggle button on wxRibbonBar.
virtual void DrawHelpButton (wxDC &dc, wxRibbonBar *wnd, const wxRect &rect)=0
 Draw help button on wxRibbonBar.
virtual bool DrawKeyTip (wxDC &dc, wxWindow *wnd, const wxRect &rect, const wxString &keytip)
 Draw a KeyTip badge over a ribbon element in keyboard access mode.
virtual void GetBarTabWidth (wxReadOnlyDC &dc, wxWindow *wnd, const wxString &label, const wxBitmap &bitmap, int *ideal, int *small_begin_need_separator, int *small_must_have_separator, int *minimum)=0
 Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar.
virtual int GetTabCtrlHeight (wxReadOnlyDC &dc, wxWindow *wnd, const wxRibbonPageTabInfoArray &pages)=0
 Calculate the height (in pixels) of the tab region of a ribbon bar.
virtual wxSize GetScrollButtonMinimumSize (wxReadOnlyDC &dc, wxWindow *wnd, long style)=0
 Calculate the minimum size (in pixels) of a scroll button.
virtual wxSize GetPanelSize (wxReadOnlyDC &dc, const wxRibbonPanel *wnd, wxSize client_size, wxPoint *client_offset)=0
 Calculate the size of a panel for a given client size.
virtual wxSize GetPanelClientSize (wxReadOnlyDC &dc, const wxRibbonPanel *wnd, wxSize size, wxPoint *client_offset)=0
 Calculate the client size of a panel for a given overall size.
virtual wxRect GetPanelExtButtonArea (wxReadOnlyDC &dc, const wxRibbonPanel *wnd, wxRect rect)=0
 Calculate the position and size of the panel extension button.
virtual wxSize GetGallerySize (wxReadOnlyDC &dc, const wxRibbonGallery *wnd, wxSize client_size)=0
 Calculate the size of a wxRibbonGallery control for a given client size.
virtual wxSize GetGalleryClientSize (wxReadOnlyDC &dc, const wxRibbonGallery *wnd, wxSize size, wxPoint *client_offset, wxRect *scroll_up_button, wxRect *scroll_down_button, wxRect *extension_button)=0
 Calculate the client size of a wxRibbonGallery control for a given size.
virtual wxRect GetPageBackgroundRedrawArea (wxReadOnlyDC &dc, const wxRibbonPage *wnd, wxSize page_old_size, wxSize page_new_size)=0
 Calculate the portion of a page background which needs to be redrawn when a page is resized.
virtual bool GetButtonBarButtonSize (wxReadOnlyDC &dc, wxWindow *wnd, wxRibbonButtonKind kind, wxRibbonButtonBarButtonState size, const wxString &label, wxCoord text_min_width, wxSize bitmap_size_large, wxSize bitmap_size_small, wxSize *button_size, wxRect *normal_region, wxRect *dropdown_region)=0
 Calculate the size of a button within a wxRibbonButtonBar.
virtual wxCoord GetButtonBarButtonTextWidth (wxReadOnlyDC &dc, const wxString &label, wxRibbonButtonKind kind, wxRibbonButtonBarButtonState size)=0
 Gets the width of the string if it is used as a wxRibbonButtonBar button label.
virtual wxSize GetMinimisedPanelMinimumSize (wxReadOnlyDC &dc, const wxRibbonPanel *wnd, wxSize *desired_bitmap_size, wxDirection *expanded_panel_direction)=0
 Calculate the size of a minimised ribbon panel.
virtual wxSize GetToolSize (wxReadOnlyDC &dc, wxWindow *wnd, wxSize bitmap_size, wxRibbonButtonKind kind, bool is_first, bool is_last, wxRect *dropdown_region)=0
 Calculate the size of a tool within a wxRibbonToolBar.
virtual wxRect GetBarToggleButtonArea (const wxRect &rect)=0
 Calculate the position and size of the ribbon's toggle button.
virtual wxRect GetRibbonHelpButtonArea (const wxRect &rect)=0
 Calculate the position and size of the ribbon's help button.

Constructor & Destructor Documentation

◆ wxRibbonAUIArtProvider()

wxRibbonAUIArtProvider::wxRibbonAUIArtProvider ( )