| 1 | ///////////////////////////////////////////////////////////////////////////// |
| 2 | // Name: _window.i |
| 3 | // Purpose: SWIG interface for wxWindow |
| 4 | // |
| 5 | // Author: Robin Dunn |
| 6 | // |
| 7 | // Created: 24-June-1997 |
| 8 | // RCS-ID: $Id$ |
| 9 | // Copyright: (c) 2003 by Total Control Software |
| 10 | // Licence: wxWindows license |
| 11 | ///////////////////////////////////////////////////////////////////////////// |
| 12 | |
| 13 | // Not a %module |
| 14 | |
| 15 | |
| 16 | //--------------------------------------------------------------------------- |
| 17 | |
| 18 | %{ |
| 19 | %} |
| 20 | |
| 21 | MAKE_CONST_WXSTRING(PanelNameStr); |
| 22 | |
| 23 | //--------------------------------------------------------------------------- |
| 24 | %newgroup |
| 25 | |
| 26 | |
| 27 | DocStr(wxVisualAttributes, |
| 28 | "struct containing all the visual attributes of a control", ""); |
| 29 | |
| 30 | struct wxVisualAttributes |
| 31 | { |
| 32 | %extend { |
| 33 | wxVisualAttributes() { return new wxVisualAttributes; } |
| 34 | ~wxVisualAttributes() { delete self; } |
| 35 | } |
| 36 | |
| 37 | // the font used for control label/text inside it |
| 38 | wxFont font; |
| 39 | |
| 40 | // the foreground colour |
| 41 | wxColour colFg; |
| 42 | |
| 43 | // the background colour, may be wxNullColour if the controls background |
| 44 | // colour is not solid |
| 45 | wxColour colBg; |
| 46 | }; |
| 47 | |
| 48 | |
| 49 | |
| 50 | |
| 51 | enum wxWindowVariant |
| 52 | { |
| 53 | wxWINDOW_VARIANT_NORMAL, // Normal size |
| 54 | wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal ) |
| 55 | wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal ) |
| 56 | wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal ) |
| 57 | wxWINDOW_VARIANT_MAX |
| 58 | }; |
| 59 | |
| 60 | |
| 61 | DocStr(wxWindow, |
| 62 | "wx.Window is the base class for all windows and represents any visible |
| 63 | object on the screen. All controls, top level windows and so on are |
| 64 | wx.Windows. Sizers and device contexts are not however, as they don't |
| 65 | appear on screen themselves. |
| 66 | ", |
| 67 | " |
| 68 | Styles |
| 69 | ------- |
| 70 | ============================= ===================================== |
| 71 | wx.SIMPLE_BORDER Displays a thin border around the window. |
| 72 | |
| 73 | wx.DOUBLE_BORDER Displays a double border. Windows and Mac only. |
| 74 | |
| 75 | wx.SUNKEN_BORDER Displays a sunken border. |
| 76 | |
| 77 | wx.RAISED_BORDER Displays a raised border. |
| 78 | |
| 79 | wx.STATIC_BORDER Displays a border suitable for a static |
| 80 | control. Windows only. |
| 81 | |
| 82 | wx.NO_BORDER Displays no border, overriding the default |
| 83 | border style for the window. |
| 84 | |
| 85 | wx.TRANSPARENT_WINDOW The window is transparent, that is, it |
| 86 | will not receive paint events. Windows only. |
| 87 | |
| 88 | wx.TAB_TRAVERSAL Use this to enable tab traversal for |
| 89 | non-dialog windows. |
| 90 | |
| 91 | wx.WANTS_CHARS Use this to indicate that the window |
| 92 | wants to get all char/key events for |
| 93 | all keys - even for keys like TAB or |
| 94 | ENTER which are usually used for |
| 95 | dialog navigation and which wouldn't |
| 96 | be generated without this style. If |
| 97 | you need to use this style in order to |
| 98 | get the arrows or etc., but would |
| 99 | still like to have normal keyboard |
| 100 | navigation take place, you should |
| 101 | create and send a wxNavigationKeyEvent |
| 102 | in response to the key events for Tab |
| 103 | and Shift-Tab. |
| 104 | |
| 105 | wx.NO_FULL_REPAINT_ON_RESIZE Disables repainting the window |
| 106 | completely when its size is changed. |
| 107 | You will have to repaint the new |
| 108 | window area manually if you use this |
| 109 | style. As of version 2.5.1 this |
| 110 | style is on by default. Use |
| 111 | wx.FULL_REPAINT_ON_RESIZE to |
| 112 | deactivate it. |
| 113 | |
| 114 | wx.VSCROLL Use this style to enable a vertical scrollbar. |
| 115 | |
| 116 | wx.HSCROLL Use this style to enable a horizontal scrollbar. |
| 117 | |
| 118 | wx.ALWAYS_SHOW_SB If a window has scrollbars, disable them |
| 119 | instead of hiding them when they are |
| 120 | not needed (i.e. when the size of the |
| 121 | window is big enough to not require |
| 122 | the scrollbars to navigate it). This |
| 123 | style is currently only implemented |
| 124 | for wxMSW and wxUniversal and does |
| 125 | nothing on the other platforms. |
| 126 | |
| 127 | wx.CLIP_CHILDREN Use this style to eliminate flicker caused by |
| 128 | the background being repainted, then |
| 129 | children being painted over |
| 130 | them. Windows only. |
| 131 | |
| 132 | wx.FULL_REPAINT_ON_RESIZE Use this style to force a complete |
| 133 | redraw of the window whenever it is |
| 134 | resized instead of redrawing just the |
| 135 | part of the window affected by |
| 136 | resizing. Note that this was the |
| 137 | behaviour by default before 2.5.1 |
| 138 | release and that if you experience |
| 139 | redraw problems with the code which |
| 140 | previously used to work you may want |
| 141 | to try this. |
| 142 | ============================= ===================================== |
| 143 | |
| 144 | |
| 145 | Extra Styles |
| 146 | ------------ |
| 147 | ============================= ===================================== |
| 148 | wx.WS_EX_VALIDATE_RECURSIVELY By default, |
| 149 | Validate/TransferDataTo/FromWindow() |
| 150 | only work on direct children of |
| 151 | the window (compatible |
| 152 | behaviour). Set this flag to make |
| 153 | them recursively descend into all |
| 154 | subwindows. |
| 155 | |
| 156 | wx.WS_EX_BLOCK_EVENTS wx.CommandEvents and the objects of the |
| 157 | derived classes are forwarded to |
| 158 | the parent window and so on |
| 159 | recursively by default. Using this |
| 160 | flag for the given window allows |
| 161 | to block this propagation at this |
| 162 | window, i.e. prevent the events |
| 163 | from being propagated further |
| 164 | upwards. Dialogs have this flag on |
| 165 | by default. |
| 166 | |
| 167 | wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for |
| 168 | the other windows: this must be |
| 169 | used with transient windows as |
| 170 | otherwise there is the risk of |
| 171 | creating a dialog/frame with this |
| 172 | window as a parent which would |
| 173 | lead to a crash if the parent is |
| 174 | destroyed before the child. |
| 175 | |
| 176 | wx.WS_EX_PROCESS_IDLE This window should always process idle |
| 177 | events, even if the mode set by |
| 178 | wx.IdleEvent.SetMode is |
| 179 | wx.IDLE_PROCESS_SPECIFIED. |
| 180 | |
| 181 | wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI |
| 182 | update events, even if the mode |
| 183 | set by wxUpdateUIEvent::SetMode is |
| 184 | wxUPDATE_UI_PROCESS_SPECIFIED. |
| 185 | ============================= ===================================== |
| 186 | |
| 187 | "); |
| 188 | |
| 189 | |
| 190 | MustHaveApp(wxWindow); |
| 191 | MustHaveApp(wxWindow::FindFocus); |
| 192 | MustHaveApp(wxWindow::GetCapture); |
| 193 | |
| 194 | // This one is not restricted to wxWindow |
| 195 | MustHaveApp(GetClassDefaultAttributes); |
| 196 | |
| 197 | class wxWindow : public wxEvtHandler |
| 198 | { |
| 199 | public: |
| 200 | %pythonAppend wxWindow "self._setOORInfo(self)" |
| 201 | %pythonAppend wxWindow() "" |
| 202 | %typemap(out) wxWindow*; // turn off this typemap |
| 203 | |
| 204 | DocCtorStr( |
| 205 | wxWindow(wxWindow* parent, const wxWindowID id=-1, |
| 206 | const wxPoint& pos = wxDefaultPosition, |
| 207 | const wxSize& size = wxDefaultSize, |
| 208 | long style = 0, |
| 209 | const wxString& name = wxPyPanelNameStr), |
| 210 | "Construct and show a generic Window.", ""); |
| 211 | |
| 212 | DocCtorStrName( |
| 213 | wxWindow(), |
| 214 | "Precreate a Window for 2-phase creation.", "", |
| 215 | PreWindow); |
| 216 | |
| 217 | // Turn it back on again |
| 218 | %typemap(out) wxWindow* { $result = wxPyMake_wxObject($1, $owner); } |
| 219 | |
| 220 | |
| 221 | DocDeclStr( |
| 222 | bool , Create(wxWindow* parent, const wxWindowID id=-1, |
| 223 | const wxPoint& pos = wxDefaultPosition, |
| 224 | const wxSize& size = wxDefaultSize, |
| 225 | long style = 0, |
| 226 | const wxString& name = wxPyPanelNameStr), |
| 227 | "Create the GUI part of the Window for 2-phase creation mode.", ""); |
| 228 | |
| 229 | |
| 230 | // deleting the window |
| 231 | // ------------------- |
| 232 | |
| 233 | |
| 234 | DocDeclStr( |
| 235 | bool , Close( bool force = false ), |
| 236 | "This function simply generates a EVT_CLOSE event whose handler usually |
| 237 | tries to close the window. It doesn't close the window itself, |
| 238 | however. If force is False (the default) then the window's close |
| 239 | handler will be allowed to veto the destruction of the window.", |
| 240 | " |
| 241 | Usually Close is only used with the top level windows (wx.Frame and |
| 242 | wx.Dialog classes) as the others are not supposed to have any special |
| 243 | EVT_CLOSE logic. |
| 244 | |
| 245 | The close handler should check whether the window is being deleted |
| 246 | forcibly, using wx.CloseEvent.GetForce, in which case it should |
| 247 | destroy the window using wx.Window.Destroy. |
| 248 | |
| 249 | Note that calling Close does not guarantee that the window will be |
| 250 | destroyed; but it provides a way to simulate a manual close of a |
| 251 | window, which may or may not be implemented by destroying the |
| 252 | window. The default EVT_CLOSE handler for wx.Dialog does not |
| 253 | necessarily delete the dialog, since it will simply simulate an |
| 254 | wxID_CANCEL event which is handled by the appropriate button event |
| 255 | handler and may do anything at all. |
| 256 | |
| 257 | To guarantee that the window will be destroyed, call wx.Window.Destroy |
| 258 | instead."); |
| 259 | |
| 260 | |
| 261 | |
| 262 | DocDeclStr( |
| 263 | virtual bool , Destroy(), |
| 264 | "Destroys the window safely. Frames and dialogs are not destroyed |
| 265 | immediately when this function is called -- they are added to a list |
| 266 | of windows to be deleted on idle time, when all the window's events |
| 267 | have been processed. This prevents problems with events being sent to |
| 268 | non-existent windows. |
| 269 | |
| 270 | Returns True if the window has either been successfully deleted, or it |
| 271 | has been added to the list of windows pending real deletion.", ""); |
| 272 | |
| 273 | |
| 274 | DocDeclStr( |
| 275 | bool , DestroyChildren(), |
| 276 | "Destroys all children of a window. Called automatically by the |
| 277 | destructor.", ""); |
| 278 | |
| 279 | |
| 280 | DocDeclStr( |
| 281 | bool , IsBeingDeleted() const, |
| 282 | "Is the window in the process of being deleted?", ""); |
| 283 | |
| 284 | |
| 285 | |
| 286 | // window attributes |
| 287 | // ----------------- |
| 288 | |
| 289 | DocDeclStr( |
| 290 | virtual void , SetTitle( const wxString& title), |
| 291 | "Sets the window's title. Applicable only to frames and dialogs.", ""); |
| 292 | |
| 293 | DocDeclStr( |
| 294 | virtual wxString , GetTitle() const, |
| 295 | "Gets the window's title. Applicable only to frames and dialogs.", ""); |
| 296 | |
| 297 | |
| 298 | DocDeclStr( |
| 299 | virtual void , SetLabel(const wxString& label), |
| 300 | "Set the text which the window shows in its label if applicable.", ""); |
| 301 | |
| 302 | DocDeclStr( |
| 303 | virtual wxString , GetLabel() const, |
| 304 | "Generic way of getting a label from any window, for identification |
| 305 | purposes. The interpretation of this function differs from class to |
| 306 | class. For frames and dialogs, the value returned is the title. For |
| 307 | buttons or static text controls, it is the button text. This function |
| 308 | can be useful for meta-programs such as testing tools or special-needs |
| 309 | access programs)which need to identify windows by name.", ""); |
| 310 | |
| 311 | |
| 312 | DocDeclStr( |
| 313 | virtual void , SetName( const wxString &name ), |
| 314 | "Sets the window's name. The window name is used for ressource setting |
| 315 | in X, it is not the same as the window title/label", ""); |
| 316 | |
| 317 | DocDeclStr( |
| 318 | virtual wxString , GetName() const, |
| 319 | "Returns the windows name. This name is not guaranteed to be unique; |
| 320 | it is up to the programmer to supply an appropriate name in the window |
| 321 | constructor or via wx.Window.SetName.", ""); |
| 322 | |
| 323 | |
| 324 | DocDeclStr( |
| 325 | void , SetWindowVariant( wxWindowVariant variant ), |
| 326 | "Sets the variant of the window/font size to use for this window, if |
| 327 | the platform supports variants, for example, wxMac.", |
| 328 | " |
| 329 | Variant values are: |
| 330 | |
| 331 | ======================== ======================================= |
| 332 | wx.WINDOW_VARIANT_NORMAL Normal size |
| 333 | wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal) |
| 334 | wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal) |
| 335 | wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal) |
| 336 | ======================== ======================================= |
| 337 | "); |
| 338 | |
| 339 | DocDeclStr( |
| 340 | wxWindowVariant , GetWindowVariant() const, |
| 341 | "", ""); |
| 342 | |
| 343 | |
| 344 | DocDeclStr( |
| 345 | void , SetId( wxWindowID winid ), |
| 346 | "Sets the identifier of the window. Each window has an integer |
| 347 | identifier. If the application has not provided one, an identifier |
| 348 | will be generated. Normally, the identifier should be provided on |
| 349 | creation and should not be modified subsequently.", ""); |
| 350 | |
| 351 | DocDeclStr( |
| 352 | wxWindowID , GetId() const, |
| 353 | "Returns the identifier of the window. Each window has an integer |
| 354 | identifier. If the application has not provided one (or the default Id |
| 355 | -1 is used) then an unique identifier with a negative value will be |
| 356 | generated.", ""); |
| 357 | |
| 358 | |
| 359 | DocDeclStr( |
| 360 | static int , NewControlId(), |
| 361 | "Generate a control id for the controls which were not given one.", ""); |
| 362 | |
| 363 | |
| 364 | DocDeclStr( |
| 365 | static int , NextControlId(int winid), |
| 366 | "Get the id of the control following the one with the given |
| 367 | autogenerated) id", ""); |
| 368 | |
| 369 | |
| 370 | DocDeclStr( |
| 371 | static int , PrevControlId(int winid), |
| 372 | "Get the id of the control preceding the one with the given |
| 373 | autogenerated) id", ""); |
| 374 | |
| 375 | |
| 376 | |
| 377 | |
| 378 | // moving/resizing |
| 379 | // --------------- |
| 380 | |
| 381 | |
| 382 | DocDeclStr( |
| 383 | void , SetSize( const wxSize& size ), |
| 384 | "Sets the size of the window in pixels.", ""); |
| 385 | |
| 386 | |
| 387 | DocDeclStrName( |
| 388 | void , SetSize( int x, int y, int width, int height, |
| 389 | int sizeFlags = wxSIZE_AUTO ), |
| 390 | "Sets the position and size of the window in pixels. The sizeFlags |
| 391 | parameter indicates the interpretation of the other params if they are |
| 392 | equal to -1. |
| 393 | |
| 394 | ======================== ====================================== |
| 395 | wx.SIZE_AUTO A -1 indicates that a class-specific |
| 396 | default should be used. |
| 397 | wx.SIZE_USE_EXISTING Axisting dimensions should be used if |
| 398 | -1 values are supplied. |
| 399 | wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be |
| 400 | interpreted as real dimensions, not |
| 401 | default values. |
| 402 | ======================== ====================================== |
| 403 | ", "", |
| 404 | SetDimensions); |
| 405 | |
| 406 | |
| 407 | DocDeclStrName( |
| 408 | void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO), |
| 409 | "Sets the position and size of the window in pixels using a wx.Rect.", "", |
| 410 | SetRect); |
| 411 | |
| 412 | |
| 413 | DocDeclStrName( |
| 414 | void , SetSize( int width, int height ), |
| 415 | "Sets the size of the window in pixels.", "", |
| 416 | SetSizeWH); |
| 417 | |
| 418 | |
| 419 | DocDeclStr( |
| 420 | void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING), |
| 421 | "Moves the window to the given position.", ""); |
| 422 | |
| 423 | %pythoncode { SetPosition = Move } |
| 424 | |
| 425 | |
| 426 | DocDeclStrName( |
| 427 | void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING), |
| 428 | "Moves the window to the given position.", "", |
| 429 | MoveXY); |
| 430 | |
| 431 | DocDeclStr( |
| 432 | void , SetBestFittingSize(const wxSize& size=wxDefaultSize), |
| 433 | "A 'Smart' SetSize that will fill in default size components with the |
| 434 | window's *best size* values. Also set's the minsize for use with sizers.", ""); |
| 435 | |
| 436 | |
| 437 | |
| 438 | DocDeclStr( |
| 439 | virtual void , Raise(), |
| 440 | "Raises the window to the top of the window hierarchy if it is a |
| 441 | managed window (dialog or frame).", ""); |
| 442 | |
| 443 | DocDeclStr( |
| 444 | virtual void , Lower(), |
| 445 | "Lowers the window to the bottom of the window hierarchy if it is a |
| 446 | managed window (dialog or frame).", ""); |
| 447 | |
| 448 | |
| 449 | |
| 450 | // client size is the size of the area available for subwindows |
| 451 | DocStr(SetClientSize, |
| 452 | "This sets the size of the window client area in pixels. Using this |
| 453 | function to size a window tends to be more device-independent than |
| 454 | wx.Window.SetSize, since the application need not worry about what |
| 455 | dimensions the border or title bar have when trying to fit the window |
| 456 | around panel items, for example.", ""); |
| 457 | void SetClientSize( const wxSize& size ); |
| 458 | %Rename(SetClientSizeWH, void, SetClientSize( int width, int height )); |
| 459 | %Rename(SetClientRect, void, SetClientSize(const wxRect& rect)); |
| 460 | |
| 461 | |
| 462 | DocStr(GetPosition, // sets the docstring for both |
| 463 | "Get the window's position.", ""); |
| 464 | wxPoint GetPosition(); |
| 465 | |
| 466 | DocDeclAName( |
| 467 | void, GetPosition(int *OUTPUT, int *OUTPUT), |
| 468 | "GetPositionTuple() -> (x,y)", |
| 469 | GetPositionTuple); |
| 470 | |
| 471 | |
| 472 | DocStr(GetSize, "Get the window size.", ""); |
| 473 | wxSize GetSize() const; |
| 474 | DocDeclAName( |
| 475 | void, GetSize( int *OUTPUT, int *OUTPUT ) const, |
| 476 | "GetSizeTuple() -> (width, height)", |
| 477 | GetSizeTuple); |
| 478 | |
| 479 | |
| 480 | |
| 481 | DocDeclStr( |
| 482 | wxRect , GetRect() const, |
| 483 | "Returns the size and position of the window as a wx.Rect object.", ""); |
| 484 | |
| 485 | |
| 486 | DocStr(GetClientSize, |
| 487 | "This gets the size of the window's 'client area' in pixels. The client |
| 488 | area is the area which may be drawn on by the programmer, excluding |
| 489 | title bar, border, scrollbars, etc.", ""); |
| 490 | wxSize GetClientSize() const; |
| 491 | DocDeclAName( |
| 492 | void, GetClientSize( int *OUTPUT, int *OUTPUT ) const, |
| 493 | "GetClientSizeTuple() -> (width, height)", |
| 494 | GetClientSizeTuple); |
| 495 | |
| 496 | |
| 497 | |
| 498 | DocDeclStr( |
| 499 | virtual wxPoint , GetClientAreaOrigin() const, |
| 500 | "Get the origin of the client area of the window relative to the |
| 501 | window's top left corner (the client area may be shifted because of |
| 502 | the borders, scrollbars, other decorations...)", ""); |
| 503 | |
| 504 | |
| 505 | DocDeclStr( |
| 506 | wxRect , GetClientRect() const, |
| 507 | "Get the client area position and size as a `wx.Rect` object.", ""); |
| 508 | |
| 509 | |
| 510 | |
| 511 | DocStr(GetBestSize, |
| 512 | "This function returns the best acceptable minimal size for the |
| 513 | window, if applicable. For example, for a static text control, it will |
| 514 | be the minimal size such that the control label is not truncated. For |
| 515 | windows containing subwindows (suzh aswx.Panel), the size returned by |
| 516 | this function will be the same as the size the window would have had |
| 517 | after calling Fit.", ""); |
| 518 | wxSize GetBestSize() const; |
| 519 | DocDeclAName( |
| 520 | void, GetBestSize(int *OUTPUT, int *OUTPUT) const, |
| 521 | "GetBestSizeTuple() -> (width, height)", |
| 522 | GetBestSizeTuple); |
| 523 | |
| 524 | |
| 525 | DocDeclStr( |
| 526 | void , InvalidateBestSize(), |
| 527 | "Reset the cached best size value so it will be recalculated the next |
| 528 | time it is needed.", ""); |
| 529 | |
| 530 | |
| 531 | |
| 532 | DocDeclStr( |
| 533 | wxSize , GetBestFittingSize() const, |
| 534 | "This function will merge the window's best size into the window's |
| 535 | minimum size, giving priority to the min size components, and returns |
| 536 | the results. |
| 537 | ", ""); |
| 538 | |
| 539 | |
| 540 | DocDeclStr( |
| 541 | wxSize , GetAdjustedBestSize() const, |
| 542 | "This method is similar to GetBestSize, except in one |
| 543 | thing. GetBestSize should return the minimum untruncated size of the |
| 544 | window, while this method will return the largest of BestSize and any |
| 545 | user specified minimum size. ie. it is the minimum size the window |
| 546 | should currently be drawn at, not the minimal size it can possibly |
| 547 | tolerate.", ""); |
| 548 | |
| 549 | |
| 550 | |
| 551 | |
| 552 | DocDeclStr( |
| 553 | void , Center( int direction = wxBOTH ), |
| 554 | "Centers the window. The parameter specifies the direction for |
| 555 | cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may |
| 556 | also include wx.CENTER_ON_SCREEN flag if you want to center the window |
| 557 | on the entire screen and not on its parent window. If it is a |
| 558 | top-level window and has no parent then it will always be centered |
| 559 | relative to the screen.", ""); |
| 560 | |
| 561 | %pythoncode { Centre = Center } |
| 562 | |
| 563 | |
| 564 | DocDeclStr( |
| 565 | void , CenterOnScreen(int dir = wxBOTH), |
| 566 | "Center on screen (only works for top level windows)", ""); |
| 567 | %pythoncode { CentreOnScreen = CenterOnScreen } |
| 568 | |
| 569 | |
| 570 | DocDeclStr( |
| 571 | void , CenterOnParent(int dir = wxBOTH), |
| 572 | "Center with respect to the the parent window", ""); |
| 573 | %pythoncode { CentreOnParent = CenterOnParent } |
| 574 | |
| 575 | |
| 576 | |
| 577 | DocDeclStr( |
| 578 | virtual void , Fit(), |
| 579 | "Sizes the window so that it fits around its subwindows. This function |
| 580 | won't do anything if there are no subwindows and will only really work |
| 581 | correctly if sizers are used for the subwindows layout. Also, if the |
| 582 | window has exactly one subwindow it is better (faster and the result |
| 583 | is more precise as Fit adds some margin to account for fuzziness of |
| 584 | its calculations) to call window.SetClientSize(child.GetSize()) |
| 585 | instead of calling Fit.", ""); |
| 586 | |
| 587 | |
| 588 | DocDeclStr( |
| 589 | virtual void , FitInside(), |
| 590 | "Similar to Fit, but sizes the interior (virtual) size of a |
| 591 | window. Mainly useful with scrolled windows to reset scrollbars after |
| 592 | sizing changes that do not trigger a size event, and/or scrolled |
| 593 | windows without an interior sizer. This function similarly won't do |
| 594 | anything if there are no subwindows.", ""); |
| 595 | |
| 596 | |
| 597 | |
| 598 | DocStr(SetSizeHints, |
| 599 | "Allows specification of minimum and maximum window sizes, and window |
| 600 | size increments. If a pair of values is not set (or set to -1), the |
| 601 | default values will be used. If this function is called, the user |
| 602 | will not be able to size the window outside the given bounds (if it is |
| 603 | a top-level window.) Sizers will also inspect the minimum window size |
| 604 | and will use that value if set when calculating layout. |
| 605 | |
| 606 | The resizing increments are only significant under Motif or Xt.", " |
| 607 | |
| 608 | :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize` |
| 609 | "); |
| 610 | virtual void SetSizeHints( int minW, int minH, |
| 611 | int maxW = -1, int maxH = -1, |
| 612 | int incW = -1, int incH = -1 ); |
| 613 | %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize, |
| 614 | const wxSize& maxSize=wxDefaultSize, |
| 615 | const wxSize& incSize=wxDefaultSize)); |
| 616 | |
| 617 | |
| 618 | DocStr(SetVirtualSizeHints, |
| 619 | "Allows specification of minimum and maximum virtual window sizes. If a |
| 620 | pair of values is not set (or set to -1), the default values will be |
| 621 | used. If this function is called, the user will not be able to size |
| 622 | the virtual area of the window outside the given bounds.", ""); |
| 623 | virtual void SetVirtualSizeHints( int minW, int minH, |
| 624 | int maxW = -1, int maxH = -1 ); |
| 625 | %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints( |
| 626 | const wxSize& minSize, const wxSize& maxSize=wxDefaultSize)); |
| 627 | |
| 628 | |
| 629 | |
| 630 | DocDeclStr( |
| 631 | virtual wxSize , GetMaxSize() const, |
| 632 | "", ""); |
| 633 | |
| 634 | DocDeclStr( |
| 635 | virtual wxSize , GetMinSize() const, |
| 636 | "", ""); |
| 637 | |
| 638 | DocDeclStr( |
| 639 | void , SetMinSize(const wxSize& minSize), |
| 640 | "A more convenient method than `SetSizeHints` for setting just the |
| 641 | min size.", ""); |
| 642 | |
| 643 | DocDeclStr( |
| 644 | void , SetMaxSize(const wxSize& maxSize), |
| 645 | "A more convenient method than `SetSizeHints` for setting just the |
| 646 | max size.", ""); |
| 647 | |
| 648 | |
| 649 | |
| 650 | DocDeclStr( |
| 651 | virtual int , GetMinWidth() const, |
| 652 | "", ""); |
| 653 | |
| 654 | DocDeclStr( |
| 655 | virtual int , GetMinHeight() const, |
| 656 | "", ""); |
| 657 | |
| 658 | DocDeclStr( |
| 659 | int , GetMaxWidth() const, |
| 660 | "", ""); |
| 661 | |
| 662 | DocDeclStr( |
| 663 | int , GetMaxHeight() const, |
| 664 | "", ""); |
| 665 | |
| 666 | |
| 667 | |
| 668 | DocStr(SetVirtualSize, |
| 669 | "Set the the virtual size of a window in pixels. For most windows this |
| 670 | is just the client area of the window, but for some like scrolled |
| 671 | windows it is more or less independent of the screen window size.", ""); |
| 672 | void SetVirtualSize(const wxSize& size ); |
| 673 | %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h )); |
| 674 | |
| 675 | |
| 676 | DocStr(GetVirtualSize, |
| 677 | "Get the the virtual size of the window in pixels. For most windows |
| 678 | this is just the client area of the window, but for some like scrolled |
| 679 | windows it is more or less independent of the screen window size.", ""); |
| 680 | wxSize GetVirtualSize() const; |
| 681 | DocDeclAName( |
| 682 | void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const, |
| 683 | "GetVirtualSizeTuple() -> (width, height)", |
| 684 | GetVirtualSizeTuple); |
| 685 | |
| 686 | |
| 687 | // TODO: using directors? |
| 688 | // // Override these methods for windows that have a virtual size |
| 689 | // // independent of their client size. eg. the virtual area of a |
| 690 | // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize. |
| 691 | // virtual void DoSetVirtualSize( int x, int y ); |
| 692 | // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; } |
| 693 | |
| 694 | |
| 695 | DocDeclStr( |
| 696 | virtual wxSize , GetBestVirtualSize() const, |
| 697 | "Return the largest of ClientSize and BestSize (as determined by a |
| 698 | sizer, interior children, or other means)", ""); |
| 699 | |
| 700 | |
| 701 | |
| 702 | // window state |
| 703 | // ------------ |
| 704 | |
| 705 | DocDeclStr( |
| 706 | virtual bool , Show( bool show = true ), |
| 707 | "Shows or hides the window. You may need to call Raise for a top level |
| 708 | window if you want to bring it to top, although this is not needed if |
| 709 | Show is called immediately after the frame creation. Returns True if |
| 710 | the window has been shown or hidden or False if nothing was done |
| 711 | because it already was in the requested state.", ""); |
| 712 | |
| 713 | DocDeclStr( |
| 714 | bool , Hide(), |
| 715 | "Equivalent to calling Show(False).", ""); |
| 716 | |
| 717 | |
| 718 | DocDeclStr( |
| 719 | virtual bool , Enable( bool enable = true ), |
| 720 | "Enable or disable the window for user input. Note that when a parent |
| 721 | window is disabled, all of its children are disabled as well and they |
| 722 | are reenabled again when the parent is. Returns true if the window |
| 723 | has been enabled or disabled, false if nothing was done, i.e. if the |
| 724 | window had already been in the specified state.", ""); |
| 725 | |
| 726 | DocDeclStr( |
| 727 | bool , Disable(), |
| 728 | "Disables the window, same as Enable(false).", ""); |
| 729 | |
| 730 | |
| 731 | DocDeclStr( |
| 732 | bool , IsShown() const, |
| 733 | "Returns true if the window is shown, false if it has been hidden.", ""); |
| 734 | |
| 735 | DocDeclStr( |
| 736 | bool , IsEnabled() const, |
| 737 | "Returns true if the window is enabled for input, false otherwise.", ""); |
| 738 | |
| 739 | |
| 740 | |
| 741 | |
| 742 | DocDeclStr( |
| 743 | virtual void , SetWindowStyleFlag( long style ), |
| 744 | "Sets the style of the window. Please note that some styles cannot be |
| 745 | changed after the window creation and that Refresh() might need to be |
| 746 | called after changing the others for the change to take place |
| 747 | immediately.", ""); |
| 748 | |
| 749 | DocDeclStr( |
| 750 | virtual long , GetWindowStyleFlag() const, |
| 751 | "Gets the window style that was passed to the constructor or Create |
| 752 | method.", ""); |
| 753 | |
| 754 | %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag } |
| 755 | |
| 756 | |
| 757 | DocDeclStr( |
| 758 | bool , HasFlag(int flag) const, |
| 759 | "Test if the given style is set for this window.", ""); |
| 760 | |
| 761 | |
| 762 | DocDeclStr( |
| 763 | virtual bool , IsRetained() const, |
| 764 | "Returns true if the window is retained, false otherwise. Retained |
| 765 | windows are only available on X platforms.", ""); |
| 766 | |
| 767 | |
| 768 | |
| 769 | DocDeclStr( |
| 770 | virtual void , SetExtraStyle(long exStyle), |
| 771 | "Sets the extra style bits for the window. Extra styles are the less |
| 772 | often used style bits which can't be set with the constructor or with |
| 773 | SetWindowStyleFlag()", ""); |
| 774 | |
| 775 | DocDeclStr( |
| 776 | long , GetExtraStyle() const, |
| 777 | "Returns the extra style bits for the window.", ""); |
| 778 | |
| 779 | |
| 780 | |
| 781 | DocDeclStr( |
| 782 | virtual void , MakeModal(bool modal = true), |
| 783 | "Disables all other windows in the application so that the user can |
| 784 | only interact with this window. Passing False will reverse this |
| 785 | effect.", ""); |
| 786 | |
| 787 | |
| 788 | |
| 789 | DocDeclStr( |
| 790 | virtual void , SetThemeEnabled(bool enableTheme), |
| 791 | "This function tells a window if it should use the system's \"theme\" |
| 792 | code to draw the windows' background instead if its own background |
| 793 | drawing code. This will only have an effect on platforms that support |
| 794 | the notion of themes in user defined windows. One such platform is |
| 795 | GTK+ where windows can have (very colourful) backgrounds defined by a |
| 796 | user's selected theme. |
| 797 | |
| 798 | Dialogs, notebook pages and the status bar have this flag set to true |
| 799 | by default so that the default look and feel is simulated best.", ""); |
| 800 | |
| 801 | DocDeclStr( |
| 802 | virtual bool , GetThemeEnabled() const, |
| 803 | "Return the themeEnabled flag.", ""); |
| 804 | |
| 805 | |
| 806 | // TODO with directors |
| 807 | // // controls by default inherit the colours of their parents, if a |
| 808 | // // particular control class doesn't want to do it, it can override |
| 809 | // // ShouldInheritColours() to return False |
| 810 | // virtual bool ShouldInheritColours() const; |
| 811 | |
| 812 | |
| 813 | |
| 814 | |
| 815 | |
| 816 | // focus and keyboard handling |
| 817 | // --------------------------- |
| 818 | |
| 819 | |
| 820 | DocDeclStr( |
| 821 | virtual void , SetFocus(), |
| 822 | "Set's the focus to this window, allowing it to receive keyboard input.", ""); |
| 823 | |
| 824 | DocDeclStr( |
| 825 | virtual void , SetFocusFromKbd(), |
| 826 | "Set focus to this window as the result of a keyboard action. Normally |
| 827 | only called internally.", ""); |
| 828 | |
| 829 | |
| 830 | |
| 831 | DocDeclStr( |
| 832 | static wxWindow *, FindFocus(), |
| 833 | "Returns the window or control that currently has the keyboard focus, |
| 834 | or None.", ""); |
| 835 | |
| 836 | |
| 837 | DocDeclStr( |
| 838 | virtual bool , AcceptsFocus() const, |
| 839 | "Can this window have focus?", ""); |
| 840 | |
| 841 | |
| 842 | DocDeclStr( |
| 843 | virtual bool , AcceptsFocusFromKeyboard() const, |
| 844 | "Can this window be given focus by keyboard navigation? if not, the |
| 845 | only way to give it focus (provided it accepts it at all) is to click |
| 846 | it.", ""); |
| 847 | |
| 848 | |
| 849 | |
| 850 | |
| 851 | DocDeclStr( |
| 852 | virtual wxWindow *, GetDefaultItem() const, |
| 853 | "Get the default child of this parent, i.e. the one which is activated |
| 854 | by pressing <Enter> such as the OK button on a wx.Dialog.", ""); |
| 855 | |
| 856 | DocDeclStr( |
| 857 | virtual wxWindow *, SetDefaultItem(wxWindow * child), |
| 858 | "Set this child as default, return the old default.", ""); |
| 859 | |
| 860 | DocDeclStr( |
| 861 | virtual void , SetTmpDefaultItem(wxWindow * win), |
| 862 | "Set this child as temporary default", ""); |
| 863 | |
| 864 | |
| 865 | DocDeclAStr( |
| 866 | virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward), |
| 867 | "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool", |
| 868 | "Does keyboard navigation from this window to another, by sending a |
| 869 | `wx.NavigationKeyEvent`.", " |
| 870 | |
| 871 | :param flags: A combination of the ``IsForward`` or ``IsBackward`` |
| 872 | and the ``WinChange`` values in the `wx.NavigationKeyEvent` |
| 873 | class, which determine if the navigation should be in forward |
| 874 | or reverse order, and if it should be able to cross parent |
| 875 | window boundaries, such as between notebook pages or MDI child |
| 876 | frames. Typically the status of the Shift key (for forward or |
| 877 | backward) or the Control key (for WinChange) would be used to |
| 878 | determine how to set the flags. |
| 879 | |
| 880 | One situation in which you may wish to call this method is from a text |
| 881 | control custom keypress handler to do the default navigation behaviour |
| 882 | for the tab key, since the standard default behaviour for a multiline |
| 883 | text control with the wx.TE_PROCESS_TAB style is to insert a tab and |
| 884 | not navigate to the next control."); |
| 885 | |
| 886 | |
| 887 | |
| 888 | DocDeclStr( |
| 889 | void , MoveAfterInTabOrder(wxWindow *win), |
| 890 | "Moves this window in the tab navigation order after the specified |
| 891 | sibling window. This means that when the user presses the TAB key on |
| 892 | that other window, the focus switches to this window. |
| 893 | |
| 894 | The default tab order is the same as creation order. This function |
| 895 | and `MoveBeforeInTabOrder` allow to change it after creating all the |
| 896 | windows. |
| 897 | ", ""); |
| 898 | |
| 899 | |
| 900 | DocDeclStr( |
| 901 | void , MoveBeforeInTabOrder(wxWindow *win), |
| 902 | "Same as `MoveAfterInTabOrder` except that it inserts this window just |
| 903 | before win instead of putting it right after it.", ""); |
| 904 | |
| 905 | |
| 906 | |
| 907 | |
| 908 | |
| 909 | |
| 910 | |
| 911 | |
| 912 | // parent/children relations |
| 913 | // ------------------------- |
| 914 | |
| 915 | |
| 916 | //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList |
| 917 | %extend { |
| 918 | DocStr(GetChildren, |
| 919 | "Returns a list of the window's children. NOTE: Currently this is a |
| 920 | copy of the child window list maintained by the window, so the return |
| 921 | value of this function is only valid as long as the window's children |
| 922 | do not change.", ""); |
| 923 | PyObject* GetChildren() { |
| 924 | wxWindowList& list = self->GetChildren(); |
| 925 | return wxPy_ConvertList(&list); |
| 926 | } |
| 927 | } |
| 928 | |
| 929 | DocDeclStr( |
| 930 | wxWindow *, GetParent() const, |
| 931 | "Returns the parent window of this window, or None if there isn't one.", ""); |
| 932 | |
| 933 | DocDeclStr( |
| 934 | wxWindow *, GetGrandParent() const, |
| 935 | "Returns the parent of the parent of this window, or None if there |
| 936 | isn't one.", ""); |
| 937 | |
| 938 | |
| 939 | |
| 940 | DocDeclStr( |
| 941 | virtual bool , IsTopLevel() const, |
| 942 | "Returns true if the given window is a top-level one. Currently all |
| 943 | frames and dialogs are always considered to be top-level windows (even |
| 944 | if they have a parent window).", ""); |
| 945 | |
| 946 | |
| 947 | // change the real parent of this window, return True if the parent |
| 948 | // was changed, False otherwise (error or newParent == oldParent) |
| 949 | DocDeclStr( |
| 950 | virtual bool , Reparent( wxWindow *newParent ), |
| 951 | "Reparents the window, i.e the window will be removed from its current |
| 952 | parent window (e.g. a non-standard toolbar in a wxFrame) and then |
| 953 | re-inserted into another. Available on Windows and GTK. Returns True |
| 954 | if the parent was changed, False otherwise (error or newParent == |
| 955 | oldParent)", ""); |
| 956 | |
| 957 | |
| 958 | DocDeclStr( |
| 959 | virtual void , AddChild( wxWindow *child ), |
| 960 | "Adds a child window. This is called automatically by window creation |
| 961 | functions so should not be required by the application programmer.", ""); |
| 962 | |
| 963 | DocDeclStr( |
| 964 | virtual void , RemoveChild( wxWindow *child ), |
| 965 | "Removes a child window. This is called automatically by window |
| 966 | deletion functions so should not be required by the application |
| 967 | programmer.", ""); |
| 968 | |
| 969 | |
| 970 | |
| 971 | |
| 972 | // looking for windows |
| 973 | // ------------------- |
| 974 | |
| 975 | DocDeclStrName( |
| 976 | wxWindow *, FindWindow( long winid ), |
| 977 | "Find a chld of this window by window ID", "", |
| 978 | FindWindowById); |
| 979 | |
| 980 | DocDeclStrName( |
| 981 | wxWindow *, FindWindow( const wxString& name ), |
| 982 | "Find a child of this window by name", "", |
| 983 | FindWindowByName); |
| 984 | |
| 985 | |
| 986 | |
| 987 | // event handler stuff |
| 988 | // ------------------- |
| 989 | |
| 990 | DocDeclStr( |
| 991 | wxEvtHandler *, GetEventHandler() const, |
| 992 | "Returns the event handler for this window. By default, the window is |
| 993 | its own event handler.", ""); |
| 994 | |
| 995 | |
| 996 | DocDeclStr( |
| 997 | void , SetEventHandler( wxEvtHandler *handler ), |
| 998 | "Sets the event handler for this window. An event handler is an object |
| 999 | that is capable of processing the events sent to a window. By default, |
| 1000 | the window is its own event handler, but an application may wish to |
| 1001 | substitute another, for example to allow central implementation of |
| 1002 | event-handling for a variety of different window classes. |
| 1003 | |
| 1004 | It is usually better to use `wx.Window.PushEventHandler` since this sets |
| 1005 | up a chain of event handlers, where an event not handled by one event |
| 1006 | handler is handed to the next one in the chain.", ""); |
| 1007 | |
| 1008 | |
| 1009 | DocDeclStr( |
| 1010 | void , PushEventHandler( wxEvtHandler *handler ), |
| 1011 | "Pushes this event handler onto the event handler stack for the window. |
| 1012 | An event handler is an object that is capable of processing the events |
| 1013 | sent to a window. By default, the window is its own event handler, but |
| 1014 | an application may wish to substitute another, for example to allow |
| 1015 | central implementation of event-handling for a variety of different |
| 1016 | window classes. |
| 1017 | |
| 1018 | wx.Window.PushEventHandler allows an application to set up a chain of |
| 1019 | event handlers, where an event not handled by one event handler is |
| 1020 | handed to the next one in the chain. Use `wx.Window.PopEventHandler` to |
| 1021 | remove the event handler.", ""); |
| 1022 | |
| 1023 | |
| 1024 | DocDeclStr( |
| 1025 | wxEvtHandler *, PopEventHandler( bool deleteHandler = false ), |
| 1026 | "Removes and returns the top-most event handler on the event handler |
| 1027 | stack. If deleteHandler is True then the wx.EvtHandler object will be |
| 1028 | destroyed after it is popped.", ""); |
| 1029 | |
| 1030 | |
| 1031 | DocDeclStr( |
| 1032 | bool , RemoveEventHandler(wxEvtHandler *handler), |
| 1033 | "Find the given handler in the event handler chain and remove (but not |
| 1034 | delete) it from the event handler chain, return True if it was found |
| 1035 | and False otherwise (this also results in an assert failure so this |
| 1036 | function should only be called when the handler is supposed to be |
| 1037 | there.)", ""); |
| 1038 | |
| 1039 | |
| 1040 | |
| 1041 | |
| 1042 | // validators |
| 1043 | // ---------- |
| 1044 | |
| 1045 | // a window may have an associated validator which is used to control |
| 1046 | // user input |
| 1047 | DocDeclStr( |
| 1048 | virtual void , SetValidator( const wxValidator &validator ), |
| 1049 | "Deletes the current validator (if any) and sets the window validator, |
| 1050 | having called wx.Validator.Clone to create a new validator of this |
| 1051 | type.", ""); |
| 1052 | |
| 1053 | DocDeclStr( |
| 1054 | virtual wxValidator *, GetValidator(), |
| 1055 | "Returns a pointer to the current validator for the window, or None if |
| 1056 | there is none.", ""); |
| 1057 | |
| 1058 | |
| 1059 | DocDeclStr( |
| 1060 | virtual bool , Validate(), |
| 1061 | "Validates the current values of the child controls using their |
| 1062 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra |
| 1063 | style flag set, the method will also call Validate() of all child |
| 1064 | windows. Returns false if any of the validations failed.", ""); |
| 1065 | |
| 1066 | |
| 1067 | DocDeclStr( |
| 1068 | virtual bool , TransferDataToWindow(), |
| 1069 | "Transfers values to child controls from data areas specified by their |
| 1070 | validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra |
| 1071 | style flag set, the method will also call TransferDataToWindow() of |
| 1072 | all child windows.", ""); |
| 1073 | |
| 1074 | DocDeclStr( |
| 1075 | virtual bool , TransferDataFromWindow(), |
| 1076 | "Transfers values from child controls to data areas specified by their |
| 1077 | validators. Returns false if a transfer failed. If the window has |
| 1078 | wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will |
| 1079 | also call TransferDataFromWindow() of all child windows.", ""); |
| 1080 | |
| 1081 | |
| 1082 | DocDeclStr( |
| 1083 | virtual void , InitDialog(), |
| 1084 | "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data |
| 1085 | to the dialog via validators.", ""); |
| 1086 | |
| 1087 | |
| 1088 | |
| 1089 | |
| 1090 | // accelerators |
| 1091 | // ------------ |
| 1092 | |
| 1093 | DocDeclStr( |
| 1094 | virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ), |
| 1095 | "Sets the accelerator table for this window.", ""); |
| 1096 | |
| 1097 | DocDeclStr( |
| 1098 | wxAcceleratorTable *, GetAcceleratorTable(), |
| 1099 | "Gets the accelerator table for this window.", ""); |
| 1100 | |
| 1101 | |
| 1102 | |
| 1103 | |
| 1104 | |
| 1105 | // hot keys (system wide accelerators) |
| 1106 | // ----------------------------------- |
| 1107 | %extend { |
| 1108 | DocStr(RegisterHotKey, |
| 1109 | "Registers a system wide hotkey. Every time the user presses the hotkey |
| 1110 | registered here, this window will receive a hotkey event. It will |
| 1111 | receive the event even if the application is in the background and |
| 1112 | does not have the input focus because the user is working with some |
| 1113 | other application. To bind an event handler function to this hotkey |
| 1114 | use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the |
| 1115 | hotkey was registered successfully.", ""); |
| 1116 | bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) { |
| 1117 | %#if wxUSE_HOTKEY |
| 1118 | return self->RegisterHotKey(hotkeyId, modifiers, keycode); |
| 1119 | %#else |
| 1120 | return false; |
| 1121 | %#endif |
| 1122 | } |
| 1123 | |
| 1124 | |
| 1125 | DocStr(UnregisterHotKey, |
| 1126 | "Unregisters a system wide hotkey.", ""); |
| 1127 | bool UnregisterHotKey(int hotkeyId) { |
| 1128 | #if wxUSE_HOTKEY |
| 1129 | return self->UnregisterHotKey(hotkeyId); |
| 1130 | #else |
| 1131 | return false; |
| 1132 | #endif |
| 1133 | } |
| 1134 | } |
| 1135 | |
| 1136 | |
| 1137 | |
| 1138 | // "dialog units" translations |
| 1139 | // --------------------------- |
| 1140 | |
| 1141 | DocStr(ConvertDialogToPixels, |
| 1142 | "Converts a point or size from dialog units to pixels. Dialog units |
| 1143 | are used for maintaining a dialog's proportions even if the font |
| 1144 | changes. For the x dimension, the dialog units are multiplied by the |
| 1145 | average character width and then divided by 4. For the y dimension, |
| 1146 | the dialog units are multiplied by the average character height and |
| 1147 | then divided by 8.", ""); |
| 1148 | %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt)); |
| 1149 | %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz)); |
| 1150 | %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt)); |
| 1151 | %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz)); |
| 1152 | |
| 1153 | |
| 1154 | DocStr(ConvertPixelPointToDialog, |
| 1155 | "Converts a point or size from pixels to dialog units. Dialog units |
| 1156 | are used for maintaining a dialog's proportions even if the font |
| 1157 | changes. For the x dimension, the dialog units are multiplied by the |
| 1158 | average character width and then divided by 4. For the y dimension, |
| 1159 | the dialog units are multiplied by the average character height and |
| 1160 | then divided by 8.", ""); |
| 1161 | %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt)); |
| 1162 | %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz)); |
| 1163 | |
| 1164 | |
| 1165 | |
| 1166 | // mouse functions |
| 1167 | // --------------- |
| 1168 | |
| 1169 | DocDeclStr( |
| 1170 | virtual void , WarpPointer(int x, int y), |
| 1171 | "Moves the pointer to the given position on the window. |
| 1172 | |
| 1173 | NOTE: This function is not supported under Mac because Apple Human |
| 1174 | Interface Guidelines forbid moving the mouse cursor programmatically.", ""); |
| 1175 | |
| 1176 | |
| 1177 | DocDeclStr( |
| 1178 | void , CaptureMouse(), |
| 1179 | "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to |
| 1180 | release the capture. |
| 1181 | |
| 1182 | Note that wxWindows maintains the stack of windows having captured the |
| 1183 | mouse and when the mouse is released the capture returns to the window |
| 1184 | which had had captured it previously and it is only really released if |
| 1185 | there were no previous window. In particular, this means that you must |
| 1186 | release the mouse as many times as you capture it.", ""); |
| 1187 | |
| 1188 | DocDeclStr( |
| 1189 | void , ReleaseMouse(), |
| 1190 | "Releases mouse input captured with wx.Window.CaptureMouse.", ""); |
| 1191 | |
| 1192 | |
| 1193 | DocDeclStr( |
| 1194 | static wxWindow *, GetCapture(), |
| 1195 | "Returns the window which currently captures the mouse or None", ""); |
| 1196 | |
| 1197 | |
| 1198 | DocDeclStr( |
| 1199 | virtual bool , HasCapture() const, |
| 1200 | "Returns true if this window has the current mouse capture.", ""); |
| 1201 | |
| 1202 | |
| 1203 | |
| 1204 | |
| 1205 | |
| 1206 | // painting the window |
| 1207 | // ------------------- |
| 1208 | |
| 1209 | DocDeclStr( |
| 1210 | virtual void , Refresh( bool eraseBackground = true, |
| 1211 | const wxRect *rect = NULL ), |
| 1212 | "Mark the specified rectangle (or the whole window) as \"dirty\" so it |
| 1213 | will be repainted. Causes an EVT_PAINT event to be generated and sent |
| 1214 | to the window.", ""); |
| 1215 | |
| 1216 | |
| 1217 | DocDeclStr( |
| 1218 | void , RefreshRect(const wxRect& rect), |
| 1219 | "Redraws the contents of the given rectangle: the area inside it will |
| 1220 | be repainted. This is the same as Refresh but has a nicer syntax.", ""); |
| 1221 | |
| 1222 | |
| 1223 | DocDeclStr( |
| 1224 | virtual void , Update(), |
| 1225 | "Calling this method immediately repaints the invalidated area of the |
| 1226 | window instead of waiting for the EVT_PAINT event to happen, (normally |
| 1227 | this would usually only happen when the flow of control returns to the |
| 1228 | event loop.) Notice that this function doesn't refresh the window and |
| 1229 | does nothing if the window has been already repainted. Use Refresh |
| 1230 | first if you want to immediately redraw the window (or some portion of |
| 1231 | it) unconditionally.", ""); |
| 1232 | |
| 1233 | |
| 1234 | DocDeclStr( |
| 1235 | virtual void , ClearBackground(), |
| 1236 | "Clears the window by filling it with the current background |
| 1237 | colour. Does not cause an erase background event to be generated.", ""); |
| 1238 | |
| 1239 | |
| 1240 | |
| 1241 | DocDeclStr( |
| 1242 | virtual void , Freeze(), |
| 1243 | "Freezes the window or, in other words, prevents any updates from |
| 1244 | taking place on screen, the window is not redrawn at all. Thaw must be |
| 1245 | called to reenable window redrawing. Calls to Freeze/Thaw may be |
| 1246 | nested, with the actual Thaw being delayed until all the nesting has |
| 1247 | been undone. |
| 1248 | |
| 1249 | This method is useful for visual appearance optimization (for example, |
| 1250 | it is a good idea to use it before inserting large amount of text into |
| 1251 | a wxTextCtrl under wxGTK) but is not implemented on all platforms nor |
| 1252 | for all controls so it is mostly just a hint to wxWindows and not a |
| 1253 | mandatory directive.", ""); |
| 1254 | |
| 1255 | |
| 1256 | DocDeclStr( |
| 1257 | virtual void , Thaw(), |
| 1258 | "Reenables window updating after a previous call to Freeze. Calls to |
| 1259 | Freeze/Thaw may be nested, so Thaw must be called the same number of |
| 1260 | times that Freeze was before the window will be updated.", ""); |
| 1261 | |
| 1262 | |
| 1263 | DocDeclStr( |
| 1264 | virtual void , PrepareDC( wxDC & dc ), |
| 1265 | "Call this function to prepare the device context for drawing a |
| 1266 | scrolled image. It sets the device origin according to the current |
| 1267 | scroll position.", ""); |
| 1268 | |
| 1269 | |
| 1270 | DocDeclStr( |
| 1271 | wxRegion& , GetUpdateRegion(), |
| 1272 | "Returns the region specifying which parts of the window have been |
| 1273 | damaged. Should only be called within an EVT_PAINT handler.", ""); |
| 1274 | |
| 1275 | |
| 1276 | DocDeclStr( |
| 1277 | wxRect , GetUpdateClientRect() const, |
| 1278 | "Get the update rectangle region bounding box in client coords.", ""); |
| 1279 | |
| 1280 | |
| 1281 | DocStr(IsExposed, |
| 1282 | "Returns true if the given point or rectangle area has been exposed |
| 1283 | since the last repaint. Call this in an paint event handler to |
| 1284 | optimize redrawing by only redrawing those areas, which have been |
| 1285 | exposed.", ""); |
| 1286 | bool IsExposed( int x, int y, int w=1, int h=1 ) const; |
| 1287 | %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const); |
| 1288 | %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const); |
| 1289 | |
| 1290 | |
| 1291 | |
| 1292 | // colours, fonts and cursors |
| 1293 | // -------------------------- |
| 1294 | |
| 1295 | |
| 1296 | DocDeclStr( |
| 1297 | virtual wxVisualAttributes , GetDefaultAttributes() const, |
| 1298 | "Get the default attributes for an instance of this class. This is |
| 1299 | useful if you want to use the same font or colour in your own control |
| 1300 | as in a standard control -- which is a much better idea than hard |
| 1301 | coding specific colours or fonts which might look completely out of |
| 1302 | place on the user's system, especially if it uses themes.", ""); |
| 1303 | |
| 1304 | |
| 1305 | DocDeclStr( |
| 1306 | static wxVisualAttributes , |
| 1307 | GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL), |
| 1308 | "Get the default attributes for this class. This is useful if you want |
| 1309 | to use the same font or colour in your own control as in a standard |
| 1310 | control -- which is a much better idea than hard coding specific |
| 1311 | colours or fonts which might look completely out of place on the |
| 1312 | user's system, especially if it uses themes. |
| 1313 | |
| 1314 | The variant parameter is only relevant under Mac currently and is |
| 1315 | ignore under other platforms. Under Mac, it will change the size of |
| 1316 | the returned font. See `wx.Window.SetWindowVariant` for more about |
| 1317 | this.", ""); |
| 1318 | |
| 1319 | |
| 1320 | DocDeclStr( |
| 1321 | virtual bool , SetBackgroundColour( const wxColour &colour ), |
| 1322 | "Sets the background colour of the window. Returns True if the colour |
| 1323 | was changed. The background colour is usually painted by the default |
| 1324 | EVT_ERASE_BACKGROUND event handler function under Windows and |
| 1325 | automatically under GTK. Using `wx.NullColour` will reset the window |
| 1326 | to the default background colour. |
| 1327 | |
| 1328 | Note that setting the background colour may not cause an immediate |
| 1329 | refresh, so you may wish to call `ClearBackground` or `Refresh` after |
| 1330 | calling this function. |
| 1331 | |
| 1332 | Using this function will disable attempts to use themes for this |
| 1333 | window, if the system supports them. Use with care since usually the |
| 1334 | themes represent the appearance chosen by the user to be used for all |
| 1335 | applications on the system.", ""); |
| 1336 | |
| 1337 | DocDeclStr( |
| 1338 | void , SetOwnBackgroundColour(const wxColour& colour), |
| 1339 | "", ""); |
| 1340 | |
| 1341 | |
| 1342 | |
| 1343 | DocDeclStr( |
| 1344 | virtual bool , SetForegroundColour( const wxColour &colour ), |
| 1345 | "Sets the foreground colour of the window. Returns True is the colour |
| 1346 | was changed. The interpretation of foreground colour is dependent on |
| 1347 | the window class; it may be the text colour or other colour, or it may |
| 1348 | not be used at all.", ""); |
| 1349 | |
| 1350 | DocDeclStr( |
| 1351 | void , SetOwnForegroundColour(const wxColour& colour), |
| 1352 | "", ""); |
| 1353 | |
| 1354 | |
| 1355 | |
| 1356 | DocDeclStr( |
| 1357 | wxColour , GetBackgroundColour() const, |
| 1358 | "Returns the background colour of the window.", ""); |
| 1359 | |
| 1360 | DocDeclStr( |
| 1361 | wxColour , GetForegroundColour() const, |
| 1362 | "Returns the foreground colour of the window. The interpretation of |
| 1363 | foreground colour is dependent on the window class; it may be the text |
| 1364 | colour or other colour, or it may not be used at all.", ""); |
| 1365 | |
| 1366 | // TODO: |
| 1367 | // // if the window shouldn't inherit its colour from the parent, override |
| 1368 | // // this function to return true |
| 1369 | // // |
| 1370 | // // this is currently only used by wxMSW and wxUniv but should be useful for |
| 1371 | // // the other ports too |
| 1372 | // virtual bool ProvidesBackground() const; |
| 1373 | |
| 1374 | |
| 1375 | // Set/get the background style. |
| 1376 | // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM |
| 1377 | DocDeclStr( |
| 1378 | virtual bool , SetBackgroundStyle(wxBackgroundStyle style), |
| 1379 | "Returns the background style of the window. The background style |
| 1380 | indicates how the background of the window is drawn. |
| 1381 | |
| 1382 | ====================== ======================================== |
| 1383 | wx.BG_STYLE_SYSTEM The background colour or pattern should |
| 1384 | be determined by the system |
| 1385 | wx.BG_STYLE_COLOUR The background should be a solid colour |
| 1386 | wx.BG_STYLE_CUSTOM The background will be implemented by the |
| 1387 | application. |
| 1388 | ====================== ======================================== |
| 1389 | |
| 1390 | On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of |
| 1391 | a custom background, such as a tiled bitmap. Currently the style has |
| 1392 | no effect on other platforms. |
| 1393 | |
| 1394 | :see: `GetBackgroundStyle`, `SetBackgroundColour`", ""); |
| 1395 | |
| 1396 | DocDeclStr( |
| 1397 | virtual wxBackgroundStyle , GetBackgroundStyle() const, |
| 1398 | "Returns the background style of the window. |
| 1399 | |
| 1400 | :see: `SetBackgroundStyle`", ""); |
| 1401 | |
| 1402 | |
| 1403 | DocDeclStr( |
| 1404 | bool , HasTransparentBackground(), |
| 1405 | "Returns True if this window's background is transparent (as, for |
| 1406 | example, for `wx.StaticText`) and should show the parent window's |
| 1407 | background. |
| 1408 | |
| 1409 | This method is mostly used internally by the library itself and you |
| 1410 | normally shouldn't have to call it. You may, however, have to override |
| 1411 | it in your custom control classes to ensure that background is painted |
| 1412 | correctly.", ""); |
| 1413 | |
| 1414 | |
| 1415 | DocDeclStr( |
| 1416 | virtual bool , SetCursor( const wxCursor &cursor ), |
| 1417 | "Sets the window's cursor. Notice that the window cursor also sets it |
| 1418 | for the children of the window implicitly. |
| 1419 | |
| 1420 | The cursor may be wx.NullCursor in which case the window cursor will |
| 1421 | be reset back to default.", ""); |
| 1422 | |
| 1423 | DocDeclStr( |
| 1424 | wxCursor , GetCursor(), |
| 1425 | "Return the cursor associated with this window.", ""); |
| 1426 | |
| 1427 | |
| 1428 | |
| 1429 | DocDeclStr( |
| 1430 | virtual bool , SetFont( const wxFont &font ), |
| 1431 | "Sets the font for this window.", ""); |
| 1432 | |
| 1433 | DocDeclStr( |
| 1434 | void , SetOwnFont(const wxFont& font), |
| 1435 | "", ""); |
| 1436 | |
| 1437 | |
| 1438 | |
| 1439 | DocDeclStr( |
| 1440 | wxFont , GetFont(), |
| 1441 | "Returns the default font used for this window.", ""); |
| 1442 | |
| 1443 | |
| 1444 | |
| 1445 | DocDeclStr( |
| 1446 | void , SetCaret(wxCaret *caret), |
| 1447 | "Sets the caret associated with the window.", ""); |
| 1448 | |
| 1449 | DocDeclStr( |
| 1450 | wxCaret *, GetCaret() const, |
| 1451 | "Returns the caret associated with the window.", ""); |
| 1452 | |
| 1453 | |
| 1454 | |
| 1455 | DocDeclStr( |
| 1456 | virtual int , GetCharHeight() const, |
| 1457 | "Get the (average) character size for the current font.", ""); |
| 1458 | |
| 1459 | DocDeclStr( |
| 1460 | virtual int , GetCharWidth() const, |
| 1461 | "Get the (average) character size for the current font.", ""); |
| 1462 | |
| 1463 | |
| 1464 | |
| 1465 | DocDeclAStr( |
| 1466 | void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT), |
| 1467 | "GetTextExtent(String string) -> (width, height)", |
| 1468 | "Get the width and height of the text using the current font.", ""); |
| 1469 | DocDeclAStrName( |
| 1470 | void, GetTextExtent(const wxString& string, |
| 1471 | int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT, |
| 1472 | const wxFont* font = NULL), |
| 1473 | "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)", |
| 1474 | "Get the width, height, decent and leading of the text using the |
| 1475 | current or specified font.", "", |
| 1476 | GetFullTextExtent); |
| 1477 | |
| 1478 | |
| 1479 | |
| 1480 | // client <-> screen coords |
| 1481 | // ------------------------ |
| 1482 | |
| 1483 | %apply int * INOUT { int* x, int* y }; |
| 1484 | |
| 1485 | // translate to/from screen/client coordinates |
| 1486 | DocDeclAStrName( |
| 1487 | void , ClientToScreen( int *x, int *y ) const, |
| 1488 | "ClientToScreenXY(int x, int y) -> (x,y)", |
| 1489 | "Converts to screen coordinates from coordinates relative to this window.", "", |
| 1490 | ClientToScreenXY); |
| 1491 | |
| 1492 | DocDeclAStrName( |
| 1493 | void , ScreenToClient( int *x, int *y ) const, |
| 1494 | "ScreenToClientXY(int x, int y) -> (x,y)", |
| 1495 | "Converts from screen to client window coordinates.", "", |
| 1496 | ScreenToClientXY); |
| 1497 | |
| 1498 | |
| 1499 | DocDeclStr( |
| 1500 | wxPoint , ClientToScreen(const wxPoint& pt) const, |
| 1501 | "Converts to screen coordinates from coordinates relative to this window.", ""); |
| 1502 | |
| 1503 | DocDeclStr( |
| 1504 | wxPoint , ScreenToClient(const wxPoint& pt) const, |
| 1505 | "Converts from screen to client window coordinates.", ""); |
| 1506 | |
| 1507 | |
| 1508 | |
| 1509 | DocDeclStrName( |
| 1510 | wxHitTest , HitTest(wxCoord x, wxCoord y) const, |
| 1511 | "Test where the given (in client coords) point lies", "", |
| 1512 | HitTestXY); |
| 1513 | |
| 1514 | DocDeclStr( |
| 1515 | wxHitTest , HitTest(const wxPoint& pt) const, |
| 1516 | "Test where the given (in client coords) point lies", ""); |
| 1517 | |
| 1518 | |
| 1519 | |
| 1520 | |
| 1521 | // misc |
| 1522 | // ---- |
| 1523 | |
| 1524 | %nokwargs GetBorder; |
| 1525 | DocDeclStr( |
| 1526 | wxBorder , GetBorder(long flags) const, |
| 1527 | "Get the window border style from the given flags: this is different |
| 1528 | from simply doing flags & wxBORDER_MASK because it uses |
| 1529 | GetDefaultBorder() to translate wxBORDER_DEFAULT to something |
| 1530 | reasonable. |
| 1531 | ", ""); |
| 1532 | |
| 1533 | DocDeclStr( |
| 1534 | wxBorder , GetBorder() const, |
| 1535 | "Get border for the flags of this window", ""); |
| 1536 | |
| 1537 | |
| 1538 | |
| 1539 | |
| 1540 | DocDeclStr( |
| 1541 | virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE), |
| 1542 | "This function sends EVT_UPDATE_UI events to the window. The particular |
| 1543 | implementation depends on the window; for example a wx.ToolBar will |
| 1544 | send an update UI event for each toolbar button, and a wx.Frame will |
| 1545 | send an update UI event for each menubar menu item. You can call this |
| 1546 | function from your application to ensure that your UI is up-to-date at |
| 1547 | a particular point in time (as far as your EVT_UPDATE_UI handlers are |
| 1548 | concerned). This may be necessary if you have called |
| 1549 | wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to |
| 1550 | limit the overhead that wxWindows incurs by sending update UI events |
| 1551 | in idle time.", |
| 1552 | " |
| 1553 | The flags should be a bitlist of one or more of the following values: |
| 1554 | |
| 1555 | ===================== ============================== |
| 1556 | wx.UPDATE_UI_NONE No particular value |
| 1557 | wx.UPDATE_UI_RECURSE Call the function for descendants |
| 1558 | wx.UPDATE_UI_FROMIDLE Invoked from OnIdle |
| 1559 | ===================== ============================== |
| 1560 | |
| 1561 | If you are calling this function from an OnIdle function, make sure |
| 1562 | you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window |
| 1563 | to only update the UI elements that need to be updated in idle |
| 1564 | time. Some windows update their elements only when necessary, for |
| 1565 | example when a menu is about to be shown. The following is an example |
| 1566 | of how to call UpdateWindowUI from an idle function:: |
| 1567 | |
| 1568 | def OnIdle(self, evt): |
| 1569 | if wx.UpdateUIEvent.CanUpdate(self): |
| 1570 | self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE); |
| 1571 | "); |
| 1572 | |
| 1573 | |
| 1574 | // TODO: using directors? |
| 1575 | // // do the window-specific processing after processing the update event |
| 1576 | // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ; |
| 1577 | |
| 1578 | |
| 1579 | DocStr(PopupMenu, |
| 1580 | "Pops up the given menu at the specified coordinates, relative to this window, |
| 1581 | and returns control when the user has dismissed the menu. If a menu item is |
| 1582 | selected, the corresponding menu event is generated and will be processed as |
| 1583 | usual. If the default position is given then the current position of the |
| 1584 | mouse cursor will be used.", ""); |
| 1585 | %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1)); |
| 1586 | bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition); |
| 1587 | |
| 1588 | |
| 1589 | |
| 1590 | |
| 1591 | %extend { |
| 1592 | DocStr(GetHandle, |
| 1593 | "Returns the platform-specific handle (as a long integer) of the |
| 1594 | physical window. Currently on wxMac it returns the handle of the |
| 1595 | toplevel parent of the window.", ""); |
| 1596 | long GetHandle() { |
| 1597 | return wxPyGetWinHandle(self); |
| 1598 | } |
| 1599 | } |
| 1600 | |
| 1601 | DocStr( |
| 1602 | AssociateHandle, |
| 1603 | "Associate the window with a new native handle", ""); |
| 1604 | %extend { |
| 1605 | void AssociateHandle(long handle) { |
| 1606 | self->AssociateHandle((WXWidget)handle); |
| 1607 | } |
| 1608 | } |
| 1609 | |
| 1610 | |
| 1611 | DocDeclStr( |
| 1612 | virtual void , DissociateHandle(), |
| 1613 | "Dissociate the current native handle from the window", ""); |
| 1614 | |
| 1615 | |
| 1616 | |
| 1617 | #ifdef __WXMSW__ |
| 1618 | // A way to do the native draw first... Too bad it isn't in wxGTK too. |
| 1619 | void OnPaint(wxPaintEvent& event); |
| 1620 | #endif |
| 1621 | |
| 1622 | |
| 1623 | |
| 1624 | // scrollbars |
| 1625 | // ---------- |
| 1626 | |
| 1627 | |
| 1628 | DocDeclStr( |
| 1629 | bool , HasScrollbar(int orient) const, |
| 1630 | "Does the window have the scrollbar for this orientation?", ""); |
| 1631 | |
| 1632 | |
| 1633 | // configure the window scrollbars |
| 1634 | DocDeclStr( |
| 1635 | virtual void , SetScrollbar( int orientation, |
| 1636 | int position, |
| 1637 | int thumbSize, |
| 1638 | int range, |
| 1639 | bool refresh = true ), |
| 1640 | "Sets the scrollbar properties of a built-in scrollbar.", |
| 1641 | " |
| 1642 | :param orientation: Determines the scrollbar whose page size is to |
| 1643 | be set. May be wx.HORIZONTAL or wx.VERTICAL. |
| 1644 | |
| 1645 | :param position: The position of the scrollbar in scroll units. |
| 1646 | |
| 1647 | :param thumbSize: The size of the thumb, or visible portion of the |
| 1648 | scrollbar, in scroll units. |
| 1649 | |
| 1650 | :param range: The maximum position of the scrollbar. |
| 1651 | |
| 1652 | :param refresh: True to redraw the scrollbar, false otherwise. |
| 1653 | "); |
| 1654 | |
| 1655 | DocDeclStr( |
| 1656 | virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ), |
| 1657 | "Sets the position of one of the built-in scrollbars.", ""); |
| 1658 | |
| 1659 | DocDeclStr( |
| 1660 | virtual int , GetScrollPos( int orientation ) const, |
| 1661 | "Returns the built-in scrollbar position.", ""); |
| 1662 | |
| 1663 | DocDeclStr( |
| 1664 | virtual int , GetScrollThumb( int orientation ) const, |
| 1665 | "Returns the built-in scrollbar thumb size.", ""); |
| 1666 | |
| 1667 | DocDeclStr( |
| 1668 | virtual int , GetScrollRange( int orientation ) const, |
| 1669 | "Returns the built-in scrollbar range.", ""); |
| 1670 | |
| 1671 | |
| 1672 | |
| 1673 | |
| 1674 | DocDeclStr( |
| 1675 | virtual void , ScrollWindow( int dx, int dy, |
| 1676 | const wxRect* rect = NULL ), |
| 1677 | "Physically scrolls the pixels in the window and move child windows |
| 1678 | accordingly. Use this function to optimise your scrolling |
| 1679 | implementations, to minimise the area that must be redrawn. Note that |
| 1680 | it is rarely required to call this function from a user program.", |
| 1681 | " |
| 1682 | :param dx: Amount to scroll horizontally. |
| 1683 | |
| 1684 | :param dy: Amount to scroll vertically. |
| 1685 | |
| 1686 | :param rect: Rectangle to invalidate. If this is None, the whole |
| 1687 | window is invalidated. If you pass a rectangle corresponding |
| 1688 | to the area of the window exposed by the scroll, your |
| 1689 | painting handler can optimize painting by checking for the |
| 1690 | invalidated region."); |
| 1691 | |
| 1692 | |
| 1693 | DocDeclStr( |
| 1694 | virtual bool , ScrollLines(int lines), |
| 1695 | "If the platform and window class supports it, scrolls the window by |
| 1696 | the given number of lines down, if lines is positive, or up if lines |
| 1697 | is negative. Returns True if the window was scrolled, False if it was |
| 1698 | already on top/bottom and nothing was done.", ""); |
| 1699 | |
| 1700 | DocDeclStr( |
| 1701 | virtual bool , ScrollPages(int pages), |
| 1702 | "If the platform and window class supports it, scrolls the window by |
| 1703 | the given number of pages down, if pages is positive, or up if pages |
| 1704 | is negative. Returns True if the window was scrolled, False if it was |
| 1705 | already on top/bottom and nothing was done.", ""); |
| 1706 | |
| 1707 | |
| 1708 | DocDeclStr( |
| 1709 | bool , LineUp(), |
| 1710 | "This is just a wrapper for ScrollLines(-1).", ""); |
| 1711 | |
| 1712 | DocDeclStr( |
| 1713 | bool , LineDown(), |
| 1714 | "This is just a wrapper for ScrollLines(1).", ""); |
| 1715 | |
| 1716 | DocDeclStr( |
| 1717 | bool , PageUp(), |
| 1718 | "This is just a wrapper for ScrollPages(-1).", ""); |
| 1719 | |
| 1720 | DocDeclStr( |
| 1721 | bool , PageDown(), |
| 1722 | "This is just a wrapper for ScrollPages(1).", ""); |
| 1723 | |
| 1724 | |
| 1725 | |
| 1726 | |
| 1727 | // context-sensitive help |
| 1728 | // ---------------------- |
| 1729 | |
| 1730 | DocDeclStr( |
| 1731 | void , SetHelpText(const wxString& text), |
| 1732 | "Sets the help text to be used as context-sensitive help for this |
| 1733 | window. Note that the text is actually stored by the current |
| 1734 | wxHelpProvider implementation, and not in the window object itself.", ""); |
| 1735 | |
| 1736 | |
| 1737 | DocDeclStr( |
| 1738 | void , SetHelpTextForId(const wxString& text), |
| 1739 | "Associate this help text with all windows with the same id as this |
| 1740 | one.", ""); |
| 1741 | |
| 1742 | |
| 1743 | DocDeclStr( |
| 1744 | wxString , GetHelpText() const, |
| 1745 | "Gets the help text to be used as context-sensitive help for this |
| 1746 | window. Note that the text is actually stored by the current |
| 1747 | wxHelpProvider implementation, and not in the window object itself.", ""); |
| 1748 | |
| 1749 | |
| 1750 | |
| 1751 | #ifndef __WXX11__ |
| 1752 | // tooltips |
| 1753 | // -------- |
| 1754 | |
| 1755 | DocStr(SetToolTip, |
| 1756 | "Attach a tooltip to the window.", ""); |
| 1757 | %Rename(SetToolTipString, void, SetToolTip( const wxString &tip )); |
| 1758 | void SetToolTip( wxToolTip *tip ); |
| 1759 | |
| 1760 | DocDeclStr( |
| 1761 | wxToolTip* , GetToolTip() const, |
| 1762 | "get the associated tooltip or None if none", ""); |
| 1763 | |
| 1764 | // LINK ERROR --> wxString GetToolTipText() const; |
| 1765 | #endif |
| 1766 | |
| 1767 | |
| 1768 | |
| 1769 | #ifndef __WXX11__ |
| 1770 | // drag and drop |
| 1771 | // ------------- |
| 1772 | |
| 1773 | // set/retrieve the drop target associated with this window (may be |
| 1774 | // NULL; it's owned by the window and will be deleted by it) |
| 1775 | %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget }; |
| 1776 | |
| 1777 | DocDeclStr( |
| 1778 | virtual void , SetDropTarget( wxPyDropTarget *dropTarget ), |
| 1779 | "Associates a drop target with this window. If the window already has |
| 1780 | a drop target, it is deleted.", ""); |
| 1781 | |
| 1782 | %clear wxPyDropTarget *dropTarget; |
| 1783 | |
| 1784 | |
| 1785 | DocDeclStr( |
| 1786 | virtual wxPyDropTarget *, GetDropTarget() const, |
| 1787 | "Returns the associated drop target, which may be None.", ""); |
| 1788 | |
| 1789 | |
| 1790 | #ifdef __WXMSW__ // TODO: should I drop-kick this? |
| 1791 | DocDeclStr( |
| 1792 | void , DragAcceptFiles(bool accept), |
| 1793 | "Enables or disables eligibility for drop file events, EVT_DROP_FILES. |
| 1794 | Only available on Windows.", ""); |
| 1795 | #endif |
| 1796 | #endif |
| 1797 | |
| 1798 | |
| 1799 | // constraints and sizers |
| 1800 | // ---------------------- |
| 1801 | |
| 1802 | // set the constraints for this window or retrieve them (may be NULL) |
| 1803 | DocDeclStr( |
| 1804 | void , SetConstraints( wxLayoutConstraints *constraints ), |
| 1805 | "Sets the window to have the given layout constraints. If an existing |
| 1806 | layout constraints object is already owned by the window, it will be |
| 1807 | deleted. Pass None to disassociate and delete the window's current |
| 1808 | constraints. |
| 1809 | |
| 1810 | You must call SetAutoLayout to tell a window to use the constraints |
| 1811 | automatically in its default EVT_SIZE handler; otherwise, you must |
| 1812 | handle EVT_SIZE yourself and call Layout() explicitly. When setting |
| 1813 | both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have |
| 1814 | effect.", ""); |
| 1815 | |
| 1816 | DocDeclStr( |
| 1817 | wxLayoutConstraints *, GetConstraints() const, |
| 1818 | "Returns a pointer to the window's layout constraints, or None if there |
| 1819 | are none.", ""); |
| 1820 | |
| 1821 | |
| 1822 | DocDeclStr( |
| 1823 | void , SetAutoLayout( bool autoLayout ), |
| 1824 | "Determines whether the Layout function will be called automatically |
| 1825 | when the window is resized. It is called implicitly by SetSizer but |
| 1826 | if you use SetConstraints you should call it manually or otherwise the |
| 1827 | window layout won't be correctly updated when its size changes.", ""); |
| 1828 | |
| 1829 | DocDeclStr( |
| 1830 | bool , GetAutoLayout() const, |
| 1831 | "Returns the current autoLayout setting", ""); |
| 1832 | |
| 1833 | |
| 1834 | DocDeclStr( |
| 1835 | virtual bool , Layout(), |
| 1836 | "Invokes the constraint-based layout algorithm or the sizer-based |
| 1837 | algorithm for this window. See SetAutoLayout: when auto layout is on, |
| 1838 | this function gets called automatically by the default EVT_SIZE |
| 1839 | handler when the window is resized.", ""); |
| 1840 | |
| 1841 | |
| 1842 | DocDeclStr( |
| 1843 | void , SetSizer(wxSizer *sizer, bool deleteOld = true ), |
| 1844 | "Sets the window to have the given layout sizer. The window will then |
| 1845 | own the object, and will take care of its deletion. If an existing |
| 1846 | layout sizer object is already owned by the window, it will be deleted |
| 1847 | if the deleteOld parameter is true. Note that this function will also |
| 1848 | call SetAutoLayout implicitly with a True parameter if the sizer is |
| 1849 | non-None, and False otherwise.", ""); |
| 1850 | |
| 1851 | DocDeclStr( |
| 1852 | void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ), |
| 1853 | "The same as SetSizer, except it also sets the size hints for the |
| 1854 | window based on the sizer's minimum size.", ""); |
| 1855 | |
| 1856 | |
| 1857 | DocDeclStr( |
| 1858 | wxSizer *, GetSizer() const, |
| 1859 | "Return the sizer associated with the window by a previous call to |
| 1860 | SetSizer or None if there isn't one.", ""); |
| 1861 | |
| 1862 | |
| 1863 | // Track if this window is a member of a sizer |
| 1864 | DocDeclStr( |
| 1865 | void , SetContainingSizer(wxSizer* sizer), |
| 1866 | "This normally does not need to be called by application code. It is |
| 1867 | called internally when a window is added to a sizer, and is used so |
| 1868 | the window can remove itself from the sizer when it is destroyed.", ""); |
| 1869 | |
| 1870 | DocDeclStr( |
| 1871 | wxSizer *, GetContainingSizer() const, |
| 1872 | "Return the sizer that this window is a member of, if any, otherwise None.", ""); |
| 1873 | |
| 1874 | |
| 1875 | |
| 1876 | |
| 1877 | // accessibility |
| 1878 | // ---------------------- |
| 1879 | #if wxUSE_ACCESSIBILITY |
| 1880 | // Override to create a specific accessible object. |
| 1881 | virtual wxAccessible* CreateAccessible(); |
| 1882 | |
| 1883 | // Sets the accessible object. |
| 1884 | void SetAccessible(wxAccessible* accessible) ; |
| 1885 | |
| 1886 | // Returns the accessible object. |
| 1887 | wxAccessible* GetAccessible() { return m_accessible; }; |
| 1888 | |
| 1889 | // Returns the accessible object, creating if necessary. |
| 1890 | wxAccessible* GetOrCreateAccessible() ; |
| 1891 | #endif |
| 1892 | |
| 1893 | |
| 1894 | |
| 1895 | |
| 1896 | DocDeclStr( |
| 1897 | virtual void , InheritAttributes(), |
| 1898 | "This function is (or should be, in case of custom controls) called |
| 1899 | during window creation to intelligently set up the window visual |
| 1900 | attributes, that is the font and the foreground and background |
| 1901 | colours. |
| 1902 | |
| 1903 | By 'intelligently' the following is meant: by default, all windows use |
| 1904 | their own default attributes. However if some of the parent's |
| 1905 | attributes are explicitly changed (that is, using SetFont and not |
| 1906 | SetOwnFont) and if the corresponding attribute hadn't been |
| 1907 | explicitly set for this window itself, then this window takes the same |
| 1908 | value as used by the parent. In addition, if the window overrides |
| 1909 | ShouldInheritColours to return false, the colours will not be changed |
| 1910 | no matter what and only the font might. |
| 1911 | |
| 1912 | This rather complicated logic is necessary in order to accommodate the |
| 1913 | different usage scenarios. The most common one is when all default |
| 1914 | attributes are used and in this case, nothing should be inherited as |
| 1915 | in modern GUIs different controls use different fonts (and colours) |
| 1916 | than their siblings so they can't inherit the same value from the |
| 1917 | parent. However it was also deemed desirable to allow to simply change |
| 1918 | the attributes of all children at once by just changing the font or |
| 1919 | colour of their common parent, hence in this case we do inherit the |
| 1920 | parents attributes. |
| 1921 | ", ""); |
| 1922 | |
| 1923 | |
| 1924 | // TODO: Virtualize this with directors |
| 1925 | DocDeclStr( |
| 1926 | virtual bool , ShouldInheritColours() const, |
| 1927 | "Return true from here to allow the colours of this window to be |
| 1928 | changed by InheritAttributes, returning false forbids inheriting them |
| 1929 | from the parent window. |
| 1930 | |
| 1931 | The base class version returns false, but this method is overridden in |
| 1932 | wxControl where it returns true.", ""); |
| 1933 | |
| 1934 | |
| 1935 | |
| 1936 | %pythoncode { |
| 1937 | def PostCreate(self, pre): |
| 1938 | """ |
| 1939 | Phase 3 of the 2-phase create <wink!> |
| 1940 | Call this method after precreating the window with the 2-phase create method. |
| 1941 | """ |
| 1942 | self.this = pre.this |
| 1943 | self.thisown = pre.thisown |
| 1944 | pre.thisown = 0 |
| 1945 | if hasattr(self, '_setOORInfo'): |
| 1946 | self._setOORInfo(self) |
| 1947 | if hasattr(self, '_setCallbackInfo'): |
| 1948 | self._setCallbackInfo(self, self.__class__) |
| 1949 | } |
| 1950 | }; |
| 1951 | |
| 1952 | |
| 1953 | |
| 1954 | |
| 1955 | |
| 1956 | |
| 1957 | |
| 1958 | |
| 1959 | %pythoncode { |
| 1960 | def DLG_PNT(win, point_or_x, y=None): |
| 1961 | """ |
| 1962 | Convenience function for converting a Point or (x,y) in |
| 1963 | dialog units to pixel units. |
| 1964 | """ |
| 1965 | if y is None: |
| 1966 | return win.ConvertDialogPointToPixels(point_or_x) |
| 1967 | else: |
| 1968 | return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y)) |
| 1969 | |
| 1970 | def DLG_SZE(win, size_width, height=None): |
| 1971 | """ |
| 1972 | Convenience function for converting a Size or (w,h) in |
| 1973 | dialog units to pixel units. |
| 1974 | """ |
| 1975 | if height is None: |
| 1976 | return win.ConvertDialogSizeToPixels(size_width) |
| 1977 | else: |
| 1978 | return win.ConvertDialogSizeToPixels(wx.Size(size_width, height)) |
| 1979 | } |
| 1980 | |
| 1981 | |
| 1982 | |
| 1983 | |
| 1984 | // Unfortunatly the names of these new static methods clash with the |
| 1985 | // names wxPython has been using forever for the overloaded |
| 1986 | // wxWindow::FindWindow, so instead of swigging them as statics create |
| 1987 | // standalone functions for them. |
| 1988 | |
| 1989 | |
| 1990 | DocStr(wxFindWindowById, |
| 1991 | "Find the first window in the application with the given id. If parent |
| 1992 | is None, the search will start from all top-level frames and dialog |
| 1993 | boxes; if non-None, the search will be limited to the given window |
| 1994 | hierarchy. The search is recursive in both cases.", ""); |
| 1995 | |
| 1996 | DocStr(wxFindWindowByName, |
| 1997 | "Find a window by its name (as given in a window constructor or Create |
| 1998 | function call). If parent is None, the search will start from all |
| 1999 | top-level frames and dialog boxes; if non-None, the search will be |
| 2000 | limited to the given window hierarchy. The search is recursive in both |
| 2001 | cases. |
| 2002 | |
| 2003 | If no window with such name is found, wx.FindWindowByLabel is called.", ""); |
| 2004 | |
| 2005 | DocStr(wxFindWindowByLabel, |
| 2006 | "Find a window by its label. Depending on the type of window, the label |
| 2007 | may be a window title or panel item label. If parent is None, the |
| 2008 | search will start from all top-level frames and dialog boxes; if |
| 2009 | non-None, the search will be limited to the given window |
| 2010 | hierarchy. The search is recursive in both cases.", ""); |
| 2011 | |
| 2012 | |
| 2013 | MustHaveApp(wxFindWindowById); |
| 2014 | MustHaveApp(wxFindWindowByName); |
| 2015 | MustHaveApp(wxFindWindowByLabel); |
| 2016 | |
| 2017 | %inline %{ |
| 2018 | wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) { |
| 2019 | return wxWindow::FindWindowById(id, parent); |
| 2020 | } |
| 2021 | |
| 2022 | wxWindow* wxFindWindowByName( const wxString& name, |
| 2023 | const wxWindow *parent = NULL ) { |
| 2024 | return wxWindow::FindWindowByName(name, parent); |
| 2025 | } |
| 2026 | |
| 2027 | wxWindow* wxFindWindowByLabel( const wxString& label, |
| 2028 | const wxWindow *parent = NULL ) { |
| 2029 | return wxWindow::FindWindowByLabel(label, parent); |
| 2030 | } |
| 2031 | %} |
| 2032 | |
| 2033 | |
| 2034 | |
| 2035 | %{ |
| 2036 | #ifdef __WXMSW__ |
| 2037 | #include <wx/msw/private.h> // to get wxGetWindowId |
| 2038 | #endif |
| 2039 | %} |
| 2040 | |
| 2041 | %inline %{ |
| 2042 | wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) { |
| 2043 | #ifdef __WXMSW__ |
| 2044 | WXHWND hWnd = (WXHWND)_hWnd; |
| 2045 | long id = wxGetWindowId(hWnd); |
| 2046 | wxWindow* win = new wxWindow; |
| 2047 | parent->AddChild(win); |
| 2048 | win->SetEventHandler(win); |
| 2049 | win->SetHWND(hWnd); |
| 2050 | win->SetId(id); |
| 2051 | win->SubclassWin(hWnd); |
| 2052 | win->AdoptAttributesFromHWND(); |
| 2053 | win->SetupColours(); |
| 2054 | return win; |
| 2055 | #else |
| 2056 | wxPyRaiseNotImplemented(); |
| 2057 | return NULL; |
| 2058 | #endif |
| 2059 | } |
| 2060 | %} |
| 2061 | |
| 2062 | //--------------------------------------------------------------------------- |
| 2063 | //--------------------------------------------------------------------------- |
| 2064 | |