1bb4404527
Allow changing the colour of the label in the active and hover states to make it possible to improve its contrast with the tab background in these states. Closes #18406.
966 lines
36 KiB
C++
966 lines
36 KiB
C++
///////////////////////////////////////////////////////////////////////////////
|
|
// Name: wx/ribbon/art.h
|
|
// Purpose: Art providers for ribbon-bar-style interface
|
|
// Author: Peter Cawley
|
|
// Modified by:
|
|
// Created: 2009-05-25
|
|
// Copyright: (C) Peter Cawley
|
|
// Licence: wxWindows licence
|
|
///////////////////////////////////////////////////////////////////////////////
|
|
|
|
#ifndef _WX_RIBBON_ART_H_
|
|
#define _WX_RIBBON_ART_H_
|
|
|
|
#include "wx/defs.h"
|
|
|
|
#if wxUSE_RIBBON
|
|
|
|
#include "wx/brush.h"
|
|
#include "wx/colour.h"
|
|
#include "wx/font.h"
|
|
#include "wx/pen.h"
|
|
#include "wx/bitmap.h"
|
|
#include "wx/ribbon/bar.h"
|
|
|
|
class WXDLLIMPEXP_FWD_CORE wxDC;
|
|
class WXDLLIMPEXP_FWD_CORE wxWindow;
|
|
|
|
enum wxRibbonArtSetting
|
|
{
|
|
wxRIBBON_ART_TAB_SEPARATION_SIZE,
|
|
wxRIBBON_ART_PAGE_BORDER_LEFT_SIZE,
|
|
wxRIBBON_ART_PAGE_BORDER_TOP_SIZE,
|
|
wxRIBBON_ART_PAGE_BORDER_RIGHT_SIZE,
|
|
wxRIBBON_ART_PAGE_BORDER_BOTTOM_SIZE,
|
|
wxRIBBON_ART_PANEL_X_SEPARATION_SIZE,
|
|
wxRIBBON_ART_PANEL_Y_SEPARATION_SIZE,
|
|
wxRIBBON_ART_TOOL_GROUP_SEPARATION_SIZE,
|
|
wxRIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE,
|
|
wxRIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE,
|
|
wxRIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE,
|
|
wxRIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE,
|
|
wxRIBBON_ART_PANEL_LABEL_FONT,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_FONT,
|
|
wxRIBBON_ART_TAB_LABEL_FONT,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_HOVER_BORDER_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_ACTIVE_BORDER_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BORDER_COLOUR,
|
|
wxRIBBON_ART_GALLERY_HOVER_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_FACE_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_HOVER_FACE_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_FACE_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_GALLERY_BUTTON_DISABLED_FACE_COLOUR,
|
|
wxRIBBON_ART_GALLERY_ITEM_BORDER_COLOUR,
|
|
wxRIBBON_ART_TAB_LABEL_COLOUR,
|
|
wxRIBBON_ART_TAB_ACTIVE_LABEL_COLOUR,
|
|
wxRIBBON_ART_TAB_HOVER_LABEL_COLOUR,
|
|
wxRIBBON_ART_TAB_SEPARATOR_COLOUR,
|
|
wxRIBBON_ART_TAB_SEPARATOR_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TAB_CTRL_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_TAB_CTRL_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TAB_HOVER_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_TAB_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TAB_HOVER_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_TAB_HOVER_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TAB_BORDER_COLOUR,
|
|
wxRIBBON_ART_PANEL_BORDER_COLOUR,
|
|
wxRIBBON_ART_PANEL_BORDER_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PANEL_MINIMISED_BORDER_COLOUR,
|
|
wxRIBBON_ART_PANEL_MINIMISED_BORDER_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PANEL_LABEL_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_PANEL_LABEL_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PANEL_LABEL_COLOUR,
|
|
wxRIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PANEL_HOVER_LABEL_COLOUR,
|
|
wxRIBBON_ART_PANEL_MINIMISED_LABEL_COLOUR,
|
|
wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PANEL_BUTTON_FACE_COLOUR,
|
|
wxRIBBON_ART_PANEL_BUTTON_HOVER_FACE_COLOUR,
|
|
|
|
wxRIBBON_ART_PAGE_TOGGLE_FACE_COLOUR,
|
|
wxRIBBON_ART_PAGE_TOGGLE_HOVER_FACE_COLOUR,
|
|
|
|
wxRIBBON_ART_PAGE_BORDER_COLOUR,
|
|
wxRIBBON_ART_PAGE_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_PAGE_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PAGE_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_PAGE_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_PAGE_HOVER_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_PAGE_HOVER_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TOOLBAR_BORDER_COLOUR,
|
|
wxRIBBON_ART_TOOLBAR_HOVER_BORDER_COLOUR,
|
|
wxRIBBON_ART_TOOLBAR_FACE_COLOUR,
|
|
wxRIBBON_ART_TOOL_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_TOOL_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TOOL_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_TOOL_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TOOL_HOVER_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_TOOL_HOVER_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_COLOUR,
|
|
wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_COLOUR,
|
|
wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_DISABLED_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_GRADIENT_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_TOP_COLOUR,
|
|
wxRIBBON_ART_BUTTON_BAR_LABEL_HIGHLIGHT_GRADIENT_TOP_COLOUR
|
|
};
|
|
|
|
enum wxRibbonScrollButtonStyle
|
|
{
|
|
wxRIBBON_SCROLL_BTN_LEFT = 0,
|
|
wxRIBBON_SCROLL_BTN_RIGHT = 1,
|
|
wxRIBBON_SCROLL_BTN_UP = 2,
|
|
wxRIBBON_SCROLL_BTN_DOWN = 3,
|
|
|
|
wxRIBBON_SCROLL_BTN_DIRECTION_MASK = 3,
|
|
|
|
wxRIBBON_SCROLL_BTN_NORMAL = 0,
|
|
wxRIBBON_SCROLL_BTN_HOVERED = 4,
|
|
wxRIBBON_SCROLL_BTN_ACTIVE = 8,
|
|
|
|
wxRIBBON_SCROLL_BTN_STATE_MASK = 12,
|
|
|
|
wxRIBBON_SCROLL_BTN_FOR_OTHER = 0,
|
|
wxRIBBON_SCROLL_BTN_FOR_TABS = 16,
|
|
wxRIBBON_SCROLL_BTN_FOR_PAGE = 32,
|
|
|
|
wxRIBBON_SCROLL_BTN_FOR_MASK = 48
|
|
};
|
|
|
|
enum wxRibbonButtonKind
|
|
{
|
|
wxRIBBON_BUTTON_NORMAL = 1 << 0,
|
|
wxRIBBON_BUTTON_DROPDOWN = 1 << 1,
|
|
wxRIBBON_BUTTON_HYBRID = wxRIBBON_BUTTON_NORMAL | wxRIBBON_BUTTON_DROPDOWN,
|
|
wxRIBBON_BUTTON_TOGGLE = 1 << 2
|
|
};
|
|
|
|
enum wxRibbonButtonBarButtonState
|
|
{
|
|
wxRIBBON_BUTTONBAR_BUTTON_SMALL = 0 << 0,
|
|
wxRIBBON_BUTTONBAR_BUTTON_MEDIUM = 1 << 0,
|
|
wxRIBBON_BUTTONBAR_BUTTON_LARGE = 2 << 0,
|
|
wxRIBBON_BUTTONBAR_BUTTON_SIZE_MASK = 3 << 0,
|
|
|
|
wxRIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED = 1 << 3,
|
|
wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED = 1 << 4,
|
|
wxRIBBON_BUTTONBAR_BUTTON_HOVER_MASK = wxRIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED | wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED,
|
|
wxRIBBON_BUTTONBAR_BUTTON_NORMAL_ACTIVE = 1 << 5,
|
|
wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_ACTIVE = 1 << 6,
|
|
wxRIBBON_BUTTONBAR_BUTTON_ACTIVE_MASK = wxRIBBON_BUTTONBAR_BUTTON_NORMAL_ACTIVE | wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_ACTIVE,
|
|
wxRIBBON_BUTTONBAR_BUTTON_DISABLED = 1 << 7,
|
|
wxRIBBON_BUTTONBAR_BUTTON_TOGGLED = 1 << 8,
|
|
wxRIBBON_BUTTONBAR_BUTTON_STATE_MASK = 0x1F8
|
|
};
|
|
|
|
enum wxRibbonGalleryButtonState
|
|
{
|
|
wxRIBBON_GALLERY_BUTTON_NORMAL,
|
|
wxRIBBON_GALLERY_BUTTON_HOVERED,
|
|
wxRIBBON_GALLERY_BUTTON_ACTIVE,
|
|
wxRIBBON_GALLERY_BUTTON_DISABLED
|
|
};
|
|
|
|
class wxRibbonBar;
|
|
class wxRibbonPage;
|
|
class wxRibbonPanel;
|
|
class wxRibbonGallery;
|
|
class wxRibbonGalleryItem;
|
|
class wxRibbonPageTabInfo;
|
|
class wxRibbonPageTabInfoArray;
|
|
|
|
class WXDLLIMPEXP_RIBBON wxRibbonArtProvider
|
|
{
|
|
public:
|
|
wxRibbonArtProvider();
|
|
virtual ~wxRibbonArtProvider();
|
|
|
|
virtual wxRibbonArtProvider* Clone() const = 0;
|
|
virtual void SetFlags(long flags) = 0;
|
|
virtual long GetFlags() const = 0;
|
|
|
|
virtual int GetMetric(int id) const = 0;
|
|
virtual void SetMetric(int id, int new_val) = 0;
|
|
virtual void SetFont(int id, const wxFont& font) = 0;
|
|
virtual wxFont GetFont(int id) const = 0;
|
|
virtual wxColour GetColour(int id) const = 0;
|
|
virtual void SetColour(int id, const wxColor& colour) = 0;
|
|
wxColour GetColor(int id) const { return GetColour(id); }
|
|
void SetColor(int id, const wxColour& color) { SetColour(id, color); }
|
|
virtual void GetColourScheme(wxColour* primary,
|
|
wxColour* secondary,
|
|
wxColour* tertiary) const = 0;
|
|
virtual void SetColourScheme(const wxColour& primary,
|
|
const wxColour& secondary,
|
|
const wxColour& tertiary) = 0;
|
|
|
|
virtual void DrawTabCtrlBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void DrawTab(wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRibbonPageTabInfo& tab) = 0;
|
|
|
|
virtual void DrawTabSeparator(wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
double visibility) = 0;
|
|
|
|
virtual void DrawPageBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void DrawScrollButton(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
long style) = 0;
|
|
|
|
virtual void DrawPanelBackground(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void DrawGalleryBackground(
|
|
wxDC& dc,
|
|
wxRibbonGallery* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void DrawGalleryItemBackground(
|
|
wxDC& dc,
|
|
wxRibbonGallery* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonGalleryItem* item) = 0;
|
|
|
|
virtual void DrawMinimisedPanel(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect,
|
|
wxBitmap& bitmap) = 0;
|
|
|
|
virtual void DrawButtonBarBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
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;
|
|
|
|
virtual void DrawToolBarBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void DrawToolGroupBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void DrawTool(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
const wxBitmap& bitmap,
|
|
wxRibbonButtonKind kind,
|
|
long state) = 0;
|
|
|
|
virtual void DrawToggleButton(
|
|
wxDC& dc,
|
|
wxRibbonBar* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonDisplayMode mode) = 0;
|
|
|
|
virtual void DrawHelpButton(
|
|
wxDC& dc,
|
|
wxRibbonBar* wnd,
|
|
const wxRect& rect) = 0;
|
|
|
|
virtual void GetBarTabWidth(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxString& label,
|
|
const wxBitmap& bitmap,
|
|
int* ideal,
|
|
int* small_begin_need_separator,
|
|
int* small_must_have_separator,
|
|
int* minimum) = 0;
|
|
|
|
virtual int GetTabCtrlHeight(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRibbonPageTabInfoArray& pages) = 0;
|
|
|
|
virtual wxSize GetScrollButtonMinimumSize(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
long style) = 0;
|
|
|
|
virtual wxSize GetPanelSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize client_size,
|
|
wxPoint* client_offset) = 0;
|
|
|
|
virtual wxSize GetPanelClientSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize size,
|
|
wxPoint* client_offset) = 0;
|
|
|
|
virtual wxRect GetPanelExtButtonArea(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxRect rect) = 0;
|
|
|
|
virtual wxSize GetGallerySize(
|
|
wxDC& dc,
|
|
const wxRibbonGallery* wnd,
|
|
wxSize client_size) = 0;
|
|
|
|
virtual wxSize GetGalleryClientSize(
|
|
wxDC& dc,
|
|
const wxRibbonGallery* wnd,
|
|
wxSize size,
|
|
wxPoint* client_offset,
|
|
wxRect* scroll_up_button,
|
|
wxRect* scroll_down_button,
|
|
wxRect* extension_button) = 0;
|
|
|
|
virtual wxRect GetPageBackgroundRedrawArea(
|
|
wxDC& dc,
|
|
const wxRibbonPage* wnd,
|
|
wxSize page_old_size,
|
|
wxSize page_new_size) = 0;
|
|
|
|
virtual bool GetButtonBarButtonSize(
|
|
wxDC& 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;
|
|
|
|
virtual wxCoord GetButtonBarButtonTextWidth(
|
|
wxDC& dc, const wxString& label,
|
|
wxRibbonButtonKind kind,
|
|
wxRibbonButtonBarButtonState size) = 0;
|
|
|
|
virtual wxSize GetMinimisedPanelMinimumSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize* desired_bitmap_size,
|
|
wxDirection* expanded_panel_direction) = 0;
|
|
|
|
virtual wxSize GetToolSize(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
wxSize bitmap_size,
|
|
wxRibbonButtonKind kind,
|
|
bool is_first,
|
|
bool is_last,
|
|
wxRect* dropdown_region) = 0;
|
|
|
|
virtual wxRect GetBarToggleButtonArea(const wxRect& rect)= 0;
|
|
|
|
virtual wxRect GetRibbonHelpButtonArea(const wxRect& rect) = 0;
|
|
};
|
|
|
|
class WXDLLIMPEXP_RIBBON wxRibbonMSWArtProvider : public wxRibbonArtProvider
|
|
{
|
|
public:
|
|
wxRibbonMSWArtProvider(bool set_colour_scheme = true);
|
|
virtual ~wxRibbonMSWArtProvider();
|
|
|
|
wxRibbonArtProvider* Clone() const wxOVERRIDE;
|
|
void SetFlags(long flags) wxOVERRIDE;
|
|
long GetFlags() const wxOVERRIDE;
|
|
|
|
int GetMetric(int id) const wxOVERRIDE;
|
|
void SetMetric(int id, int new_val) wxOVERRIDE;
|
|
void SetFont(int id, const wxFont& font) wxOVERRIDE;
|
|
wxFont GetFont(int id) const wxOVERRIDE;
|
|
wxColour GetColour(int id) const wxOVERRIDE;
|
|
void SetColour(int id, const wxColor& colour) wxOVERRIDE;
|
|
void GetColourScheme(wxColour* primary,
|
|
wxColour* secondary,
|
|
wxColour* tertiary) const wxOVERRIDE;
|
|
void SetColourScheme(const wxColour& primary,
|
|
const wxColour& secondary,
|
|
const wxColour& tertiary) wxOVERRIDE;
|
|
|
|
int GetTabCtrlHeight(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRibbonPageTabInfoArray& pages) wxOVERRIDE;
|
|
|
|
void DrawTabCtrlBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawTab(wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRibbonPageTabInfo& tab) wxOVERRIDE;
|
|
|
|
void DrawTabSeparator(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
double visibility) wxOVERRIDE;
|
|
|
|
void DrawPageBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawScrollButton(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
long style) wxOVERRIDE;
|
|
|
|
void DrawPanelBackground(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawGalleryBackground(
|
|
wxDC& dc,
|
|
wxRibbonGallery* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawGalleryItemBackground(
|
|
wxDC& dc,
|
|
wxRibbonGallery* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonGalleryItem* item) wxOVERRIDE;
|
|
|
|
void DrawMinimisedPanel(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect,
|
|
wxBitmap& bitmap) wxOVERRIDE;
|
|
|
|
void DrawButtonBarBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawButtonBarButton(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonButtonKind kind,
|
|
long state,
|
|
const wxString& label,
|
|
const wxBitmap& bitmap_large,
|
|
const wxBitmap& bitmap_small) wxOVERRIDE;
|
|
|
|
void DrawToolBarBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawToolGroupBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawTool(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
const wxBitmap& bitmap,
|
|
wxRibbonButtonKind kind,
|
|
long state) wxOVERRIDE;
|
|
|
|
void DrawToggleButton(
|
|
wxDC& dc,
|
|
wxRibbonBar* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonDisplayMode mode) wxOVERRIDE;
|
|
|
|
void DrawHelpButton(wxDC& dc,
|
|
wxRibbonBar* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void GetBarTabWidth(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxString& label,
|
|
const wxBitmap& bitmap,
|
|
int* ideal,
|
|
int* small_begin_need_separator,
|
|
int* small_must_have_separator,
|
|
int* minimum) wxOVERRIDE;
|
|
|
|
wxSize GetScrollButtonMinimumSize(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
long style) wxOVERRIDE;
|
|
|
|
wxSize GetPanelSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize client_size,
|
|
wxPoint* client_offset) wxOVERRIDE;
|
|
|
|
wxSize GetPanelClientSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize size,
|
|
wxPoint* client_offset) wxOVERRIDE;
|
|
|
|
wxRect GetPanelExtButtonArea(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxRect rect) wxOVERRIDE;
|
|
|
|
wxSize GetGallerySize(
|
|
wxDC& dc,
|
|
const wxRibbonGallery* wnd,
|
|
wxSize client_size) wxOVERRIDE;
|
|
|
|
wxSize GetGalleryClientSize(
|
|
wxDC& dc,
|
|
const wxRibbonGallery* wnd,
|
|
wxSize size,
|
|
wxPoint* client_offset,
|
|
wxRect* scroll_up_button,
|
|
wxRect* scroll_down_button,
|
|
wxRect* extension_button) wxOVERRIDE;
|
|
|
|
wxRect GetPageBackgroundRedrawArea(
|
|
wxDC& dc,
|
|
const wxRibbonPage* wnd,
|
|
wxSize page_old_size,
|
|
wxSize page_new_size) wxOVERRIDE;
|
|
|
|
bool GetButtonBarButtonSize(
|
|
wxDC& 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) wxOVERRIDE;
|
|
|
|
wxCoord GetButtonBarButtonTextWidth(
|
|
wxDC& dc, const wxString& label,
|
|
wxRibbonButtonKind kind,
|
|
wxRibbonButtonBarButtonState size) wxOVERRIDE;
|
|
|
|
wxSize GetMinimisedPanelMinimumSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize* desired_bitmap_size,
|
|
wxDirection* expanded_panel_direction) wxOVERRIDE;
|
|
|
|
wxSize GetToolSize(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
wxSize bitmap_size,
|
|
wxRibbonButtonKind kind,
|
|
bool is_first,
|
|
bool is_last,
|
|
wxRect* dropdown_region) wxOVERRIDE;
|
|
|
|
wxRect GetBarToggleButtonArea(const wxRect& rect) wxOVERRIDE;
|
|
|
|
wxRect GetRibbonHelpButtonArea(const wxRect& rect) wxOVERRIDE;
|
|
|
|
protected:
|
|
void ReallyDrawTabSeparator(wxWindow* wnd, const wxRect& rect, double visibility);
|
|
void DrawPartialPageBackground(wxDC& dc, wxWindow* wnd, const wxRect& rect,
|
|
bool allow_hovered = true);
|
|
void DrawPartialPageBackground(wxDC& dc, wxWindow* wnd, const wxRect& rect,
|
|
wxRibbonPage* page, wxPoint offset, bool hovered = false);
|
|
void DrawPanelBorder(wxDC& dc, const wxRect& rect, wxPen& primary_colour,
|
|
wxPen& secondary_colour);
|
|
void RemovePanelPadding(wxRect* rect);
|
|
void DrawDropdownArrow(wxDC& dc, int x, int y, const wxColour& colour);
|
|
void DrawGalleryBackgroundCommon(wxDC& dc, wxRibbonGallery* wnd,
|
|
const wxRect& rect);
|
|
virtual void DrawGalleryButton(wxDC& dc, wxRect rect,
|
|
wxRibbonGalleryButtonState state, wxBitmap* bitmaps);
|
|
void DrawButtonBarButtonForeground(
|
|
wxDC& dc,
|
|
const wxRect& rect,
|
|
wxRibbonButtonKind kind,
|
|
long state,
|
|
const wxString& label,
|
|
const wxBitmap& bitmap_large,
|
|
const wxBitmap& bitmap_small);
|
|
void DrawMinimisedPanelCommon(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect,
|
|
wxRect* preview_rect);
|
|
void CloneTo(wxRibbonMSWArtProvider* copy) const;
|
|
|
|
wxBitmap m_cached_tab_separator;
|
|
wxBitmap m_gallery_up_bitmap[4];
|
|
wxBitmap m_gallery_down_bitmap[4];
|
|
wxBitmap m_gallery_extension_bitmap[4];
|
|
wxBitmap m_toolbar_drop_bitmap;
|
|
wxBitmap m_panel_extension_bitmap[2];
|
|
wxBitmap m_ribbon_toggle_up_bitmap[2];
|
|
wxBitmap m_ribbon_toggle_down_bitmap[2];
|
|
wxBitmap m_ribbon_toggle_pin_bitmap[2];
|
|
wxBitmap m_ribbon_bar_help_button_bitmap[2];
|
|
|
|
wxColour m_primary_scheme_colour;
|
|
wxColour m_secondary_scheme_colour;
|
|
wxColour m_tertiary_scheme_colour;
|
|
|
|
wxColour m_button_bar_label_colour;
|
|
wxColour m_button_bar_label_disabled_colour;
|
|
wxColour m_tab_label_colour;
|
|
wxColour m_tab_active_label_colour;
|
|
wxColour m_tab_hover_label_colour;
|
|
wxColour m_tab_separator_colour;
|
|
wxColour m_tab_separator_gradient_colour;
|
|
wxColour m_tab_active_background_colour;
|
|
wxColour m_tab_active_background_gradient_colour;
|
|
wxColour m_tab_hover_background_colour;
|
|
wxColour m_tab_hover_background_gradient_colour;
|
|
wxColour m_tab_hover_background_top_colour;
|
|
wxColour m_tab_hover_background_top_gradient_colour;
|
|
wxColour m_tab_highlight_top_colour;
|
|
wxColour m_tab_highlight_top_gradient_colour;
|
|
wxColour m_tab_highlight_colour;
|
|
wxColour m_tab_highlight_gradient_colour;
|
|
wxColour m_panel_label_colour;
|
|
wxColour m_panel_minimised_label_colour;
|
|
wxColour m_panel_hover_label_colour;
|
|
wxColour m_panel_active_background_colour;
|
|
wxColour m_panel_active_background_gradient_colour;
|
|
wxColour m_panel_active_background_top_colour;
|
|
wxColour m_panel_active_background_top_gradient_colour;
|
|
wxColour m_panel_button_face_colour;
|
|
wxColour m_panel_button_hover_face_colour;
|
|
wxColour m_page_toggle_face_colour;
|
|
wxColour m_page_toggle_hover_face_colour;
|
|
wxColour m_page_background_colour;
|
|
wxColour m_page_background_gradient_colour;
|
|
wxColour m_page_background_top_colour;
|
|
wxColour m_page_background_top_gradient_colour;
|
|
wxColour m_page_hover_background_colour;
|
|
wxColour m_page_hover_background_gradient_colour;
|
|
wxColour m_page_hover_background_top_colour;
|
|
wxColour m_page_hover_background_top_gradient_colour;
|
|
wxColour m_button_bar_hover_background_colour;
|
|
wxColour m_button_bar_hover_background_gradient_colour;
|
|
wxColour m_button_bar_hover_background_top_colour;
|
|
wxColour m_button_bar_hover_background_top_gradient_colour;
|
|
wxColour m_button_bar_active_background_colour;
|
|
wxColour m_button_bar_active_background_gradient_colour;
|
|
wxColour m_button_bar_active_background_top_colour;
|
|
wxColour m_button_bar_active_background_top_gradient_colour;
|
|
wxColour m_gallery_button_background_colour;
|
|
wxColour m_gallery_button_background_gradient_colour;
|
|
wxColour m_gallery_button_hover_background_colour;
|
|
wxColour m_gallery_button_hover_background_gradient_colour;
|
|
wxColour m_gallery_button_active_background_colour;
|
|
wxColour m_gallery_button_active_background_gradient_colour;
|
|
wxColour m_gallery_button_disabled_background_colour;
|
|
wxColour m_gallery_button_disabled_background_gradient_colour;
|
|
wxColour m_gallery_button_face_colour;
|
|
wxColour m_gallery_button_hover_face_colour;
|
|
wxColour m_gallery_button_active_face_colour;
|
|
wxColour m_gallery_button_disabled_face_colour;
|
|
|
|
wxColour m_tool_face_colour;
|
|
wxColour m_tool_background_top_colour;
|
|
wxColour m_tool_background_top_gradient_colour;
|
|
wxColour m_tool_background_colour;
|
|
wxColour m_tool_background_gradient_colour;
|
|
wxColour m_tool_hover_background_top_colour;
|
|
wxColour m_tool_hover_background_top_gradient_colour;
|
|
wxColour m_tool_hover_background_colour;
|
|
wxColour m_tool_hover_background_gradient_colour;
|
|
wxColour m_tool_active_background_top_colour;
|
|
wxColour m_tool_active_background_top_gradient_colour;
|
|
wxColour m_tool_active_background_colour;
|
|
wxColour m_tool_active_background_gradient_colour;
|
|
|
|
wxBrush m_tab_ctrl_background_brush;
|
|
wxBrush m_panel_label_background_brush;
|
|
wxBrush m_panel_hover_label_background_brush;
|
|
wxBrush m_panel_hover_button_background_brush;
|
|
wxBrush m_gallery_hover_background_brush;
|
|
wxBrush m_gallery_button_background_top_brush;
|
|
wxBrush m_gallery_button_hover_background_top_brush;
|
|
wxBrush m_gallery_button_active_background_top_brush;
|
|
wxBrush m_gallery_button_disabled_background_top_brush;
|
|
wxBrush m_ribbon_toggle_brush;
|
|
|
|
wxFont m_tab_label_font;
|
|
wxFont m_panel_label_font;
|
|
wxFont m_button_bar_label_font;
|
|
|
|
wxPen m_page_border_pen;
|
|
wxPen m_panel_border_pen;
|
|
wxPen m_panel_border_gradient_pen;
|
|
wxPen m_panel_minimised_border_pen;
|
|
wxPen m_panel_minimised_border_gradient_pen;
|
|
wxPen m_panel_hover_button_border_pen;
|
|
wxPen m_tab_border_pen;
|
|
wxPen m_button_bar_hover_border_pen;
|
|
wxPen m_button_bar_active_border_pen;
|
|
wxPen m_gallery_border_pen;
|
|
wxPen m_gallery_item_border_pen;
|
|
wxPen m_toolbar_border_pen;
|
|
wxPen m_ribbon_toggle_pen;
|
|
|
|
double m_cached_tab_separator_visibility;
|
|
long m_flags;
|
|
|
|
int m_tab_separation_size;
|
|
int m_page_border_left;
|
|
int m_page_border_top;
|
|
int m_page_border_right;
|
|
int m_page_border_bottom;
|
|
int m_panel_x_separation_size;
|
|
int m_panel_y_separation_size;
|
|
int m_tool_group_separation_size;
|
|
int m_gallery_bitmap_padding_left_size;
|
|
int m_gallery_bitmap_padding_right_size;
|
|
int m_gallery_bitmap_padding_top_size;
|
|
int m_gallery_bitmap_padding_bottom_size;
|
|
int m_toggle_button_offset;
|
|
int m_help_button_offset;
|
|
};
|
|
|
|
class WXDLLIMPEXP_RIBBON wxRibbonAUIArtProvider : public wxRibbonMSWArtProvider
|
|
{
|
|
public:
|
|
wxRibbonAUIArtProvider();
|
|
virtual ~wxRibbonAUIArtProvider();
|
|
|
|
wxRibbonArtProvider* Clone() const wxOVERRIDE;
|
|
|
|
wxColour GetColour(int id) const wxOVERRIDE;
|
|
void SetColour(int id, const wxColor& colour) wxOVERRIDE;
|
|
void SetColourScheme(const wxColour& primary,
|
|
const wxColour& secondary,
|
|
const wxColour& tertiary) wxOVERRIDE;
|
|
void SetFont(int id, const wxFont& font) wxOVERRIDE;
|
|
|
|
wxSize GetScrollButtonMinimumSize(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
long style) wxOVERRIDE;
|
|
|
|
void DrawScrollButton(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
long style) wxOVERRIDE;
|
|
|
|
wxSize GetPanelSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize client_size,
|
|
wxPoint* client_offset) wxOVERRIDE;
|
|
|
|
wxSize GetPanelClientSize(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxSize size,
|
|
wxPoint* client_offset) wxOVERRIDE;
|
|
|
|
wxRect GetPanelExtButtonArea(
|
|
wxDC& dc,
|
|
const wxRibbonPanel* wnd,
|
|
wxRect rect) wxOVERRIDE;
|
|
|
|
void DrawTabCtrlBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
int GetTabCtrlHeight(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRibbonPageTabInfoArray& pages) wxOVERRIDE;
|
|
|
|
void GetBarTabWidth(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxString& label,
|
|
const wxBitmap& bitmap,
|
|
int* ideal,
|
|
int* small_begin_need_separator,
|
|
int* small_must_have_separator,
|
|
int* minimum) wxOVERRIDE;
|
|
|
|
void DrawTab(wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRibbonPageTabInfo& tab) wxOVERRIDE;
|
|
|
|
void DrawTabSeparator(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
double visibility) wxOVERRIDE;
|
|
|
|
void DrawPageBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawPanelBackground(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawMinimisedPanel(
|
|
wxDC& dc,
|
|
wxRibbonPanel* wnd,
|
|
const wxRect& rect,
|
|
wxBitmap& bitmap) wxOVERRIDE;
|
|
|
|
void DrawGalleryBackground(
|
|
wxDC& dc,
|
|
wxRibbonGallery* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawGalleryItemBackground(
|
|
wxDC& dc,
|
|
wxRibbonGallery* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonGalleryItem* item) wxOVERRIDE;
|
|
|
|
void DrawButtonBarBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawButtonBarButton(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
wxRibbonButtonKind kind,
|
|
long state,
|
|
const wxString& label,
|
|
const wxBitmap& bitmap_large,
|
|
const wxBitmap& bitmap_small) wxOVERRIDE;
|
|
|
|
void DrawToolBarBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawToolGroupBackground(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect) wxOVERRIDE;
|
|
|
|
void DrawTool(
|
|
wxDC& dc,
|
|
wxWindow* wnd,
|
|
const wxRect& rect,
|
|
const wxBitmap& bitmap,
|
|
wxRibbonButtonKind kind,
|
|
long state) wxOVERRIDE;
|
|
|
|
protected:
|
|
void DrawPartialPanelBackground(wxDC& dc, wxWindow* wnd,
|
|
const wxRect& rect);
|
|
void DrawGalleryButton(wxDC& dc, wxRect rect,
|
|
wxRibbonGalleryButtonState state, wxBitmap* bitmaps) wxOVERRIDE;
|
|
|
|
wxColour m_tab_ctrl_background_colour;
|
|
wxColour m_tab_ctrl_background_gradient_colour;
|
|
wxColour m_panel_label_background_colour;
|
|
wxColour m_panel_label_background_gradient_colour;
|
|
wxColour m_panel_hover_label_background_colour;
|
|
wxColour m_panel_hover_label_background_gradient_colour;
|
|
|
|
wxBrush m_background_brush;
|
|
wxBrush m_tab_active_top_background_brush;
|
|
wxBrush m_tab_hover_background_brush;
|
|
wxBrush m_button_bar_hover_background_brush;
|
|
wxBrush m_button_bar_active_background_brush;
|
|
wxBrush m_gallery_button_active_background_brush;
|
|
wxBrush m_gallery_button_hover_background_brush;
|
|
wxBrush m_gallery_button_disabled_background_brush;
|
|
wxBrush m_tool_hover_background_brush;
|
|
wxBrush m_tool_active_background_brush;
|
|
|
|
wxPen m_toolbar_hover_borden_pen;
|
|
|
|
wxFont m_tab_active_label_font;
|
|
};
|
|
|
|
#if defined(__WXMSW__)
|
|
typedef wxRibbonMSWArtProvider wxRibbonDefaultArtProvider;
|
|
#elif defined(__WXOSX_COCOA__) || \
|
|
defined(__WXOSX_IPHONE__)
|
|
// TODO: Once implemented, change typedef to OSX
|
|
// typedef wxRibbonOSXArtProvider wxRibbonDefaultArtProvider;
|
|
typedef wxRibbonAUIArtProvider wxRibbonDefaultArtProvider;
|
|
#else
|
|
// TODO: Once implemented, change typedef to AUI
|
|
typedef wxRibbonAUIArtProvider wxRibbonDefaultArtProvider;
|
|
#endif
|
|
|
|
#endif // wxUSE_RIBBON
|
|
|
|
#endif // _WX_RIBBON_ART_H_
|