1//---------------------------------------------------------------------------
2// This file is generated by wxPython's SIP generator.  Do not edit by hand.
3//
4// Copyright: (c) 2018 by Total Control Software
5// License:   wxWindows License
6//
7// This file will be included by _ribbon.sip
8//
9//---------------------------------------------------------------------------
10
11//---------------------------------------------------------------------------
12
13enum wxRibbonArtSetting
14{
15    wxRIBBON_ART_TAB_SEPARATION_SIZE,
16    wxRIBBON_ART_PAGE_BORDER_LEFT_SIZE,
17    wxRIBBON_ART_PAGE_BORDER_TOP_SIZE,
18    wxRIBBON_ART_PAGE_BORDER_RIGHT_SIZE,
19    wxRIBBON_ART_PAGE_BORDER_BOTTOM_SIZE,
20    wxRIBBON_ART_PANEL_X_SEPARATION_SIZE,
21    wxRIBBON_ART_PANEL_Y_SEPARATION_SIZE,
22    wxRIBBON_ART_TOOL_GROUP_SEPARATION_SIZE,
23    wxRIBBON_ART_GALLERY_BITMAP_PADDING_LEFT_SIZE,
24    wxRIBBON_ART_GALLERY_BITMAP_PADDING_RIGHT_SIZE,
25    wxRIBBON_ART_GALLERY_BITMAP_PADDING_TOP_SIZE,
26    wxRIBBON_ART_GALLERY_BITMAP_PADDING_BOTTOM_SIZE,
27    wxRIBBON_ART_PANEL_LABEL_FONT,
28    wxRIBBON_ART_BUTTON_BAR_LABEL_FONT,
29    wxRIBBON_ART_TAB_LABEL_FONT,
30    wxRIBBON_ART_BUTTON_BAR_LABEL_COLOUR,
31    wxRIBBON_ART_BUTTON_BAR_LABEL_DISABLED_COLOUR,
32    wxRIBBON_ART_BUTTON_BAR_HOVER_BORDER_COLOUR,
33    wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_COLOUR,
34    wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
35    wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_COLOUR,
36    wxRIBBON_ART_BUTTON_BAR_HOVER_BACKGROUND_GRADIENT_COLOUR,
37    wxRIBBON_ART_BUTTON_BAR_ACTIVE_BORDER_COLOUR,
38    wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_COLOUR,
39    wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
40    wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_COLOUR,
41    wxRIBBON_ART_BUTTON_BAR_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
42    wxRIBBON_ART_GALLERY_BORDER_COLOUR,
43    wxRIBBON_ART_GALLERY_HOVER_BACKGROUND_COLOUR,
44    wxRIBBON_ART_GALLERY_BUTTON_BACKGROUND_COLOUR,
45    wxRIBBON_ART_GALLERY_BUTTON_BACKGROUND_GRADIENT_COLOUR,
46    wxRIBBON_ART_GALLERY_BUTTON_BACKGROUND_TOP_COLOUR,
47    wxRIBBON_ART_GALLERY_BUTTON_FACE_COLOUR,
48    wxRIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_COLOUR,
49    wxRIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_GRADIENT_COLOUR,
50    wxRIBBON_ART_GALLERY_BUTTON_HOVER_BACKGROUND_TOP_COLOUR,
51    wxRIBBON_ART_GALLERY_BUTTON_HOVER_FACE_COLOUR,
52    wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_COLOUR,
53    wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
54    wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_BACKGROUND_TOP_COLOUR,
55    wxRIBBON_ART_GALLERY_BUTTON_ACTIVE_FACE_COLOUR,
56    wxRIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_COLOUR,
57    wxRIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_GRADIENT_COLOUR,
58    wxRIBBON_ART_GALLERY_BUTTON_DISABLED_BACKGROUND_TOP_COLOUR,
59    wxRIBBON_ART_GALLERY_BUTTON_DISABLED_FACE_COLOUR,
60    wxRIBBON_ART_GALLERY_ITEM_BORDER_COLOUR,
61    wxRIBBON_ART_TAB_LABEL_COLOUR,
62    wxRIBBON_ART_TAB_SEPARATOR_COLOUR,
63    wxRIBBON_ART_TAB_SEPARATOR_GRADIENT_COLOUR,
64    wxRIBBON_ART_TAB_CTRL_BACKGROUND_COLOUR,
65    wxRIBBON_ART_TAB_CTRL_BACKGROUND_GRADIENT_COLOUR,
66    wxRIBBON_ART_TAB_HOVER_BACKGROUND_TOP_COLOUR,
67    wxRIBBON_ART_TAB_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
68    wxRIBBON_ART_TAB_HOVER_BACKGROUND_COLOUR,
69    wxRIBBON_ART_TAB_HOVER_BACKGROUND_GRADIENT_COLOUR,
70    wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_COLOUR,
71    wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
72    wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_COLOUR,
73    wxRIBBON_ART_TAB_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
74    wxRIBBON_ART_TAB_BORDER_COLOUR,
75    wxRIBBON_ART_PANEL_BORDER_COLOUR,
76    wxRIBBON_ART_PANEL_BORDER_GRADIENT_COLOUR,
77    wxRIBBON_ART_PANEL_MINIMISED_BORDER_COLOUR,
78    wxRIBBON_ART_PANEL_MINIMISED_BORDER_GRADIENT_COLOUR,
79    wxRIBBON_ART_PANEL_LABEL_BACKGROUND_COLOUR,
80    wxRIBBON_ART_PANEL_LABEL_BACKGROUND_GRADIENT_COLOUR,
81    wxRIBBON_ART_PANEL_LABEL_COLOUR,
82    wxRIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_COLOUR,
83    wxRIBBON_ART_PANEL_HOVER_LABEL_BACKGROUND_GRADIENT_COLOUR,
84    wxRIBBON_ART_PANEL_HOVER_LABEL_COLOUR,
85    wxRIBBON_ART_PANEL_MINIMISED_LABEL_COLOUR,
86    wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_COLOUR,
87    wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
88    wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_COLOUR,
89    wxRIBBON_ART_PANEL_ACTIVE_BACKGROUND_GRADIENT_COLOUR,
90    wxRIBBON_ART_PAGE_BORDER_COLOUR,
91    wxRIBBON_ART_PAGE_BACKGROUND_TOP_COLOUR,
92    wxRIBBON_ART_PAGE_BACKGROUND_TOP_GRADIENT_COLOUR,
93    wxRIBBON_ART_PAGE_BACKGROUND_COLOUR,
94    wxRIBBON_ART_PAGE_BACKGROUND_GRADIENT_COLOUR,
95    wxRIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_COLOUR,
96    wxRIBBON_ART_PAGE_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
97    wxRIBBON_ART_PAGE_HOVER_BACKGROUND_COLOUR,
98    wxRIBBON_ART_PAGE_HOVER_BACKGROUND_GRADIENT_COLOUR,
99    wxRIBBON_ART_TOOLBAR_BORDER_COLOUR,
100    wxRIBBON_ART_TOOLBAR_HOVER_BORDER_COLOUR,
101    wxRIBBON_ART_TOOLBAR_FACE_COLOUR,
102    wxRIBBON_ART_TOOL_BACKGROUND_TOP_COLOUR,
103    wxRIBBON_ART_TOOL_BACKGROUND_TOP_GRADIENT_COLOUR,
104    wxRIBBON_ART_TOOL_BACKGROUND_COLOUR,
105    wxRIBBON_ART_TOOL_BACKGROUND_GRADIENT_COLOUR,
106    wxRIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_COLOUR,
107    wxRIBBON_ART_TOOL_HOVER_BACKGROUND_TOP_GRADIENT_COLOUR,
108    wxRIBBON_ART_TOOL_HOVER_BACKGROUND_COLOUR,
109    wxRIBBON_ART_TOOL_HOVER_BACKGROUND_GRADIENT_COLOUR,
110    wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_COLOUR,
111    wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_TOP_GRADIENT_COLOUR,
112    wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_COLOUR,
113    wxRIBBON_ART_TOOL_ACTIVE_BACKGROUND_GRADIENT_COLOUR
114};
115
116enum wxRibbonScrollButtonStyle
117{
118    wxRIBBON_SCROLL_BTN_LEFT,
119    wxRIBBON_SCROLL_BTN_RIGHT,
120    wxRIBBON_SCROLL_BTN_UP,
121    wxRIBBON_SCROLL_BTN_DOWN,
122    wxRIBBON_SCROLL_BTN_DIRECTION_MASK,
123    wxRIBBON_SCROLL_BTN_NORMAL,
124    wxRIBBON_SCROLL_BTN_HOVERED,
125    wxRIBBON_SCROLL_BTN_ACTIVE,
126    wxRIBBON_SCROLL_BTN_STATE_MASK,
127    wxRIBBON_SCROLL_BTN_FOR_OTHER,
128    wxRIBBON_SCROLL_BTN_FOR_TABS,
129    wxRIBBON_SCROLL_BTN_FOR_PAGE,
130    wxRIBBON_SCROLL_BTN_FOR_MASK
131};
132
133enum wxRibbonButtonKind
134{
135    wxRIBBON_BUTTON_NORMAL,
136    wxRIBBON_BUTTON_DROPDOWN,
137    wxRIBBON_BUTTON_HYBRID,
138    wxRIBBON_BUTTON_TOGGLE
139};
140
141class wxRibbonArtProvider
142{
143    %Docstring
144        RibbonArtProvider()
145
146        wxRibbonArtProvider is responsible for drawing all the components of
147        the ribbon interface.
148    %End
149    %TypeHeaderCode
150        #include <wx/ribbon/art.h>
151    %End
152
153public:
154    wxRibbonArtProvider();
155
156    virtual
157    ~wxRibbonArtProvider();
158
159    virtual
160    wxRibbonArtProvider * Clone() const = 0   /Factory/;
161    %Docstring
162        Clone() -> RibbonArtProvider
163
164        Create a new art provider which is a clone of this one.
165    %End
166
167    virtual
168    void SetFlags(
169        long flags
170    ) = 0;
171    %Docstring
172        SetFlags(flags)
173
174        Set the style flags.
175    %End
176
177    virtual
178    long GetFlags() const = 0;
179    %Docstring
180        GetFlags() -> long
181
182        Get the previously set style flags.
183    %End
184
185    virtual
186    int GetMetric(
187        int id
188    ) const = 0;
189    %Docstring
190        GetMetric(id) -> int
191
192        Get the value of a certain integer setting.
193    %End
194
195    virtual
196    void SetMetric(
197        int id,
198        int new_val
199    ) = 0;
200    %Docstring
201        SetMetric(id, new_val)
202
203        Set the value of a certain integer setting to the value new_val.
204    %End
205
206    virtual
207    void SetFont(
208        int id,
209        const wxFont & font
210    ) = 0;
211    %Docstring
212        SetFont(id, font)
213
214        Set the value of a certain font setting to the value font.
215    %End
216
217    virtual
218    wxFont GetFont(
219        int id
220    ) const = 0;
221    %Docstring
222        GetFont(id) -> wx.Font
223
224        Get the value of a certain font setting.
225    %End
226
227    virtual
228    wxColour GetColour(
229        int id
230    ) const = 0;
231    %Docstring
232        GetColour(id) -> wx.Colour
233
234        Get the value of a certain colour setting.
235    %End
236
237    virtual
238    void SetColour(
239        int id,
240        const wxColour & colour
241    ) = 0;
242    %Docstring
243        SetColour(id, colour)
244
245        Set the value of a certain colour setting to the value colour.
246    %End
247
248    wxColour GetColor(
249        int id
250    ) const;
251    %Docstring
252        GetColor(id) -> wx.Colour
253    %End
254
255    void SetColor(
256        int id,
257        const wxColour & color
258    );
259    %Docstring
260        SetColor(id, color)
261    %End
262
263    virtual
264    void GetColourScheme(
265        wxColour * primary   /Out/,
266        wxColour * secondary   /Out/,
267        wxColour * tertiary   /Out/
268    ) const = 0;
269    %Docstring
270        GetColourScheme() -> (primary, secondary, tertiary)
271
272        Get the current colour scheme.
273    %End
274
275    virtual
276    void SetColourScheme(
277        const wxColour & primary,
278        const wxColour & secondary,
279        const wxColour & tertiary
280    ) = 0;
281    %Docstring
282        SetColourScheme(primary, secondary, tertiary)
283
284        Set all applicable colour settings from a few base colours.
285    %End
286
287    virtual
288    void DrawTabCtrlBackground(
289        wxDC & dc,
290        wxWindow * wnd,
291        const wxRect & rect
292    ) = 0;
293    %Docstring
294        DrawTabCtrlBackground(dc, wnd, rect)
295
296        Draw the background of the tab region of a ribbon bar.
297    %End
298
299    virtual
300    void DrawTab(
301        wxDC & dc,
302        wxWindow * wnd,
303        const wxRibbonPageTabInfo & tab
304    ) = 0;
305    %Docstring
306        DrawTab(dc, wnd, tab)
307
308        Draw a single tab in the tab region of a ribbon bar.
309    %End
310
311    virtual
312    void DrawTabSeparator(
313        wxDC & dc,
314        wxWindow * wnd,
315        const wxRect & rect,
316        double visibility
317    ) = 0;
318    %Docstring
319        DrawTabSeparator(dc, wnd, rect, visibility)
320
321        Draw a separator between two tabs in a ribbon bar.
322    %End
323
324    virtual
325    void DrawPageBackground(
326        wxDC & dc,
327        wxWindow * wnd,
328        const wxRect & rect
329    ) = 0;
330    %Docstring
331        DrawPageBackground(dc, wnd, rect)
332
333        Draw the background of a ribbon page.
334    %End
335
336    virtual
337    void DrawScrollButton(
338        wxDC & dc,
339        wxWindow * wnd,
340        const wxRect & rect,
341        long style
342    ) = 0;
343    %Docstring
344        DrawScrollButton(dc, wnd, rect, style)
345
346        Draw a ribbon-style scroll button.
347    %End
348
349    virtual
350    void DrawPanelBackground(
351        wxDC & dc,
352        wxRibbonPanel * wnd,
353        const wxRect & rect
354    ) = 0;
355    %Docstring
356        DrawPanelBackground(dc, wnd, rect)
357
358        Draw the background and chrome for a ribbon panel.
359    %End
360
361    virtual
362    void DrawGalleryBackground(
363        wxDC & dc,
364        wxRibbonGallery * wnd,
365        const wxRect & rect
366    ) = 0;
367    %Docstring
368        DrawGalleryBackground(dc, wnd, rect)
369
370        Draw the background and chrome for a wxRibbonGallery control.
371    %End
372
373    virtual
374    void DrawGalleryItemBackground(
375        wxDC & dc,
376        wxRibbonGallery * wnd,
377        const wxRect & rect,
378        wxRibbonGalleryItem * item
379    ) = 0;
380    %Docstring
381        DrawGalleryItemBackground(dc, wnd, rect, item)
382
383        Draw the background of a single item in a wxRibbonGallery control.
384    %End
385
386    virtual
387    void DrawMinimisedPanel(
388        wxDC & dc,
389        wxRibbonPanel * wnd,
390        const wxRect & rect,
391        wxBitmap & bitmap
392    ) = 0;
393    %Docstring
394        DrawMinimisedPanel(dc, wnd, rect, bitmap)
395
396        Draw a minimised ribbon panel.
397    %End
398
399    virtual
400    void DrawButtonBarBackground(
401        wxDC & dc,
402        wxWindow * wnd,
403        const wxRect & rect
404    ) = 0;
405    %Docstring
406        DrawButtonBarBackground(dc, wnd, rect)
407
408        Draw the background for a wxRibbonButtonBar control.
409    %End
410
411    virtual
412    void DrawButtonBarButton(
413        wxDC & dc,
414        wxWindow * wnd,
415        const wxRect & rect,
416        wxRibbonButtonKind kind,
417        long state,
418        const wxString & label,
419        const wxBitmap & bitmap_large,
420        const wxBitmap & bitmap_small
421    ) = 0;
422    %Docstring
423        DrawButtonBarButton(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small)
424
425        Draw a single button for a wxRibbonButtonBar control.
426    %End
427
428    virtual
429    void DrawToolBarBackground(
430        wxDC & dc,
431        wxWindow * wnd,
432        const wxRect & rect
433    ) = 0;
434    %Docstring
435        DrawToolBarBackground(dc, wnd, rect)
436
437        Draw the background for a wxRibbonToolBar control.
438    %End
439
440    virtual
441    void DrawToolGroupBackground(
442        wxDC & dc,
443        wxWindow * wnd,
444        const wxRect & rect
445    ) = 0;
446    %Docstring
447        DrawToolGroupBackground(dc, wnd, rect)
448
449        Draw the background for a group of tools on a wxRibbonToolBar control.
450    %End
451
452    virtual
453    void DrawTool(
454        wxDC & dc,
455        wxWindow * wnd,
456        const wxRect & rect,
457        const wxBitmap & bitmap,
458        wxRibbonButtonKind kind,
459        long state
460    ) = 0;
461    %Docstring
462        DrawTool(dc, wnd, rect, bitmap, kind, state)
463
464        Draw a single tool (for a wxRibbonToolBar control).
465    %End
466
467    virtual
468    void DrawToggleButton(
469        wxDC & dc,
470        wxRibbonBar * wnd,
471        const wxRect & rect,
472        wxRibbonDisplayMode mode
473    ) = 0;
474    %Docstring
475        DrawToggleButton(dc, wnd, rect, mode)
476
477        Draw toggle button on wxRibbonBar.
478    %End
479
480    virtual
481    void DrawHelpButton(
482        wxDC & dc,
483        wxRibbonBar * wnd,
484        const wxRect & rect
485    ) = 0;
486    %Docstring
487        DrawHelpButton(dc, wnd, rect)
488
489        Draw help button on wxRibbonBar.
490    %End
491
492    virtual
493    void GetBarTabWidth(
494        wxDC & dc,
495        wxWindow * wnd,
496        const wxString & label,
497        const wxBitmap & bitmap,
498        int * ideal,
499        int * small_begin_need_separator,
500        int * small_must_have_separator,
501        int * minimum
502    ) = 0;
503    %Docstring
504        GetBarTabWidth(dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum)
505
506        Calculate the ideal and minimum width (in pixels) of a tab in a ribbon
507        bar.
508    %End
509
510    virtual
511    int GetTabCtrlHeight(
512        wxDC & dc,
513        wxWindow * wnd,
514        const wxRibbonPageTabInfoArray & pages
515    ) = 0;
516    %Docstring
517        GetTabCtrlHeight(dc, wnd, pages) -> int
518
519        Calculate the height (in pixels) of the tab region of a ribbon bar.
520    %End
521
522    virtual
523    wxSize GetScrollButtonMinimumSize(
524        wxDC & dc,
525        wxWindow * wnd,
526        long style
527    ) = 0;
528    %Docstring
529        GetScrollButtonMinimumSize(dc, wnd, style) -> wx.Size
530
531        Calculate the minimum size (in pixels) of a scroll button.
532    %End
533
534    virtual
535    wxSize GetPanelSize(
536        wxDC & dc,
537        const wxRibbonPanel * wnd,
538        wxSize client_size,
539        wxPoint * client_offset
540    ) = 0;
541    %Docstring
542        GetPanelSize(dc, wnd, client_size, client_offset) -> wx.Size
543
544        Calculate the size of a panel for a given client size.
545    %End
546
547    virtual
548    wxSize GetPanelClientSize(
549        wxDC & dc,
550        const wxRibbonPanel * wnd,
551        wxSize size,
552        wxPoint * client_offset
553    ) = 0;
554    %Docstring
555        GetPanelClientSize(dc, wnd, size, client_offset) -> wx.Size
556
557        Calculate the client size of a panel for a given overall size.
558    %End
559
560    virtual
561    wxRect GetPanelExtButtonArea(
562        wxDC & dc,
563        const wxRibbonPanel * wnd,
564        wxRect rect
565    ) = 0;
566    %Docstring
567        GetPanelExtButtonArea(dc, wnd, rect) -> wx.Rect
568
569        Calculate the position and size of the panel extension button.
570    %End
571
572    virtual
573    wxSize GetGallerySize(
574        wxDC & dc,
575        const wxRibbonGallery * wnd,
576        wxSize client_size
577    ) = 0;
578    %Docstring
579        GetGallerySize(dc, wnd, client_size) -> wx.Size
580
581        Calculate the size of a wxRibbonGallery control for a given client
582        size.
583    %End
584
585    virtual
586    wxSize GetGalleryClientSize(
587        wxDC & dc,
588        const wxRibbonGallery * wnd,
589        wxSize size,
590        wxPoint * client_offset,
591        wxRect * scroll_up_button,
592        wxRect * scroll_down_button,
593        wxRect * extension_button
594    ) = 0;
595    %Docstring
596        GetGalleryClientSize(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) -> wx.Size
597
598        Calculate the client size of a wxRibbonGallery control for a given
599        size.
600    %End
601
602    virtual
603    wxRect GetPageBackgroundRedrawArea(
604        wxDC & dc,
605        const wxRibbonPage * wnd,
606        wxSize page_old_size,
607        wxSize page_new_size
608    ) = 0;
609    %Docstring
610        GetPageBackgroundRedrawArea(dc, wnd, page_old_size, page_new_size) -> wx.Rect
611
612        Calculate the portion of a page background which needs to be redrawn
613        when a page is resized.
614    %End
615
616    virtual
617    bool GetButtonBarButtonSize(
618        wxDC & dc,
619        wxWindow * wnd,
620        wxRibbonButtonKind kind,
621        wxRibbonButtonBarButtonState size,
622        const wxString & label,
623        wxSize bitmap_size_large,
624        wxSize bitmap_size_small,
625        wxSize * button_size,
626        wxRect * normal_region,
627        wxRect * dropdown_region
628    ) = 0;
629    %Docstring
630        GetButtonBarButtonSize(dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) -> bool
631
632        Calculate the size of a button within a wxRibbonButtonBar.
633    %End
634
635    virtual
636    wxSize GetMinimisedPanelMinimumSize(
637        wxDC & dc,
638        const wxRibbonPanel * wnd,
639        wxSize * desired_bitmap_size,
640        wxDirection * expanded_panel_direction
641    ) = 0;
642    %Docstring
643        GetMinimisedPanelMinimumSize(dc, wnd, desired_bitmap_size, expanded_panel_direction) -> wx.Size
644
645        Calculate the size of a minimised ribbon panel.
646    %End
647
648    virtual
649    wxSize GetToolSize(
650        wxDC & dc,
651        wxWindow * wnd,
652        wxSize bitmap_size,
653        wxRibbonButtonKind kind,
654        bool is_first,
655        bool is_last,
656        wxRect * dropdown_region
657    ) = 0;
658    %Docstring
659        GetToolSize(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) -> wx.Size
660
661        Calculate the size of a tool within a wxRibbonToolBar.
662    %End
663
664    virtual
665    wxRect GetBarToggleButtonArea(
666        const wxRect & rect
667    ) = 0;
668    %Docstring
669        GetBarToggleButtonArea(rect) -> wx.Rect
670
671        Calculate the position and size of the ribbon's toggle button.
672    %End
673
674    virtual
675    wxRect GetRibbonHelpButtonArea(
676        const wxRect & rect
677    ) = 0;
678    %Docstring
679        GetRibbonHelpButtonArea(rect) -> wx.Rect
680
681        Calculate the position and size of the ribbon's help button.
682    %End
683
684    public:
685
686
687    %Property(name=Flags, get=GetFlags, set=SetFlags)
688};  // end of class wxRibbonArtProvider
689
690
691class wxRibbonMSWArtProvider : wxRibbonArtProvider
692{
693    %Docstring
694        RibbonMSWArtProvider(set_colour_scheme=True)
695    %End
696    %TypeHeaderCode
697        #include <wx/ribbon/art.h>
698    %End
699
700public:
701    wxRibbonMSWArtProvider(
702        bool set_colour_scheme = true
703    );
704
705    virtual
706    ~wxRibbonMSWArtProvider();
707
708    virtual
709    wxRibbonArtProvider * Clone() const   /Factory/;
710    %Docstring
711        Clone() -> RibbonArtProvider
712
713        Create a new art provider which is a clone of this one.
714    %End
715
716    virtual
717    void SetFlags(
718        long flags
719    );
720    %Docstring
721        SetFlags(flags)
722
723        Set the style flags.
724    %End
725
726    virtual
727    long GetFlags() const;
728    %Docstring
729        GetFlags() -> long
730
731        Get the previously set style flags.
732    %End
733
734    virtual
735    int GetMetric(
736        int id
737    ) const;
738    %Docstring
739        GetMetric(id) -> int
740
741        Get the value of a certain integer setting.
742    %End
743
744    virtual
745    void SetMetric(
746        int id,
747        int new_val
748    );
749    %Docstring
750        SetMetric(id, new_val)
751
752        Set the value of a certain integer setting to the value new_val.
753    %End
754
755    virtual
756    void SetFont(
757        int id,
758        const wxFont & font
759    );
760    %Docstring
761        SetFont(id, font)
762
763        Set the value of a certain font setting to the value font.
764    %End
765
766    virtual
767    wxFont GetFont(
768        int id
769    ) const;
770    %Docstring
771        GetFont(id) -> wx.Font
772
773        Get the value of a certain font setting.
774    %End
775
776    virtual
777    wxColour GetColour(
778        int id
779    ) const;
780    %Docstring
781        GetColour(id) -> wx.Colour
782
783        Get the value of a certain colour setting.
784    %End
785
786    virtual
787    void SetColour(
788        int id,
789        const wxColour & colour
790    );
791    %Docstring
792        SetColour(id, colour)
793
794        Set the value of a certain colour setting to the value colour.
795    %End
796
797    virtual
798    void GetColourScheme(
799        wxColour * primary   /Out/,
800        wxColour * secondary   /Out/,
801        wxColour * tertiary   /Out/
802    ) const;
803    %Docstring
804        GetColourScheme() -> (primary, secondary, tertiary)
805
806        Get the current colour scheme.
807    %End
808
809    virtual
810    void SetColourScheme(
811        const wxColour & primary,
812        const wxColour & secondary,
813        const wxColour & tertiary
814    );
815    %Docstring
816        SetColourScheme(primary, secondary, tertiary)
817
818        Set all applicable colour settings from a few base colours.
819    %End
820
821    virtual
822    int GetTabCtrlHeight(
823        wxDC & dc,
824        wxWindow * wnd,
825        const wxRibbonPageTabInfoArray & pages
826    );
827    %Docstring
828        GetTabCtrlHeight(dc, wnd, pages) -> int
829
830        Calculate the height (in pixels) of the tab region of a ribbon bar.
831    %End
832
833    virtual
834    void DrawTabCtrlBackground(
835        wxDC & dc,
836        wxWindow * wnd,
837        const wxRect & rect
838    );
839    %Docstring
840        DrawTabCtrlBackground(dc, wnd, rect)
841
842        Draw the background of the tab region of a ribbon bar.
843    %End
844
845    virtual
846    void DrawTab(
847        wxDC & dc,
848        wxWindow * wnd,
849        const wxRibbonPageTabInfo & tab
850    );
851    %Docstring
852        DrawTab(dc, wnd, tab)
853
854        Draw a single tab in the tab region of a ribbon bar.
855    %End
856
857    virtual
858    void DrawTabSeparator(
859        wxDC & dc,
860        wxWindow * wnd,
861        const wxRect & rect,
862        double visibility
863    );
864    %Docstring
865        DrawTabSeparator(dc, wnd, rect, visibility)
866
867        Draw a separator between two tabs in a ribbon bar.
868    %End
869
870    virtual
871    void DrawPageBackground(
872        wxDC & dc,
873        wxWindow * wnd,
874        const wxRect & rect
875    );
876    %Docstring
877        DrawPageBackground(dc, wnd, rect)
878
879        Draw the background of a ribbon page.
880    %End
881
882    virtual
883    void DrawScrollButton(
884        wxDC & dc,
885        wxWindow * wnd,
886        const wxRect & rect,
887        long style
888    );
889    %Docstring
890        DrawScrollButton(dc, wnd, rect, style)
891
892        Draw a ribbon-style scroll button.
893    %End
894
895    virtual
896    void DrawPanelBackground(
897        wxDC & dc,
898        wxRibbonPanel * wnd,
899        const wxRect & rect
900    );
901    %Docstring
902        DrawPanelBackground(dc, wnd, rect)
903
904        Draw the background and chrome for a ribbon panel.
905    %End
906
907    virtual
908    void DrawGalleryBackground(
909        wxDC & dc,
910        wxRibbonGallery * wnd,
911        const wxRect & rect
912    );
913    %Docstring
914        DrawGalleryBackground(dc, wnd, rect)
915
916        Draw the background and chrome for a wxRibbonGallery control.
917    %End
918
919    virtual
920    void DrawGalleryItemBackground(
921        wxDC & dc,
922        wxRibbonGallery * wnd,
923        const wxRect & rect,
924        wxRibbonGalleryItem * item
925    );
926    %Docstring
927        DrawGalleryItemBackground(dc, wnd, rect, item)
928
929        Draw the background of a single item in a wxRibbonGallery control.
930    %End
931
932    virtual
933    void DrawMinimisedPanel(
934        wxDC & dc,
935        wxRibbonPanel * wnd,
936        const wxRect & rect,
937        wxBitmap & bitmap
938    );
939    %Docstring
940        DrawMinimisedPanel(dc, wnd, rect, bitmap)
941
942        Draw a minimised ribbon panel.
943    %End
944
945    virtual
946    void DrawButtonBarBackground(
947        wxDC & dc,
948        wxWindow * wnd,
949        const wxRect & rect
950    );
951    %Docstring
952        DrawButtonBarBackground(dc, wnd, rect)
953
954        Draw the background for a wxRibbonButtonBar control.
955    %End
956
957    virtual
958    void DrawButtonBarButton(
959        wxDC & dc,
960        wxWindow * wnd,
961        const wxRect & rect,
962        wxRibbonButtonKind kind,
963        long state,
964        const wxString & label,
965        const wxBitmap & bitmap_large,
966        const wxBitmap & bitmap_small
967    );
968    %Docstring
969        DrawButtonBarButton(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small)
970
971        Draw a single button for a wxRibbonButtonBar control.
972    %End
973
974    virtual
975    void DrawToolBarBackground(
976        wxDC & dc,
977        wxWindow * wnd,
978        const wxRect & rect
979    );
980    %Docstring
981        DrawToolBarBackground(dc, wnd, rect)
982
983        Draw the background for a wxRibbonToolBar control.
984    %End
985
986    virtual
987    void DrawToolGroupBackground(
988        wxDC & dc,
989        wxWindow * wnd,
990        const wxRect & rect
991    );
992    %Docstring
993        DrawToolGroupBackground(dc, wnd, rect)
994
995        Draw the background for a group of tools on a wxRibbonToolBar control.
996    %End
997
998    virtual
999    void DrawTool(
1000        wxDC & dc,
1001        wxWindow * wnd,
1002        const wxRect & rect,
1003        const wxBitmap & bitmap,
1004        wxRibbonButtonKind kind,
1005        long state
1006    );
1007    %Docstring
1008        DrawTool(dc, wnd, rect, bitmap, kind, state)
1009
1010        Draw a single tool (for a wxRibbonToolBar control).
1011    %End
1012
1013    virtual
1014    void DrawToggleButton(
1015        wxDC & dc,
1016        wxRibbonBar * wnd,
1017        const wxRect & rect,
1018        wxRibbonDisplayMode mode
1019    );
1020    %Docstring
1021        DrawToggleButton(dc, wnd, rect, mode)
1022
1023        Draw toggle button on wxRibbonBar.
1024    %End
1025
1026    virtual
1027    void DrawHelpButton(
1028        wxDC & dc,
1029        wxRibbonBar * wnd,
1030        const wxRect & rect
1031    );
1032    %Docstring
1033        DrawHelpButton(dc, wnd, rect)
1034
1035        Draw help button on wxRibbonBar.
1036    %End
1037
1038    virtual
1039    void GetBarTabWidth(
1040        wxDC & dc,
1041        wxWindow * wnd,
1042        const wxString & label,
1043        const wxBitmap & bitmap,
1044        int * ideal,
1045        int * small_begin_need_separator,
1046        int * small_must_have_separator,
1047        int * minimum
1048    );
1049    %Docstring
1050        GetBarTabWidth(dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum)
1051
1052        Calculate the ideal and minimum width (in pixels) of a tab in a ribbon
1053        bar.
1054    %End
1055
1056    virtual
1057    wxSize GetScrollButtonMinimumSize(
1058        wxDC & dc,
1059        wxWindow * wnd,
1060        long style
1061    );
1062    %Docstring
1063        GetScrollButtonMinimumSize(dc, wnd, style) -> wx.Size
1064
1065        Calculate the minimum size (in pixels) of a scroll button.
1066    %End
1067
1068    virtual
1069    wxSize GetPanelSize(
1070        wxDC & dc,
1071        const wxRibbonPanel * wnd,
1072        wxSize client_size,
1073        wxPoint * client_offset
1074    );
1075    %Docstring
1076        GetPanelSize(dc, wnd, client_size, client_offset) -> wx.Size
1077
1078        Calculate the size of a panel for a given client size.
1079    %End
1080
1081    virtual
1082    wxSize GetPanelClientSize(
1083        wxDC & dc,
1084        const wxRibbonPanel * wnd,
1085        wxSize size,
1086        wxPoint * client_offset
1087    );
1088    %Docstring
1089        GetPanelClientSize(dc, wnd, size, client_offset) -> wx.Size
1090
1091        Calculate the client size of a panel for a given overall size.
1092    %End
1093
1094    virtual
1095    wxRect GetPanelExtButtonArea(
1096        wxDC & dc,
1097        const wxRibbonPanel * wnd,
1098        wxRect rect
1099    );
1100    %Docstring
1101        GetPanelExtButtonArea(dc, wnd, rect) -> wx.Rect
1102
1103        Calculate the position and size of the panel extension button.
1104    %End
1105
1106    virtual
1107    wxSize GetGallerySize(
1108        wxDC & dc,
1109        const wxRibbonGallery * wnd,
1110        wxSize client_size
1111    );
1112    %Docstring
1113        GetGallerySize(dc, wnd, client_size) -> wx.Size
1114
1115        Calculate the size of a wxRibbonGallery control for a given client
1116        size.
1117    %End
1118
1119    virtual
1120    wxSize GetGalleryClientSize(
1121        wxDC & dc,
1122        const wxRibbonGallery * wnd,
1123        wxSize size,
1124        wxPoint * client_offset,
1125        wxRect * scroll_up_button,
1126        wxRect * scroll_down_button,
1127        wxRect * extension_button
1128    );
1129    %Docstring
1130        GetGalleryClientSize(dc, wnd, size, client_offset, scroll_up_button, scroll_down_button, extension_button) -> wx.Size
1131
1132        Calculate the client size of a wxRibbonGallery control for a given
1133        size.
1134    %End
1135
1136    virtual
1137    wxRect GetPageBackgroundRedrawArea(
1138        wxDC & dc,
1139        const wxRibbonPage * wnd,
1140        wxSize page_old_size,
1141        wxSize page_new_size
1142    );
1143    %Docstring
1144        GetPageBackgroundRedrawArea(dc, wnd, page_old_size, page_new_size) -> wx.Rect
1145
1146        Calculate the portion of a page background which needs to be redrawn
1147        when a page is resized.
1148    %End
1149
1150    virtual
1151    bool GetButtonBarButtonSize(
1152        wxDC & dc,
1153        wxWindow * wnd,
1154        wxRibbonButtonKind kind,
1155        wxRibbonButtonBarButtonState size,
1156        const wxString & label,
1157        wxSize bitmap_size_large,
1158        wxSize bitmap_size_small,
1159        wxSize * button_size,
1160        wxRect * normal_region,
1161        wxRect * dropdown_region
1162    );
1163    %Docstring
1164        GetButtonBarButtonSize(dc, wnd, kind, size, label, bitmap_size_large, bitmap_size_small, button_size, normal_region, dropdown_region) -> bool
1165
1166        Calculate the size of a button within a wxRibbonButtonBar.
1167    %End
1168
1169    virtual
1170    wxSize GetMinimisedPanelMinimumSize(
1171        wxDC & dc,
1172        const wxRibbonPanel * wnd,
1173        wxSize * desired_bitmap_size,
1174        wxDirection * expanded_panel_direction
1175    );
1176    %Docstring
1177        GetMinimisedPanelMinimumSize(dc, wnd, desired_bitmap_size, expanded_panel_direction) -> wx.Size
1178
1179        Calculate the size of a minimised ribbon panel.
1180    %End
1181
1182    virtual
1183    wxSize GetToolSize(
1184        wxDC & dc,
1185        wxWindow * wnd,
1186        wxSize bitmap_size,
1187        wxRibbonButtonKind kind,
1188        bool is_first,
1189        bool is_last,
1190        wxRect * dropdown_region
1191    );
1192    %Docstring
1193        GetToolSize(dc, wnd, bitmap_size, kind, is_first, is_last, dropdown_region) -> wx.Size
1194
1195        Calculate the size of a tool within a wxRibbonToolBar.
1196    %End
1197
1198    virtual
1199    wxRect GetBarToggleButtonArea(
1200        const wxRect & rect
1201    );
1202    %Docstring
1203        GetBarToggleButtonArea(rect) -> wx.Rect
1204
1205        Calculate the position and size of the ribbon's toggle button.
1206    %End
1207
1208    virtual
1209    wxRect GetRibbonHelpButtonArea(
1210        const wxRect & rect
1211    );
1212    %Docstring
1213        GetRibbonHelpButtonArea(rect) -> wx.Rect
1214
1215        Calculate the position and size of the ribbon's help button.
1216    %End
1217
1218    public:
1219
1220
1221    %Property(name=Flags, get=GetFlags, set=SetFlags)
1222};  // end of class wxRibbonMSWArtProvider
1223
1224
1225class wxRibbonAUIArtProvider : wxRibbonMSWArtProvider
1226{
1227    %Docstring
1228        RibbonAUIArtProvider()
1229    %End
1230    %TypeHeaderCode
1231        #include <wx/ribbon/art.h>
1232    %End
1233
1234public:
1235    wxRibbonAUIArtProvider();
1236
1237    virtual
1238    ~wxRibbonAUIArtProvider();
1239
1240    virtual
1241    wxRibbonArtProvider * Clone() const   /Factory/;
1242    %Docstring
1243        Clone() -> RibbonArtProvider
1244
1245        Create a new art provider which is a clone of this one.
1246    %End
1247
1248    virtual
1249    wxColour GetColour(
1250        int id
1251    ) const;
1252    %Docstring
1253        GetColour(id) -> wx.Colour
1254
1255        Get the value of a certain colour setting.
1256    %End
1257
1258    virtual
1259    void SetColour(
1260        int id,
1261        const wxColour & colour
1262    );
1263    %Docstring
1264        SetColour(id, colour)
1265
1266        Set the value of a certain colour setting to the value colour.
1267    %End
1268
1269    virtual
1270    void SetColourScheme(
1271        const wxColour & primary,
1272        const wxColour & secondary,
1273        const wxColour & tertiary
1274    );
1275    %Docstring
1276        SetColourScheme(primary, secondary, tertiary)
1277
1278        Set all applicable colour settings from a few base colours.
1279    %End
1280
1281    virtual
1282    void SetFont(
1283        int id,
1284        const wxFont & font
1285    );
1286    %Docstring
1287        SetFont(id, font)
1288
1289        Set the value of a certain font setting to the value font.
1290    %End
1291
1292    virtual
1293    wxSize GetScrollButtonMinimumSize(
1294        wxDC & dc,
1295        wxWindow * wnd,
1296        long style
1297    );
1298    %Docstring
1299        GetScrollButtonMinimumSize(dc, wnd, style) -> wx.Size
1300
1301        Calculate the minimum size (in pixels) of a scroll button.
1302    %End
1303
1304    virtual
1305    void DrawScrollButton(
1306        wxDC & dc,
1307        wxWindow * wnd,
1308        const wxRect & rect,
1309        long style
1310    );
1311    %Docstring
1312        DrawScrollButton(dc, wnd, rect, style)
1313
1314        Draw a ribbon-style scroll button.
1315    %End
1316
1317    virtual
1318    wxSize GetPanelSize(
1319        wxDC & dc,
1320        const wxRibbonPanel * wnd,
1321        wxSize client_size,
1322        wxPoint * client_offset
1323    );
1324    %Docstring
1325        GetPanelSize(dc, wnd, client_size, client_offset) -> wx.Size
1326
1327        Calculate the size of a panel for a given client size.
1328    %End
1329
1330    virtual
1331    wxSize GetPanelClientSize(
1332        wxDC & dc,
1333        const wxRibbonPanel * wnd,
1334        wxSize size,
1335        wxPoint * client_offset
1336    );
1337    %Docstring
1338        GetPanelClientSize(dc, wnd, size, client_offset) -> wx.Size
1339
1340        Calculate the client size of a panel for a given overall size.
1341    %End
1342
1343    virtual
1344    wxRect GetPanelExtButtonArea(
1345        wxDC & dc,
1346        const wxRibbonPanel * wnd,
1347        wxRect rect
1348    );
1349    %Docstring
1350        GetPanelExtButtonArea(dc, wnd, rect) -> wx.Rect
1351
1352        Calculate the position and size of the panel extension button.
1353    %End
1354
1355    virtual
1356    void DrawTabCtrlBackground(
1357        wxDC & dc,
1358        wxWindow * wnd,
1359        const wxRect & rect
1360    );
1361    %Docstring
1362        DrawTabCtrlBackground(dc, wnd, rect)
1363
1364        Draw the background of the tab region of a ribbon bar.
1365    %End
1366
1367    virtual
1368    int GetTabCtrlHeight(
1369        wxDC & dc,
1370        wxWindow * wnd,
1371        const wxRibbonPageTabInfoArray & pages
1372    );
1373    %Docstring
1374        GetTabCtrlHeight(dc, wnd, pages) -> int
1375
1376        Calculate the height (in pixels) of the tab region of a ribbon bar.
1377    %End
1378
1379    virtual
1380    void GetBarTabWidth(
1381        wxDC & dc,
1382        wxWindow * wnd,
1383        const wxString & label,
1384        const wxBitmap & bitmap,
1385        int * ideal,
1386        int * small_begin_need_separator,
1387        int * small_must_have_separator,
1388        int * minimum
1389    );
1390    %Docstring
1391        GetBarTabWidth(dc, wnd, label, bitmap, ideal, small_begin_need_separator, small_must_have_separator, minimum)
1392
1393        Calculate the ideal and minimum width (in pixels) of a tab in a ribbon
1394        bar.
1395    %End
1396
1397    virtual
1398    void DrawTab(
1399        wxDC & dc,
1400        wxWindow * wnd,
1401        const wxRibbonPageTabInfo & tab
1402    );
1403    %Docstring
1404        DrawTab(dc, wnd, tab)
1405
1406        Draw a single tab in the tab region of a ribbon bar.
1407    %End
1408
1409    virtual
1410    void DrawTabSeparator(
1411        wxDC & dc,
1412        wxWindow * wnd,
1413        const wxRect & rect,
1414        double visibility
1415    );
1416    %Docstring
1417        DrawTabSeparator(dc, wnd, rect, visibility)
1418
1419        Draw a separator between two tabs in a ribbon bar.
1420    %End
1421
1422    virtual
1423    void DrawPageBackground(
1424        wxDC & dc,
1425        wxWindow * wnd,
1426        const wxRect & rect
1427    );
1428    %Docstring
1429        DrawPageBackground(dc, wnd, rect)
1430
1431        Draw the background of a ribbon page.
1432    %End
1433
1434    virtual
1435    void DrawPanelBackground(
1436        wxDC & dc,
1437        wxRibbonPanel * wnd,
1438        const wxRect & rect
1439    );
1440    %Docstring
1441        DrawPanelBackground(dc, wnd, rect)
1442
1443        Draw the background and chrome for a ribbon panel.
1444    %End
1445
1446    virtual
1447    void DrawMinimisedPanel(
1448        wxDC & dc,
1449        wxRibbonPanel * wnd,
1450        const wxRect & rect,
1451        wxBitmap & bitmap
1452    );
1453    %Docstring
1454        DrawMinimisedPanel(dc, wnd, rect, bitmap)
1455
1456        Draw a minimised ribbon panel.
1457    %End
1458
1459    virtual
1460    void DrawGalleryBackground(
1461        wxDC & dc,
1462        wxRibbonGallery * wnd,
1463        const wxRect & rect
1464    );
1465    %Docstring
1466        DrawGalleryBackground(dc, wnd, rect)
1467
1468        Draw the background and chrome for a wxRibbonGallery control.
1469    %End
1470
1471    virtual
1472    void DrawGalleryItemBackground(
1473        wxDC & dc,
1474        wxRibbonGallery * wnd,
1475        const wxRect & rect,
1476        wxRibbonGalleryItem * item
1477    );
1478    %Docstring
1479        DrawGalleryItemBackground(dc, wnd, rect, item)
1480
1481        Draw the background of a single item in a wxRibbonGallery control.
1482    %End
1483
1484    virtual
1485    void DrawButtonBarBackground(
1486        wxDC & dc,
1487        wxWindow * wnd,
1488        const wxRect & rect
1489    );
1490    %Docstring
1491        DrawButtonBarBackground(dc, wnd, rect)
1492
1493        Draw the background for a wxRibbonButtonBar control.
1494    %End
1495
1496    virtual
1497    void DrawButtonBarButton(
1498        wxDC & dc,
1499        wxWindow * wnd,
1500        const wxRect & rect,
1501        wxRibbonButtonKind kind,
1502        long state,
1503        const wxString & label,
1504        const wxBitmap & bitmap_large,
1505        const wxBitmap & bitmap_small
1506    );
1507    %Docstring
1508        DrawButtonBarButton(dc, wnd, rect, kind, state, label, bitmap_large, bitmap_small)
1509
1510        Draw a single button for a wxRibbonButtonBar control.
1511    %End
1512
1513    virtual
1514    void DrawToolBarBackground(
1515        wxDC & dc,
1516        wxWindow * wnd,
1517        const wxRect & rect
1518    );
1519    %Docstring
1520        DrawToolBarBackground(dc, wnd, rect)
1521
1522        Draw the background for a wxRibbonToolBar control.
1523    %End
1524
1525    virtual
1526    void DrawToolGroupBackground(
1527        wxDC & dc,
1528        wxWindow * wnd,
1529        const wxRect & rect
1530    );
1531    %Docstring
1532        DrawToolGroupBackground(dc, wnd, rect)
1533
1534        Draw the background for a group of tools on a wxRibbonToolBar control.
1535    %End
1536
1537    virtual
1538    void DrawTool(
1539        wxDC & dc,
1540        wxWindow * wnd,
1541        const wxRect & rect,
1542        const wxBitmap & bitmap,
1543        wxRibbonButtonKind kind,
1544        long state
1545    );
1546    %Docstring
1547        DrawTool(dc, wnd, rect, bitmap, kind, state)
1548
1549        Draw a single tool (for a wxRibbonToolBar control).
1550    %End
1551
1552};  // end of class wxRibbonAUIArtProvider
1553
1554
1555%Extract(id=pycode_ribbon)
1556if 'wxMSW' in wx.PlatformInfo:
1557    RibbonDefaultArtProvider = RibbonMSWArtProvider
1558else:
1559    RibbonDefaultArtProvider = RibbonAUIArtProvider
1560
1561%End
1562
1563
1564//---------------------------------------------------------------------------
1565
1566