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