1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG interface for wxWindow
7 // Created: 24-June-1997
9 // Copyright: (c) 2003 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
16 //---------------------------------------------------------------------------
21 MAKE_CONST_WXSTRING(PanelNameStr);
23 //---------------------------------------------------------------------------
27 DocStr(wxVisualAttributes,
28 "struct containing all the visual attributes of a control", "");
30 struct wxVisualAttributes
33 wxVisualAttributes() { return new wxVisualAttributes; }
34 ~wxVisualAttributes() { delete self; }
37 // the font used for control label/text inside it
40 // the foreground colour
43 // the background colour, may be wxNullColour if the controls background
44 // colour is not solid
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 )
62 "wx.Window is the base class for all windows and represents any visible
63 object on the screen. All controls, top level windows and so on are
64 wx.Windows. Sizers and device contexts are not however, as they don't
65 appear on screen themselves.
70 ============================= =====================================
71 wx.SIMPLE_BORDER Displays a thin border around the window.
73 wx.DOUBLE_BORDER Displays a double border. Windows and Mac only.
75 wx.SUNKEN_BORDER Displays a sunken border.
77 wx.RAISED_BORDER Displays a raised border.
79 wx.STATIC_BORDER Displays a border suitable for a static
80 control. Windows only.
82 wx.NO_BORDER Displays no border, overriding the default
83 border style for the window.
85 wx.TRANSPARENT_WINDOW The window is transparent, that is, it
86 will not receive paint events. Windows only.
88 wx.TAB_TRAVERSAL Use this to enable tab traversal for
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
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
114 wx.VSCROLL Use this style to enable a vertical scrollbar.
116 wx.HSCROLL Use this style to enable a horizontal scrollbar.
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.
127 wx.CLIP_CHILDREN Use this style to eliminate flicker caused by
128 the background being repainted, then
129 children being painted over
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
142 ============================= =====================================
147 ============================= =====================================
148 wx.WS_EX_VALIDATE_RECURSIVELY By default,
149 Validate/TransferDataTo/FromWindow()
150 only work on direct children of
151 the window (compatible
152 behaviour). Set this flag to make
153 them recursively descend into all
156 wx.WS_EX_BLOCK_EVENTS wx.CommandEvents and the objects of the
157 derived classes are forwarded to
158 the parent window and so on
159 recursively by default. Using this
160 flag for the given window allows
161 to block this propagation at this
162 window, i.e. prevent the events
163 from being propagated further
164 upwards. Dialogs have this flag on
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.
176 wx.WS_EX_PROCESS_IDLE This window should always process idle
177 events, even if the mode set by
178 `wx.IdleEvent.SetMode` is
179 wx.IDLE_PROCESS_SPECIFIED.
181 wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
182 update events, even if the mode
183 set by `wx.UpdateUIEvent.SetMode` is
184 wxUPDATE_UI_PROCESS_SPECIFIED.
185 ============================= =====================================
190 MustHaveApp(wxWindow);
191 MustHaveApp(wxWindow::FindFocus);
192 MustHaveApp(wxWindow::GetCapture);
194 // This one is not restricted to wxWindow
195 MustHaveApp(GetClassDefaultAttributes);
197 class wxWindow : public wxEvtHandler
200 %pythonAppend wxWindow "self._setOORInfo(self)"
201 %pythonAppend wxWindow() ""
202 %typemap(out) wxWindow*; // turn off this typemap
205 wxWindow(wxWindow* parent, const wxWindowID id=-1,
206 const wxPoint& pos = wxDefaultPosition,
207 const wxSize& size = wxDefaultSize,
209 const wxString& name = wxPyPanelNameStr),
210 "Construct and show a generic Window.", "");
214 "Precreate a Window for 2-phase creation.", "",
217 // Turn it back on again
218 %typemap(out) wxWindow* { $result = wxPyMake_wxObject($1, $owner); }
222 bool , Create(wxWindow* parent, const wxWindowID id=-1,
223 const wxPoint& pos = wxDefaultPosition,
224 const wxSize& size = wxDefaultSize,
226 const wxString& name = wxPyPanelNameStr),
227 "Create the GUI part of the Window for 2-phase creation mode.", "");
230 // deleting the window
231 // -------------------
235 bool , Close( bool force = false ),
236 "This function simply generates a EVT_CLOSE event whose handler usually
237 tries to close the window. It doesn't close the window itself,
238 however. If force is False (the default) then the window's close
239 handler will be allowed to veto the destruction of the window.",
241 Usually Close is only used with the top level windows (wx.Frame and
242 wx.Dialog classes) as the others are not supposed to have any special
245 The close handler should check whether the window is being deleted
246 forcibly, using wx.CloseEvent.GetForce, in which case it should
247 destroy the window using wx.Window.Destroy.
249 Note that calling Close does not guarantee that the window will be
250 destroyed; but it provides a way to simulate a manual close of a
251 window, which may or may not be implemented by destroying the
252 window. The default EVT_CLOSE handler for wx.Dialog does not
253 necessarily delete the dialog, since it will simply simulate an
254 wxID_CANCEL event which is handled by the appropriate button event
255 handler and may do anything at all.
257 To guarantee that the window will be destroyed, call wx.Window.Destroy
263 virtual bool , Destroy(),
264 "Destroys the window safely. Frames and dialogs are not destroyed
265 immediately when this function is called -- they are added to a list
266 of windows to be deleted on idle time, when all the window's events
267 have been processed. This prevents problems with events being sent to
268 non-existent windows.
270 Returns True if the window has either been successfully deleted, or it
271 has been added to the list of windows pending real deletion.", "");
275 bool , DestroyChildren(),
276 "Destroys all children of a window. Called automatically by the
281 bool , IsBeingDeleted() const,
282 "Is the window in the process of being deleted?", "");
290 // virtual void , SetTitle( const wxString& title),
291 // "Sets the window's title. Applicable only to frames and dialogs.", "");
294 // virtual wxString , GetTitle() const,
295 // "Gets the window's title. Applicable only to frames and dialogs.", "");
298 virtual void , SetLabel(const wxString& label),
299 "Set the text which the window shows in its label if applicable.", "");
302 virtual wxString , GetLabel() const,
303 "Generic way of getting a label from any window, for identification
304 purposes. The interpretation of this function differs from class to
305 class. For frames and dialogs, the value returned is the title. For
306 buttons or static text controls, it is the button text. This function
307 can be useful for meta-programs such as testing tools or special-needs
308 access programs)which need to identify windows by name.", "");
312 virtual void , SetName( const wxString &name ),
313 "Sets the window's name. The window name is used for ressource setting
314 in X, it is not the same as the window title/label", "");
317 virtual wxString , GetName() const,
318 "Returns the windows name. This name is not guaranteed to be unique;
319 it is up to the programmer to supply an appropriate name in the window
320 constructor or via wx.Window.SetName.", "");
324 void , SetWindowVariant( wxWindowVariant variant ),
325 "Sets the variant of the window/font size to use for this window, if
326 the platform supports variants, for example, wxMac.",
330 ======================== =======================================
331 wx.WINDOW_VARIANT_NORMAL Normal size
332 wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
333 wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
334 wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
335 ======================== =======================================
339 wxWindowVariant , GetWindowVariant() const,
344 void , SetId( wxWindowID winid ),
345 "Sets the identifier of the window. Each window has an integer
346 identifier. If the application has not provided one, an identifier
347 will be generated. Normally, the identifier should be provided on
348 creation and should not be modified subsequently.", "");
351 wxWindowID , GetId() const,
352 "Returns the identifier of the window. Each window has an integer
353 identifier. If the application has not provided one (or the default Id
354 -1 is used) then an unique identifier with a negative value will be
359 static int , NewControlId(),
360 "Generate a control id for the controls which were not given one.", "");
364 static int , NextControlId(int winid),
365 "Get the id of the control following the one with the given
366 autogenerated) id", "");
370 static int , PrevControlId(int winid),
371 "Get the id of the control preceding the one with the given
372 autogenerated) id", "");
382 void , SetSize( const wxSize& size ),
383 "Sets the size of the window in pixels.", "");
387 void , SetSize( int x, int y, int width, int height,
388 int sizeFlags = wxSIZE_AUTO ),
389 "Sets the position and size of the window in pixels. The sizeFlags
390 parameter indicates the interpretation of the other params if they are
393 ======================== ======================================
394 wx.SIZE_AUTO A -1 indicates that a class-specific
395 default should be used.
396 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
397 -1 values are supplied.
398 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
399 interpreted as real dimensions, not
401 ======================== ======================================
407 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
408 "Sets the position and size of the window in pixels using a wx.Rect.", "",
413 void , SetSize( int width, int height ),
414 "Sets the size of the window in pixels.", "",
419 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
420 "Moves the window to the given position.", "");
422 %pythoncode { SetPosition = Move }
426 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
427 "Moves the window to the given position.", "",
431 void , SetBestFittingSize(const wxSize& size=wxDefaultSize),
432 "A 'Smart' SetSize that will fill in default size components with the
433 window's *best size* values. Also set's the minsize for use with sizers.", "");
438 virtual void , Raise(),
439 "Raises the window to the top of the window hierarchy. In current
440 version of wxWidgets this works both for manage and child windows.", "");
443 virtual void , Lower(),
444 "Lowers the window to the bottom of the window hierarchy. In current
445 version of wxWidgets this works both for manage and child windows.", "");
449 // client size is the size of the area available for subwindows
450 DocStr(SetClientSize,
451 "This sets the size of the window client area in pixels. Using this
452 function to size a window tends to be more device-independent than
453 wx.Window.SetSize, since the application need not worry about what
454 dimensions the border or title bar have when trying to fit the window
455 around panel items, for example.", "");
456 void SetClientSize( const wxSize& size );
457 %Rename(SetClientSizeWH, void, SetClientSize( int width, int height ));
458 %Rename(SetClientRect, void, SetClientSize(const wxRect& rect));
461 DocStr(GetPosition, // sets the docstring for both
462 "Get the window's position.", "");
463 wxPoint GetPosition();
466 void, GetPosition(int *OUTPUT, int *OUTPUT),
467 "GetPositionTuple() -> (x,y)",
471 DocStr(GetSize, "Get the window size.", "");
472 wxSize GetSize() const;
474 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
475 "GetSizeTuple() -> (width, height)",
481 wxRect , GetRect() const,
482 "Returns the size and position of the window as a wx.Rect object.", "");
485 DocStr(GetClientSize,
486 "This gets the size of the window's 'client area' in pixels. The client
487 area is the area which may be drawn on by the programmer, excluding
488 title bar, border, scrollbars, etc.", "");
489 wxSize GetClientSize() const;
491 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
492 "GetClientSizeTuple() -> (width, height)",
498 virtual wxPoint , GetClientAreaOrigin() const,
499 "Get the origin of the client area of the window relative to the
500 window's top left corner (the client area may be shifted because of
501 the borders, scrollbars, other decorations...)", "");
505 wxRect , GetClientRect() const,
506 "Get the client area position and size as a `wx.Rect` object.", "");
511 "This function returns the best acceptable minimal size for the
512 window, if applicable. For example, for a static text control, it will
513 be the minimal size such that the control label is not truncated. For
514 windows containing subwindows (suzh aswx.Panel), the size returned by
515 this function will be the same as the size the window would have had
516 after calling Fit.", "");
517 wxSize GetBestSize() const;
519 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
520 "GetBestSizeTuple() -> (width, height)",
525 void , InvalidateBestSize(),
526 "Reset the cached best size value so it will be recalculated the next
527 time it is needed.", "");
530 void , CacheBestSize(const wxSize& size) const,
531 "Cache the best size so it doesn't need to be calculated again, (at least until
532 some properties of the window change.)", "");
536 wxSize , GetBestFittingSize() const,
537 "This function will merge the window's best size into the window's
538 minimum size, giving priority to the min size components, and returns
544 wxSize , GetAdjustedBestSize() const,
545 "This method is similar to GetBestSize, except in one
546 thing. GetBestSize should return the minimum untruncated size of the
547 window, while this method will return the largest of BestSize and any
548 user specified minimum size. ie. it is the minimum size the window
549 should currently be drawn at, not the minimal size it can possibly
556 void , Center( int direction = wxBOTH ),
557 "Centers the window. The parameter specifies the direction for
558 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
559 also include wx.CENTER_ON_SCREEN flag if you want to center the window
560 on the entire screen and not on its parent window. If it is a
561 top-level window and has no parent then it will always be centered
562 relative to the screen.", "");
564 %pythoncode { Centre = Center }
568 void , CenterOnScreen(int dir = wxBOTH),
569 "Center on screen (only works for top level windows)", "");
570 %pythoncode { CentreOnScreen = CenterOnScreen }
574 void , CenterOnParent(int dir = wxBOTH),
575 "Center with respect to the the parent window", "");
576 %pythoncode { CentreOnParent = CenterOnParent }
581 virtual void , Fit(),
582 "Sizes the window so that it fits around its subwindows. This function
583 won't do anything if there are no subwindows and will only really work
584 correctly if sizers are used for the subwindows layout. Also, if the
585 window has exactly one subwindow it is better (faster and the result
586 is more precise as Fit adds some margin to account for fuzziness of
587 its calculations) to call window.SetClientSize(child.GetSize())
588 instead of calling Fit.", "");
592 virtual void , FitInside(),
593 "Similar to Fit, but sizes the interior (virtual) size of a
594 window. Mainly useful with scrolled windows to reset scrollbars after
595 sizing changes that do not trigger a size event, and/or scrolled
596 windows without an interior sizer. This function similarly won't do
597 anything if there are no subwindows.", "");
602 "Allows specification of minimum and maximum window sizes, and window
603 size increments. If a pair of values is not set (or set to -1), the
604 default values will be used. If this function is called, the user
605 will not be able to size the window outside the given bounds (if it is
606 a top-level window.) Sizers will also inspect the minimum window size
607 and will use that value if set when calculating layout.
609 The resizing increments are only significant under Motif or Xt.", "
611 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
613 virtual void SetSizeHints( int minW, int minH,
614 int maxW = -1, int maxH = -1,
615 int incW = -1, int incH = -1 );
616 %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize,
617 const wxSize& maxSize=wxDefaultSize,
618 const wxSize& incSize=wxDefaultSize));
621 DocStr(SetVirtualSizeHints,
622 "Allows specification of minimum and maximum virtual window sizes. If a
623 pair of values is not set (or set to -1), the default values will be
624 used. If this function is called, the user will not be able to size
625 the virtual area of the window outside the given bounds.", "");
626 virtual void SetVirtualSizeHints( int minW, int minH,
627 int maxW = -1, int maxH = -1 );
628 %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints(
629 const wxSize& minSize, const wxSize& maxSize=wxDefaultSize));
634 virtual wxSize , GetMaxSize() const,
638 virtual wxSize , GetMinSize() const,
642 void , SetMinSize(const wxSize& minSize),
643 "A more convenient method than `SetSizeHints` for setting just the
647 void , SetMaxSize(const wxSize& maxSize),
648 "A more convenient method than `SetSizeHints` for setting just the
654 virtual int , GetMinWidth() const,
658 virtual int , GetMinHeight() const,
662 int , GetMaxWidth() const,
666 int , GetMaxHeight() const,
671 DocStr(SetVirtualSize,
672 "Set the the virtual size of a window in pixels. For most windows this
673 is just the client area of the window, but for some like scrolled
674 windows it is more or less independent of the screen window size.", "");
675 void SetVirtualSize(const wxSize& size );
676 %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h ));
679 DocStr(GetVirtualSize,
680 "Get the the virtual size of the window in pixels. For most windows
681 this is just the client area of the window, but for some like scrolled
682 windows it is more or less independent of the screen window size.", "");
683 wxSize GetVirtualSize() const;
685 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
686 "GetVirtualSizeTuple() -> (width, height)",
687 GetVirtualSizeTuple);
690 // TODO: using directors?
691 // // Override these methods for windows that have a virtual size
692 // // independent of their client size. eg. the virtual area of a
693 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
694 // virtual void DoSetVirtualSize( int x, int y );
695 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
699 virtual wxSize , GetBestVirtualSize() const,
700 "Return the largest of ClientSize and BestSize (as determined by a
701 sizer, interior children, or other means)", "");
709 virtual bool , Show( bool show = true ),
710 "Shows or hides the window. You may need to call Raise for a top level
711 window if you want to bring it to top, although this is not needed if
712 Show is called immediately after the frame creation. Returns True if
713 the window has been shown or hidden or False if nothing was done
714 because it already was in the requested state.", "");
718 "Equivalent to calling Show(False).", "");
722 virtual bool , Enable( bool enable = true ),
723 "Enable or disable the window for user input. Note that when a parent
724 window is disabled, all of its children are disabled as well and they
725 are reenabled again when the parent is. Returns true if the window
726 has been enabled or disabled, false if nothing was done, i.e. if the
727 window had already been in the specified state.", "");
731 "Disables the window, same as Enable(false).", "");
735 bool , IsShown() const,
736 "Returns true if the window is shown, false if it has been hidden.", "");
739 bool , IsEnabled() const,
740 "Returns true if the window is enabled for input, false otherwise.", "");
746 virtual void , SetWindowStyleFlag( long style ),
747 "Sets the style of the window. Please note that some styles cannot be
748 changed after the window creation and that Refresh() might need to be
749 called after changing the others for the change to take place
753 virtual long , GetWindowStyleFlag() const,
754 "Gets the window style that was passed to the constructor or Create
757 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
761 bool , HasFlag(int flag) const,
762 "Test if the given style is set for this window.", "");
766 virtual bool , IsRetained() const,
767 "Returns true if the window is retained, false otherwise. Retained
768 windows are only available on X platforms.", "");
773 virtual void , SetExtraStyle(long exStyle),
774 "Sets the extra style bits for the window. Extra styles are the less
775 often used style bits which can't be set with the constructor or with
776 SetWindowStyleFlag()", "");
779 long , GetExtraStyle() const,
780 "Returns the extra style bits for the window.", "");
785 virtual void , MakeModal(bool modal = true),
786 "Disables all other windows in the application so that the user can
787 only interact with this window. Passing False will reverse this
793 virtual void , SetThemeEnabled(bool enableTheme),
794 "This function tells a window if it should use the system's \"theme\"
795 code to draw the windows' background instead if its own background
796 drawing code. This will only have an effect on platforms that support
797 the notion of themes in user defined windows. One such platform is
798 GTK+ where windows can have (very colourful) backgrounds defined by a
799 user's selected theme.
801 Dialogs, notebook pages and the status bar have this flag set to true
802 by default so that the default look and feel is simulated best.", "");
805 virtual bool , GetThemeEnabled() const,
806 "Return the themeEnabled flag.", "");
809 // TODO with directors
810 // // controls by default inherit the colours of their parents, if a
811 // // particular control class doesn't want to do it, it can override
812 // // ShouldInheritColours() to return False
813 // virtual bool ShouldInheritColours() const;
819 // focus and keyboard handling
820 // ---------------------------
824 virtual void , SetFocus(),
825 "Set's the focus to this window, allowing it to receive keyboard input.", "");
828 virtual void , SetFocusFromKbd(),
829 "Set focus to this window as the result of a keyboard action. Normally
830 only called internally.", "");
835 static wxWindow *, FindFocus(),
836 "Returns the window or control that currently has the keyboard focus,
841 virtual bool , AcceptsFocus() const,
842 "Can this window have focus?", "");
846 virtual bool , AcceptsFocusFromKeyboard() const,
847 "Can this window be given focus by keyboard navigation? if not, the
848 only way to give it focus (provided it accepts it at all) is to click
855 virtual wxWindow *, GetDefaultItem() const,
856 "Get the default child of this parent, i.e. the one which is activated
857 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
860 virtual wxWindow *, SetDefaultItem(wxWindow * child),
861 "Set this child as default, return the old default.", "");
864 virtual void , SetTmpDefaultItem(wxWindow * win),
865 "Set this child as temporary default", "");
869 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
870 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
871 "Does keyboard navigation from this window to another, by sending a
872 `wx.NavigationKeyEvent`.", "
874 :param flags: A combination of the ``IsForward`` or ``IsBackward``
875 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
876 class, which determine if the navigation should be in forward
877 or reverse order, and if it should be able to cross parent
878 window boundaries, such as between notebook pages or MDI child
879 frames. Typically the status of the Shift key (for forward or
880 backward) or the Control key (for WinChange) would be used to
881 determine how to set the flags.
883 One situation in which you may wish to call this method is from a text
884 control custom keypress handler to do the default navigation behaviour
885 for the tab key, since the standard default behaviour for a multiline
886 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
887 not navigate to the next control.");
892 void , MoveAfterInTabOrder(wxWindow *win),
893 "Moves this window in the tab navigation order after the specified
894 sibling window. This means that when the user presses the TAB key on
895 that other window, the focus switches to this window.
897 The default tab order is the same as creation order. This function
898 and `MoveBeforeInTabOrder` allow to change it after creating all the
904 void , MoveBeforeInTabOrder(wxWindow *win),
905 "Same as `MoveAfterInTabOrder` except that it inserts this window just
906 before win instead of putting it right after it.", "");
915 // parent/children relations
916 // -------------------------
919 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
922 "Returns a list of the window's children. NOTE: Currently this is a
923 copy of the child window list maintained by the window, so the return
924 value of this function is only valid as long as the window's children
925 do not change.", "");
926 PyObject* GetChildren() {
927 wxWindowList& list = self->GetChildren();
928 return wxPy_ConvertList(&list);
933 wxWindow *, GetParent() const,
934 "Returns the parent window of this window, or None if there isn't one.", "");
937 wxWindow *, GetGrandParent() const,
938 "Returns the parent of the parent of this window, or None if there
944 virtual bool , IsTopLevel() const,
945 "Returns true if the given window is a top-level one. Currently all
946 frames and dialogs are always considered to be top-level windows (even
947 if they have a parent window).", "");
950 // change the real parent of this window, return True if the parent
951 // was changed, False otherwise (error or newParent == oldParent)
953 virtual bool , Reparent( wxWindow *newParent ),
954 "Reparents the window, i.e the window will be removed from its current
955 parent window (e.g. a non-standard toolbar in a wxFrame) and then
956 re-inserted into another. Available on Windows and GTK. Returns True
957 if the parent was changed, False otherwise (error or newParent ==
962 virtual void , AddChild( wxWindow *child ),
963 "Adds a child window. This is called automatically by window creation
964 functions so should not be required by the application programmer.", "");
967 virtual void , RemoveChild( wxWindow *child ),
968 "Removes a child window. This is called automatically by window
969 deletion functions so should not be required by the application
975 // looking for windows
976 // -------------------
979 wxWindow *, FindWindow( long winid ),
980 "Find a chld of this window by window ID", "",
984 wxWindow *, FindWindow( const wxString& name ),
985 "Find a child of this window by name", "",
990 // event handler stuff
991 // -------------------
994 wxEvtHandler *, GetEventHandler() const,
995 "Returns the event handler for this window. By default, the window is
996 its own event handler.", "");
1000 void , SetEventHandler( wxEvtHandler *handler ),
1001 "Sets the event handler for this window. An event handler is an object
1002 that is capable of processing the events sent to a window. By default,
1003 the window is its own event handler, but an application may wish to
1004 substitute another, for example to allow central implementation of
1005 event-handling for a variety of different window classes.
1007 It is usually better to use `wx.Window.PushEventHandler` since this sets
1008 up a chain of event handlers, where an event not handled by one event
1009 handler is handed to the next one in the chain.", "");
1013 void , PushEventHandler( wxEvtHandler *handler ),
1014 "Pushes this event handler onto the event handler stack for the window.
1015 An event handler is an object that is capable of processing the events
1016 sent to a window. By default, the window is its own event handler, but
1017 an application may wish to substitute another, for example to allow
1018 central implementation of event-handling for a variety of different
1021 wx.Window.PushEventHandler allows an application to set up a chain of
1022 event handlers, where an event not handled by one event handler is
1023 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
1024 remove the event handler.", "");
1028 wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
1029 "Removes and returns the top-most event handler on the event handler
1030 stack. If deleteHandler is True then the wx.EvtHandler object will be
1031 destroyed after it is popped.", "");
1035 bool , RemoveEventHandler(wxEvtHandler *handler),
1036 "Find the given handler in the event handler chain and remove (but not
1037 delete) it from the event handler chain, return True if it was found
1038 and False otherwise (this also results in an assert failure so this
1039 function should only be called when the handler is supposed to be
1048 // a window may have an associated validator which is used to control
1051 virtual void , SetValidator( const wxValidator &validator ),
1052 "Deletes the current validator (if any) and sets the window validator,
1053 having called wx.Validator.Clone to create a new validator of this
1057 virtual wxValidator *, GetValidator(),
1058 "Returns a pointer to the current validator for the window, or None if
1059 there is none.", "");
1063 virtual bool , Validate(),
1064 "Validates the current values of the child controls using their
1065 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1066 style flag set, the method will also call Validate() of all child
1067 windows. Returns false if any of the validations failed.", "");
1071 virtual bool , TransferDataToWindow(),
1072 "Transfers values to child controls from data areas specified by their
1073 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1074 style flag set, the method will also call TransferDataToWindow() of
1075 all child windows.", "");
1078 virtual bool , TransferDataFromWindow(),
1079 "Transfers values from child controls to data areas specified by their
1080 validators. Returns false if a transfer failed. If the window has
1081 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1082 also call TransferDataFromWindow() of all child windows.", "");
1086 virtual void , InitDialog(),
1087 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1088 to the dialog via validators.", "");
1097 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1098 "Sets the accelerator table for this window.", "");
1101 wxAcceleratorTable *, GetAcceleratorTable(),
1102 "Gets the accelerator table for this window.", "");
1108 // hot keys (system wide accelerators)
1109 // -----------------------------------
1111 DocStr(RegisterHotKey,
1112 "Registers a system wide hotkey. Every time the user presses the hotkey
1113 registered here, this window will receive a hotkey event. It will
1114 receive the event even if the application is in the background and
1115 does not have the input focus because the user is working with some
1116 other application. To bind an event handler function to this hotkey
1117 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1118 hotkey was registered successfully.", "");
1119 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1121 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1128 DocStr(UnregisterHotKey,
1129 "Unregisters a system wide hotkey.", "");
1130 bool UnregisterHotKey(int hotkeyId) {
1132 return self->UnregisterHotKey(hotkeyId);
1141 // "dialog units" translations
1142 // ---------------------------
1144 DocStr(ConvertDialogToPixels,
1145 "Converts a point or size from dialog units to pixels. Dialog units
1146 are used for maintaining a dialog's proportions even if the font
1147 changes. For the x dimension, the dialog units are multiplied by the
1148 average character width and then divided by 4. For the y dimension,
1149 the dialog units are multiplied by the average character height and
1150 then divided by 8.", "");
1151 %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1152 %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
1153 %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1154 %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
1157 DocStr(ConvertPixelPointToDialog,
1158 "Converts a point or size from pixels to dialog units. Dialog units
1159 are used for maintaining a dialog's proportions even if the font
1160 changes. For the x dimension, the dialog units are multiplied by the
1161 average character width and then divided by 4. For the y dimension,
1162 the dialog units are multiplied by the average character height and
1163 then divided by 8.", "");
1164 %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
1165 %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
1173 virtual void , WarpPointer(int x, int y),
1174 "Moves the pointer to the given position on the window.
1176 NOTE: This function is not supported under Mac because Apple Human
1177 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1181 void , CaptureMouse(),
1182 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1183 release the capture.
1185 Note that wxWindows maintains the stack of windows having captured the
1186 mouse and when the mouse is released the capture returns to the window
1187 which had had captured it previously and it is only really released if
1188 there were no previous window. In particular, this means that you must
1189 release the mouse as many times as you capture it.", "");
1192 void , ReleaseMouse(),
1193 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1197 static wxWindow *, GetCapture(),
1198 "Returns the window which currently captures the mouse or None", "");
1202 virtual bool , HasCapture() const,
1203 "Returns true if this window has the current mouse capture.", "");
1209 // painting the window
1210 // -------------------
1213 virtual void , Refresh( bool eraseBackground = true,
1214 const wxRect *rect = NULL ),
1215 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1216 will be repainted. Causes an EVT_PAINT event to be generated and sent
1217 to the window.", "");
1221 void , RefreshRect(const wxRect& rect, bool eraseBackground = true),
1222 "Redraws the contents of the given rectangle: the area inside it will
1223 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1227 virtual void , Update(),
1228 "Calling this method immediately repaints the invalidated area of the
1229 window instead of waiting for the EVT_PAINT event to happen, (normally
1230 this would usually only happen when the flow of control returns to the
1231 event loop.) Notice that this function doesn't refresh the window and
1232 does nothing if the window has been already repainted. Use Refresh
1233 first if you want to immediately redraw the window (or some portion of
1234 it) unconditionally.", "");
1238 virtual void , ClearBackground(),
1239 "Clears the window by filling it with the current background
1240 colour. Does not cause an erase background event to be generated.", "");
1245 virtual void , Freeze(),
1246 "Freezes the window or, in other words, prevents any updates from
1247 taking place on screen, the window is not redrawn at all. Thaw must be
1248 called to reenable window redrawing. Calls to Freeze/Thaw may be
1249 nested, with the actual Thaw being delayed until all the nesting has
1252 This method is useful for visual appearance optimization (for example,
1253 it is a good idea to use it before inserting large amount of text into
1254 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1255 for all controls so it is mostly just a hint to wxWindows and not a
1256 mandatory directive.", "");
1260 virtual void , Thaw(),
1261 "Reenables window updating after a previous call to Freeze. Calls to
1262 Freeze/Thaw may be nested, so Thaw must be called the same number of
1263 times that Freeze was before the window will be updated.", "");
1267 virtual void , PrepareDC( wxDC & dc ),
1268 "Call this function to prepare the device context for drawing a
1269 scrolled image. It sets the device origin according to the current
1270 scroll position.", "");
1274 wxRegion& , GetUpdateRegion(),
1275 "Returns the region specifying which parts of the window have been
1276 damaged. Should only be called within an EVT_PAINT handler.", "");
1280 wxRect , GetUpdateClientRect() const,
1281 "Get the update rectangle region bounding box in client coords.", "");
1285 "Returns true if the given point or rectangle area has been exposed
1286 since the last repaint. Call this in an paint event handler to
1287 optimize redrawing by only redrawing those areas, which have been
1289 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1290 %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
1291 %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
1295 // colours, fonts and cursors
1296 // --------------------------
1300 virtual wxVisualAttributes , GetDefaultAttributes() const,
1301 "Get the default attributes for an instance of this class. This is
1302 useful if you want to use the same font or colour in your own control
1303 as in a standard control -- which is a much better idea than hard
1304 coding specific colours or fonts which might look completely out of
1305 place on the user's system, especially if it uses themes.", "");
1309 static wxVisualAttributes ,
1310 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1311 "Get the default attributes for this class. This is useful if you want
1312 to use the same font or colour in your own control as in a standard
1313 control -- which is a much better idea than hard coding specific
1314 colours or fonts which might look completely out of place on the
1315 user's system, especially if it uses themes.
1317 The variant parameter is only relevant under Mac currently and is
1318 ignore under other platforms. Under Mac, it will change the size of
1319 the returned font. See `wx.Window.SetWindowVariant` for more about
1324 virtual bool , SetBackgroundColour( const wxColour &colour ),
1325 "Sets the background colour of the window. Returns True if the colour
1326 was changed. The background colour is usually painted by the default
1327 EVT_ERASE_BACKGROUND event handler function under Windows and
1328 automatically under GTK. Using `wx.NullColour` will reset the window
1329 to the default background colour.
1331 Note that setting the background colour may not cause an immediate
1332 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1333 calling this function.
1335 Using this function will disable attempts to use themes for this
1336 window, if the system supports them. Use with care since usually the
1337 themes represent the appearance chosen by the user to be used for all
1338 applications on the system.", "");
1341 void , SetOwnBackgroundColour(const wxColour& colour),
1347 virtual bool , SetForegroundColour( const wxColour &colour ),
1348 "Sets the foreground colour of the window. Returns True is the colour
1349 was changed. The interpretation of foreground colour is dependent on
1350 the window class; it may be the text colour or other colour, or it may
1351 not be used at all.", "");
1354 void , SetOwnForegroundColour(const wxColour& colour),
1360 wxColour , GetBackgroundColour() const,
1361 "Returns the background colour of the window.", "");
1364 wxColour , GetForegroundColour() const,
1365 "Returns the foreground colour of the window. The interpretation of
1366 foreground colour is dependent on the window class; it may be the text
1367 colour or other colour, or it may not be used at all.", "");
1370 bool , InheritsBackgroundColour() const,
1374 bool , UseBgCol() const,
1379 // // if the window shouldn't inherit its colour from the parent, override
1380 // // this function to return true
1382 // // this is currently only used by wxMSW and wxUniv but should be useful for
1383 // // the other ports too
1384 // virtual bool ProvidesBackground() const;
1387 // Set/get the background style.
1388 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1390 virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
1391 "Returns the background style of the window. The background style
1392 indicates how the background of the window is drawn.
1394 ====================== ========================================
1395 wx.BG_STYLE_SYSTEM The background colour or pattern should
1396 be determined by the system
1397 wx.BG_STYLE_COLOUR The background should be a solid colour
1398 wx.BG_STYLE_CUSTOM The background will be implemented by the
1400 ====================== ========================================
1402 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
1403 a custom background, such as a tiled bitmap. Currently the style has
1404 no effect on other platforms.
1406 :see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
1409 virtual wxBackgroundStyle , GetBackgroundStyle() const,
1410 "Returns the background style of the window.
1412 :see: `SetBackgroundStyle`", "");
1416 bool , HasTransparentBackground(),
1417 "Returns True if this window's background is transparent (as, for
1418 example, for `wx.StaticText`) and should show the parent window's
1421 This method is mostly used internally by the library itself and you
1422 normally shouldn't have to call it. You may, however, have to override
1423 it in your custom control classes to ensure that background is painted
1428 virtual bool , SetCursor( const wxCursor &cursor ),
1429 "Sets the window's cursor. Notice that the window cursor also sets it
1430 for the children of the window implicitly.
1432 The cursor may be wx.NullCursor in which case the window cursor will
1433 be reset back to default.", "");
1436 wxCursor , GetCursor(),
1437 "Return the cursor associated with this window.", "");
1442 virtual bool , SetFont( const wxFont &font ),
1443 "Sets the font for this window.", "");
1446 void , SetOwnFont(const wxFont& font),
1453 "Returns the default font used for this window.", "");
1458 void , SetCaret(wxCaret *caret),
1459 "Sets the caret associated with the window.", "");
1462 wxCaret *, GetCaret() const,
1463 "Returns the caret associated with the window.", "");
1468 virtual int , GetCharHeight() const,
1469 "Get the (average) character size for the current font.", "");
1472 virtual int , GetCharWidth() const,
1473 "Get the (average) character size for the current font.", "");
1478 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1479 "GetTextExtent(String string) -> (width, height)",
1480 "Get the width and height of the text using the current font.", "");
1482 void, GetTextExtent(const wxString& string,
1483 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1484 const wxFont* font = NULL),
1485 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1486 "Get the width, height, decent and leading of the text using the
1487 current or specified font.", "",
1492 // client <-> screen coords
1493 // ------------------------
1495 %apply int * INOUT { int* x, int* y };
1497 // translate to/from screen/client coordinates
1499 void , ClientToScreen( int *x, int *y ) const,
1500 "ClientToScreenXY(int x, int y) -> (x,y)",
1501 "Converts to screen coordinates from coordinates relative to this window.", "",
1505 void , ScreenToClient( int *x, int *y ) const,
1506 "ScreenToClientXY(int x, int y) -> (x,y)",
1507 "Converts from screen to client window coordinates.", "",
1512 wxPoint , ClientToScreen(const wxPoint& pt) const,
1513 "Converts to screen coordinates from coordinates relative to this window.", "");
1516 wxPoint , ScreenToClient(const wxPoint& pt) const,
1517 "Converts from screen to client window coordinates.", "");
1522 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1523 "Test where the given (in client coords) point lies", "",
1527 wxHitTest , HitTest(const wxPoint& pt) const,
1528 "Test where the given (in client coords) point lies", "");
1536 %nokwargs GetBorder;
1538 wxBorder , GetBorder(long flags) const,
1539 "Get the window border style from the given flags: this is different
1540 from simply doing flags & wxBORDER_MASK because it uses
1541 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1546 wxBorder , GetBorder() const,
1547 "Get border for the flags of this window", "");
1553 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1554 "This function sends EVT_UPDATE_UI events to the window. The particular
1555 implementation depends on the window; for example a wx.ToolBar will
1556 send an update UI event for each toolbar button, and a wx.Frame will
1557 send an update UI event for each menubar menu item. You can call this
1558 function from your application to ensure that your UI is up-to-date at
1559 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1560 concerned). This may be necessary if you have called
1561 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
1562 limit the overhead that wxWindows incurs by sending update UI events
1565 The flags should be a bitlist of one or more of the following values:
1567 ===================== ==============================
1568 wx.UPDATE_UI_NONE No particular value
1569 wx.UPDATE_UI_RECURSE Call the function for descendants
1570 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1571 ===================== ==============================
1573 If you are calling this function from an OnIdle function, make sure
1574 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1575 to only update the UI elements that need to be updated in idle
1576 time. Some windows update their elements only when necessary, for
1577 example when a menu is about to be shown. The following is an example
1578 of how to call UpdateWindowUI from an idle function::
1580 def OnIdle(self, evt):
1581 if wx.UpdateUIEvent.CanUpdate(self):
1582 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1586 // TODO: using directors?
1587 // // do the window-specific processing after processing the update event
1588 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1592 "Pops up the given menu at the specified coordinates, relative to this window,
1593 and returns control when the user has dismissed the menu. If a menu item is
1594 selected, the corresponding menu event is generated and will be processed as
1595 usual. If the default position is given then the current position of the
1596 mouse cursor will be used.", "");
1597 %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
1598 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1605 "Returns the platform-specific handle (as a long integer) of the
1606 physical window. Currently on wxMac it returns the handle of the
1607 toplevel parent of the window.", "");
1609 return wxPyGetWinHandle(self);
1615 "Associate the window with a new native handle", "");
1617 void AssociateHandle(long handle) {
1618 self->AssociateHandle((WXWidget)handle);
1624 virtual void , DissociateHandle(),
1625 "Dissociate the current native handle from the window", "");
1630 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1631 void OnPaint(wxPaintEvent& event);
1641 bool , HasScrollbar(int orient) const,
1642 "Does the window have the scrollbar for this orientation?", "");
1645 // configure the window scrollbars
1647 virtual void , SetScrollbar( int orientation,
1651 bool refresh = true ),
1652 "Sets the scrollbar properties of a built-in scrollbar.",
1654 :param orientation: Determines the scrollbar whose page size is to
1655 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1657 :param position: The position of the scrollbar in scroll units.
1659 :param thumbSize: The size of the thumb, or visible portion of the
1660 scrollbar, in scroll units.
1662 :param range: The maximum position of the scrollbar.
1664 :param refresh: True to redraw the scrollbar, false otherwise.
1668 virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
1669 "Sets the position of one of the built-in scrollbars.", "");
1672 virtual int , GetScrollPos( int orientation ) const,
1673 "Returns the built-in scrollbar position.", "");
1676 virtual int , GetScrollThumb( int orientation ) const,
1677 "Returns the built-in scrollbar thumb size.", "");
1680 virtual int , GetScrollRange( int orientation ) const,
1681 "Returns the built-in scrollbar range.", "");
1687 virtual void , ScrollWindow( int dx, int dy,
1688 const wxRect* rect = NULL ),
1689 "Physically scrolls the pixels in the window and move child windows
1690 accordingly. Use this function to optimise your scrolling
1691 implementations, to minimise the area that must be redrawn. Note that
1692 it is rarely required to call this function from a user program.","
1694 :param dx: Amount to scroll horizontally.
1696 :param dy: Amount to scroll vertically.
1698 :param rect: Rectangle to invalidate. If this is None, the whole
1699 window is invalidated. If you pass a rectangle corresponding
1700 to the area of the window exposed by the scroll, your
1701 painting handler can optimize painting by checking for the
1702 invalidated region.");
1706 virtual bool , ScrollLines(int lines),
1707 "If the platform and window class supports it, scrolls the window by
1708 the given number of lines down, if lines is positive, or up if lines
1709 is negative. Returns True if the window was scrolled, False if it was
1710 already on top/bottom and nothing was done.", "");
1713 virtual bool , ScrollPages(int pages),
1714 "If the platform and window class supports it, scrolls the window by
1715 the given number of pages down, if pages is positive, or up if pages
1716 is negative. Returns True if the window was scrolled, False if it was
1717 already on top/bottom and nothing was done.", "");
1722 "This is just a wrapper for ScrollLines(-1).", "");
1726 "This is just a wrapper for ScrollLines(1).", "");
1730 "This is just a wrapper for ScrollPages(-1).", "");
1734 "This is just a wrapper for ScrollPages(1).", "");
1739 // context-sensitive help
1740 // ----------------------
1743 void , SetHelpText(const wxString& text),
1744 "Sets the help text to be used as context-sensitive help for this
1745 window. Note that the text is actually stored by the current
1746 wxHelpProvider implementation, and not in the window object itself.", "");
1750 void , SetHelpTextForId(const wxString& text),
1751 "Associate this help text with all windows with the same id as this
1756 wxString , GetHelpText() const,
1757 "Gets the help text to be used as context-sensitive help for this
1758 window. Note that the text is actually stored by the current
1759 wxHelpProvider implementation, and not in the window object itself.", "");
1768 "Attach a tooltip to the window.", "");
1769 %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
1770 void SetToolTip( wxToolTip *tip );
1773 wxToolTip* , GetToolTip() const,
1774 "get the associated tooltip or None if none", "");
1776 // LINK ERROR --> wxString GetToolTipText() const;
1785 // set/retrieve the drop target associated with this window (may be
1786 // NULL; it's owned by the window and will be deleted by it)
1787 %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
1790 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1791 "Associates a drop target with this window. If the window already has
1792 a drop target, it is deleted.", "");
1794 %clear wxPyDropTarget *dropTarget;
1798 virtual wxPyDropTarget *, GetDropTarget() const,
1799 "Returns the associated drop target, which may be None.", "");
1802 DocStr(DragAcceptFiles,
1803 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1804 Only functional on Windows.", "");
1806 void DragAcceptFiles(bool accept);
1809 void DragAcceptFiles(bool accept) {}
1815 // constraints and sizers
1816 // ----------------------
1818 // set the constraints for this window or retrieve them (may be NULL)
1820 void , SetConstraints( wxLayoutConstraints *constraints ),
1821 "Sets the window to have the given layout constraints. If an existing
1822 layout constraints object is already owned by the window, it will be
1823 deleted. Pass None to disassociate and delete the window's current
1826 You must call SetAutoLayout to tell a window to use the constraints
1827 automatically in its default EVT_SIZE handler; otherwise, you must
1828 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1829 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1833 wxLayoutConstraints *, GetConstraints() const,
1834 "Returns a pointer to the window's layout constraints, or None if there
1839 void , SetAutoLayout( bool autoLayout ),
1840 "Determines whether the Layout function will be called automatically
1841 when the window is resized. It is called implicitly by SetSizer but
1842 if you use SetConstraints you should call it manually or otherwise the
1843 window layout won't be correctly updated when its size changes.", "");
1846 bool , GetAutoLayout() const,
1847 "Returns the current autoLayout setting", "");
1851 virtual bool , Layout(),
1852 "Invokes the constraint-based layout algorithm or the sizer-based
1853 algorithm for this window. See SetAutoLayout: when auto layout is on,
1854 this function gets called automatically by the default EVT_SIZE
1855 handler when the window is resized.", "");
1859 void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
1860 "Sets the window to have the given layout sizer. The window will then
1861 own the object, and will take care of its deletion. If an existing
1862 layout sizer object is already owned by the window, it will be deleted
1863 if the deleteOld parameter is true. Note that this function will also
1864 call SetAutoLayout implicitly with a True parameter if the sizer is
1865 non-None, and False otherwise.", "");
1868 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
1869 "The same as SetSizer, except it also sets the size hints for the
1870 window based on the sizer's minimum size.", "");
1874 wxSizer *, GetSizer() const,
1875 "Return the sizer associated with the window by a previous call to
1876 SetSizer or None if there isn't one.", "");
1879 // Track if this window is a member of a sizer
1881 void , SetContainingSizer(wxSizer* sizer),
1882 "This normally does not need to be called by application code. It is
1883 called internally when a window is added to a sizer, and is used so
1884 the window can remove itself from the sizer when it is destroyed.", "");
1887 wxSizer *, GetContainingSizer() const,
1888 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1894 // ----------------------
1895 #if wxUSE_ACCESSIBILITY
1896 // Override to create a specific accessible object.
1897 virtual wxAccessible* CreateAccessible();
1899 // Sets the accessible object.
1900 void SetAccessible(wxAccessible* accessible) ;
1902 // Returns the accessible object.
1903 wxAccessible* GetAccessible() { return m_accessible; };
1905 // Returns the accessible object, creating if necessary.
1906 wxAccessible* GetOrCreateAccessible() ;
1913 virtual void , InheritAttributes(),
1914 "This function is (or should be, in case of custom controls) called
1915 during window creation to intelligently set up the window visual
1916 attributes, that is the font and the foreground and background
1919 By 'intelligently' the following is meant: by default, all windows use
1920 their own default attributes. However if some of the parent's
1921 attributes are explicitly changed (that is, using SetFont and not
1922 SetOwnFont) and if the corresponding attribute hadn't been
1923 explicitly set for this window itself, then this window takes the same
1924 value as used by the parent. In addition, if the window overrides
1925 ShouldInheritColours to return false, the colours will not be changed
1926 no matter what and only the font might.
1928 This rather complicated logic is necessary in order to accommodate the
1929 different usage scenarios. The most common one is when all default
1930 attributes are used and in this case, nothing should be inherited as
1931 in modern GUIs different controls use different fonts (and colours)
1932 than their siblings so they can't inherit the same value from the
1933 parent. However it was also deemed desirable to allow to simply change
1934 the attributes of all children at once by just changing the font or
1935 colour of their common parent, hence in this case we do inherit the
1940 // TODO: Virtualize this with directors
1942 virtual bool , ShouldInheritColours() const,
1943 "Return true from here to allow the colours of this window to be
1944 changed by InheritAttributes, returning false forbids inheriting them
1945 from the parent window.
1947 The base class version returns false, but this method is overridden in
1948 wxControl where it returns true.", "");
1953 def PostCreate(self, pre):
1955 Phase 3 of the 2-phase create <wink!>
1956 Call this method after precreating the window with the 2-phase create method.
1958 self.this = pre.this
1959 self.thisown = pre.thisown
1961 if hasattr(self, '_setOORInfo'):
1962 self._setOORInfo(self)
1963 if hasattr(self, '_setCallbackInfo'):
1964 self._setCallbackInfo(self, self.__class__)
1976 def DLG_PNT(win, point_or_x, y=None):
1978 Convenience function for converting a Point or (x,y) in
1979 dialog units to pixel units.
1982 return win.ConvertDialogPointToPixels(point_or_x)
1984 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
1986 def DLG_SZE(win, size_width, height=None):
1988 Convenience function for converting a Size or (w,h) in
1989 dialog units to pixel units.
1992 return win.ConvertDialogSizeToPixels(size_width)
1994 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
2000 // Unfortunatly the names of these new static methods clash with the
2001 // names wxPython has been using forever for the overloaded
2002 // wxWindow::FindWindow, so instead of swigging them as statics create
2003 // standalone functions for them.
2006 DocStr(wxFindWindowById,
2007 "Find the first window in the application with the given id. If parent
2008 is None, the search will start from all top-level frames and dialog
2009 boxes; if non-None, the search will be limited to the given window
2010 hierarchy. The search is recursive in both cases.", "");
2012 DocStr(wxFindWindowByName,
2013 "Find a window by its name (as given in a window constructor or Create
2014 function call). If parent is None, the search will start from all
2015 top-level frames and dialog boxes; if non-None, the search will be
2016 limited to the given window hierarchy. The search is recursive in both
2019 If no window with such name is found, wx.FindWindowByLabel is called.", "");
2021 DocStr(wxFindWindowByLabel,
2022 "Find a window by its label. Depending on the type of window, the label
2023 may be a window title or panel item label. If parent is None, the
2024 search will start from all top-level frames and dialog boxes; if
2025 non-None, the search will be limited to the given window
2026 hierarchy. The search is recursive in both cases.", "");
2029 MustHaveApp(wxFindWindowById);
2030 MustHaveApp(wxFindWindowByName);
2031 MustHaveApp(wxFindWindowByLabel);
2034 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
2035 return wxWindow::FindWindowById(id, parent);
2038 wxWindow* wxFindWindowByName( const wxString& name,
2039 const wxWindow *parent = NULL ) {
2040 return wxWindow::FindWindowByName(name, parent);
2043 wxWindow* wxFindWindowByLabel( const wxString& label,
2044 const wxWindow *parent = NULL ) {
2045 return wxWindow::FindWindowByLabel(label, parent);
2053 #include <wx/msw/private.h> // to get wxGetWindowId
2058 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
2060 WXHWND hWnd = (WXHWND)_hWnd;
2061 long id = wxGetWindowId(hWnd);
2062 wxWindow* win = new wxWindow;
2064 parent->AddChild(win);
2065 win->SetEventHandler(win);
2068 win->SubclassWin(hWnd);
2069 win->AdoptAttributesFromHWND();
2070 win->SetupColours();
2073 wxPyRaiseNotImplemented();
2079 //---------------------------------------------------------------------------
2081 DocStr(GetTopLevelWindows,
2082 "Returns a list of the the application's top-level windows, (frames,
2083 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
2084 by wxWidgets, and so it is only valid as long as no top-level windows
2085 are closed or new top-level windows are created.
2088 PyObject* GetTopLevelWindows() {
2089 return wxPy_ConvertList(&wxTopLevelWindows);
2093 //---------------------------------------------------------------------------
2094 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob