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