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