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%ModuleHeaderCode
12#include <wx/ribbon/page.h>
13%End
14
15
16//---------------------------------------------------------------------------
17
18class wxRibbonPage : wxRibbonControl
19{
20    %Docstring
21        RibbonPage()
22        RibbonPage(parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, style=0)
23
24        Container for related ribbon panels, and a tab within a ribbon bar.
25    %End
26    %TypeHeaderCode
27        #include <wx/ribbon/page.h>
28    %End
29
30public:
31    wxRibbonPage();
32    %PreMethodCode
33        if (!wxPyCheckForApp()) return NULL;
34    %End
35
36    wxRibbonPage(
37        wxRibbonBar * parent   /TransferThis/,
38        wxWindowID id = wxID_ANY,
39        const wxString & label = wxEmptyString,
40        const wxBitmap & icon = wxNullBitmap,
41        long style = 0
42    );
43    %PreMethodCode
44        if (!wxPyCheckForApp()) return NULL;
45    %End
46
47    ~wxRibbonPage();
48
49    bool Create(
50        wxRibbonBar * parent   /TransferThis/,
51        wxWindowID id = wxID_ANY,
52        const wxString & label = wxEmptyString,
53        const wxBitmap & icon = wxNullBitmap,
54        long style = 0
55    );
56    %Docstring
57        Create(parent, id=wx.ID_ANY, label=wx.EmptyString, icon=wx.NullBitmap, style=0) -> bool
58
59        Create a ribbon page in two-step ribbon page construction.
60    %End
61
62    void SetArtProvider(
63        wxRibbonArtProvider * art
64    );
65    %Docstring
66        SetArtProvider(art)
67
68        Set the art provider to be used.
69    %End
70
71    wxBitmap & GetIcon();
72    %Docstring
73        GetIcon() -> wx.Bitmap
74
75        Get the icon used for the page in the ribbon bar tab area (only
76        displayed if the ribbon bar is actually showing icons).
77    %End
78
79    void SetSizeWithScrollButtonAdjustment(
80        int x,
81        int y,
82        int width,
83        int height
84    );
85    %Docstring
86        SetSizeWithScrollButtonAdjustment(x, y, width, height)
87
88        Set the size of the page and the external scroll buttons (if any).
89    %End
90
91    void AdjustRectToIncludeScrollButtons(
92        wxRect * rect
93    ) const;
94    %Docstring
95        AdjustRectToIncludeScrollButtons(rect)
96
97        Expand a rectangle of the page to include external scroll buttons (if
98        any).
99    %End
100
101    bool DismissExpandedPanel();
102    %Docstring
103        DismissExpandedPanel() -> bool
104
105        Dismiss the current externally expanded panel, if there is one.
106    %End
107
108    bool Realize();
109    %Docstring
110        Realize() -> bool
111
112        Perform a full re-layout of all panels on the page.
113    %End
114
115    bool ScrollLines(
116        int lines
117    );
118    %Docstring
119        ScrollLines(lines) -> bool
120
121        Scroll the page by some amount up / down / left / right.
122    %End
123
124    bool ScrollPixels(
125        int pixels
126    );
127    %Docstring
128        ScrollPixels(pixels) -> bool
129
130        Scroll the page by a set number of pixels up / down / left / right.
131    %End
132
133    bool ScrollSections(
134        int sections
135    );
136    %Docstring
137        ScrollSections(sections) -> bool
138
139        Scroll the page by an entire child section.
140    %End
141
142    wxOrientation GetMajorAxis() const;
143    %Docstring
144        GetMajorAxis() -> Orientation
145
146        Get the direction in which ribbon panels are stacked within the page.
147    %End
148
149    public:
150    virtual wxPoint GetClientAreaOrigin() const;
151    virtual bool Validate();
152    virtual bool TransferDataToWindow();
153    virtual bool TransferDataFromWindow();
154    virtual void InitDialog();
155    virtual bool AcceptsFocus() const;
156    virtual bool AcceptsFocusRecursively() const;
157    virtual bool AcceptsFocusFromKeyboard() const;
158    virtual void AddChild( wxWindowBase *child );
159    virtual void RemoveChild( wxWindowBase *child );
160    virtual void InheritAttributes();
161    virtual bool ShouldInheritColours() const;
162    virtual void OnInternalIdle();
163    virtual wxWindow *GetMainWindowOfCompositeControl();
164    virtual bool InformFirstDirection(int direction, int size, int availableOtherDir);
165    virtual void SetCanFocus(bool canFocus);
166    virtual bool Destroy();
167    virtual void SetValidator( const wxValidator &validator );
168    virtual wxValidator* GetValidator();
169
170
171    protected:
172    virtual bool ProcessEvent(wxEvent & event);
173    virtual void DoEnable(bool enable);
174    virtual void DoGetPosition(int *x, int *y) const;
175    virtual void DoGetSize(int *width, int *height) const;
176    virtual void DoGetClientSize(int *width, int *height) const;
177    virtual wxSize DoGetBestSize() const;
178    virtual wxSize DoGetBestClientSize() const;
179    virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags);
180    virtual void DoSetClientSize(int width, int height);
181    virtual void DoSetSizeHints( int minW, int minH, int maxW, int maxH, int incW, int incH );
182    virtual wxSize DoGetBorderSize() const;
183    virtual void DoMoveWindow(int x, int y, int width, int height);
184    virtual void DoSetWindowVariant( wxWindowVariant variant);
185    virtual wxBorder GetDefaultBorder() const;
186    virtual wxBorder GetDefaultBorderForControl() const;
187    virtual void DoFreeze();
188    virtual void DoThaw();
189    virtual bool HasTransparentBackground();
190    virtual bool TryBefore(wxEvent& event);
191    virtual bool TryAfter(wxEvent& event);
192
193
194    public:
195
196
197    static
198    wxVisualAttributes GetClassDefaultAttributes(
199        wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL
200    );
201    %Docstring
202        GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes
203    %End
204    %PreMethodCode
205        if (!wxPyCheckForApp()) return NULL;
206    %End
207
208    public:
209
210
211    %Property(name=Icon, get=GetIcon)
212    %Property(name=MajorAxis, get=GetMajorAxis)
213};  // end of class wxRibbonPage
214
215
216
217//---------------------------------------------------------------------------
218
219