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/control.h> 13%End 14 15 16//--------------------------------------------------------------------------- 17 18class wxRibbonControl : wxControl 19{ 20 %Docstring 21 RibbonControl() 22 RibbonControl(parent, id=wx.ID_ANY, pos=wx.DefaultPosition, size=wx.DefaultSize, style=0, validator=wx.DefaultValidator, name=wx.ControlNameStr) 23 24 wxRibbonControl serves as a base class for all controls which share 25 the ribbon characteristics of having a ribbon art provider, and 26 (optionally) non-continuous resizing. 27 %End 28 %TypeHeaderCode 29 #include <wx/ribbon/control.h> 30 %End 31 32public: 33 wxRibbonControl(); 34 %PreMethodCode 35 if (!wxPyCheckForApp()) return NULL; 36 %End 37 38 wxRibbonControl( 39 wxWindow * parent /TransferThis/, 40 wxWindowID id = wxID_ANY, 41 const wxPoint & pos = wxDefaultPosition, 42 const wxSize & size = wxDefaultSize, 43 long style = 0, 44 const wxValidator & validator = wxDefaultValidator, 45 const wxString & name = wxControlNameStr 46 ); 47 %PreMethodCode 48 if (!wxPyCheckForApp()) return NULL; 49 %End 50 51 void SetArtProvider( 52 wxRibbonArtProvider * art 53 ); 54 %Docstring 55 SetArtProvider(art) 56 57 Set the art provider to be used. 58 %End 59 60 wxRibbonArtProvider * GetArtProvider() const; 61 %Docstring 62 GetArtProvider() -> RibbonArtProvider 63 64 Get the art provider to be used. 65 %End 66 67 bool IsSizingContinuous() const; 68 %Docstring 69 IsSizingContinuous() -> bool 70 %End 71 72 wxSize GetNextSmallerSize( 73 wxOrientation direction 74 ) const; 75 %Docstring 76 GetNextSmallerSize(direction) -> wx.Size 77 GetNextSmallerSize(direction, relative_to) -> wx.Size 78 79 If sizing is not continuous, then return a suitable size for the 80 control which is smaller than the current size. 81 %End 82 83 wxSize GetNextSmallerSize( 84 wxOrientation direction, 85 wxSize relative_to 86 ) const; 87 88 wxSize GetNextLargerSize( 89 wxOrientation direction 90 ) const; 91 %Docstring 92 GetNextLargerSize(direction) -> wx.Size 93 GetNextLargerSize(direction, relative_to) -> wx.Size 94 95 If sizing is not continuous, then return a suitable size for the 96 control which is larger than the current size. 97 %End 98 99 wxSize GetNextLargerSize( 100 wxOrientation direction, 101 wxSize relative_to 102 ) const; 103 104 bool Realize(); 105 %Docstring 106 Realize() -> bool 107 108 Perform initial size and layout calculations after children have been 109 added, and/or realize children. 110 %End 111 112 bool Realise(); 113 %Docstring 114 Realise() -> bool 115 116 Alias for Realize(). 117 %End 118 119 wxRibbonBar * GetAncestorRibbonBar() const; 120 %Docstring 121 GetAncestorRibbonBar() -> RibbonBar 122 123 Get the first ancestor which is a wxRibbonBar (or derived) or NULL if 124 not having such parent. 125 %End 126 127 wxSize GetBestSizeForParentSize( 128 const wxSize & parentSize 129 ) const; 130 %Docstring 131 GetBestSizeForParentSize(parentSize) -> wx.Size 132 133 Finds the best width and height given the parent's width and height. 134 %End 135 136 public: 137 virtual wxPoint GetClientAreaOrigin() const; 138 virtual bool Validate(); 139 virtual bool TransferDataToWindow(); 140 virtual bool TransferDataFromWindow(); 141 virtual void InitDialog(); 142 virtual bool AcceptsFocus() const; 143 virtual bool AcceptsFocusRecursively() const; 144 virtual bool AcceptsFocusFromKeyboard() const; 145 virtual void AddChild( wxWindowBase *child ); 146 virtual void RemoveChild( wxWindowBase *child ); 147 virtual void InheritAttributes(); 148 virtual bool ShouldInheritColours() const; 149 virtual void OnInternalIdle(); 150 virtual wxWindow *GetMainWindowOfCompositeControl(); 151 virtual bool InformFirstDirection(int direction, int size, int availableOtherDir); 152 virtual void SetCanFocus(bool canFocus); 153 virtual bool Destroy(); 154 virtual void SetValidator( const wxValidator &validator ); 155 virtual wxValidator* GetValidator(); 156 157 158 protected: 159 virtual bool ProcessEvent(wxEvent & event); 160 virtual void DoEnable(bool enable); 161 virtual void DoGetPosition(int *x, int *y) const; 162 virtual void DoGetSize(int *width, int *height) const; 163 virtual void DoGetClientSize(int *width, int *height) const; 164 virtual wxSize DoGetBestSize() const; 165 virtual wxSize DoGetBestClientSize() const; 166 virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags); 167 virtual void DoSetClientSize(int width, int height); 168 virtual void DoSetSizeHints( int minW, int minH, int maxW, int maxH, int incW, int incH ); 169 virtual wxSize DoGetBorderSize() const; 170 virtual void DoMoveWindow(int x, int y, int width, int height); 171 virtual void DoSetWindowVariant( wxWindowVariant variant); 172 virtual wxBorder GetDefaultBorder() const; 173 virtual wxBorder GetDefaultBorderForControl() const; 174 virtual void DoFreeze(); 175 virtual void DoThaw(); 176 virtual bool HasTransparentBackground(); 177 virtual bool TryBefore(wxEvent& event); 178 virtual bool TryAfter(wxEvent& event); 179 180 181 public: 182 183 184 static 185 wxVisualAttributes GetClassDefaultAttributes( 186 wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL 187 ); 188 %Docstring 189 GetClassDefaultAttributes(variant=wx.WINDOW_VARIANT_NORMAL) -> wx.VisualAttributes 190 %End 191 %PreMethodCode 192 if (!wxPyCheckForApp()) return NULL; 193 %End 194 195 public: 196 197 198 %Property(name=AncestorRibbonBar, get=GetAncestorRibbonBar) 199 %Property(name=ArtProvider, get=GetArtProvider, set=SetArtProvider) 200 201protected: 202 wxSize DoGetNextSmallerSize( 203 wxOrientation direction, 204 wxSize relative_to 205 ) const; 206 %Docstring 207 DoGetNextSmallerSize(direction, relative_to) -> wx.Size 208 209 Implementation of GetNextSmallerSize(). 210 %End 211 212 wxSize DoGetNextLargerSize( 213 wxOrientation direction, 214 wxSize relative_to 215 ) const; 216 %Docstring 217 DoGetNextLargerSize(direction, relative_to) -> wx.Size 218 219 Implementation of GetNextLargerSize(). 220 %End 221 222}; // end of class wxRibbonControl 223 224 225 226//--------------------------------------------------------------------------- 227 228