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
262 %pythonPrepend Destroy "args[0].this.own(False)"
264 virtual bool , Destroy(),
265 "Destroys the window safely. Frames and dialogs are not destroyed
266 immediately when this function is called -- they are added to a list
267 of windows to be deleted on idle time, when all the window's events
268 have been processed. This prevents problems with events being sent to
269 non-existent windows.
271 Returns True if the window has either been successfully deleted, or it
272 has been added to the list of windows pending real deletion.", "");
276 bool , DestroyChildren(),
277 "Destroys all children of a window. Called automatically by the
282 bool , IsBeingDeleted() const,
283 "Is the window in the process of being deleted?", "");
291 // virtual void , SetTitle( const wxString& title),
292 // "Sets the window's title. Applicable only to frames and dialogs.", "");
295 // virtual wxString , GetTitle() const,
296 // "Gets the window's title. Applicable only to frames and dialogs.", "");
299 virtual void , SetLabel(const wxString& label),
300 "Set the text which the window shows in its label if applicable.", "");
303 virtual wxString , GetLabel() const,
304 "Generic way of getting a label from any window, for identification
305 purposes. The interpretation of this function differs from class to
306 class. For frames and dialogs, the value returned is the title. For
307 buttons or static text controls, it is the button text. This function
308 can be useful for meta-programs such as testing tools or special-needs
309 access programs)which need to identify windows by name.", "");
313 virtual void , SetName( const wxString &name ),
314 "Sets the window's name. The window name is used for ressource setting
315 in X, it is not the same as the window title/label", "");
318 virtual wxString , GetName() const,
319 "Returns the windows name. This name is not guaranteed to be unique;
320 it is up to the programmer to supply an appropriate name in the window
321 constructor or via wx.Window.SetName.", "");
325 void , SetWindowVariant( wxWindowVariant variant ),
326 "Sets the variant of the window/font size to use for this window, if
327 the platform supports variants, for example, wxMac.",
331 ======================== =======================================
332 wx.WINDOW_VARIANT_NORMAL Normal size
333 wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
334 wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
335 wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
336 ======================== =======================================
340 wxWindowVariant , GetWindowVariant() const,
345 void , SetId( wxWindowID winid ),
346 "Sets the identifier of the window. Each window has an integer
347 identifier. If the application has not provided one, an identifier
348 will be generated. Normally, the identifier should be provided on
349 creation and should not be modified subsequently.", "");
352 wxWindowID , GetId() const,
353 "Returns the identifier of the window. Each window has an integer
354 identifier. If the application has not provided one (or the default Id
355 -1 is used) then an unique identifier with a negative value will be
360 static int , NewControlId(),
361 "Generate a control id for the controls which were not given one.", "");
365 static int , NextControlId(int winid),
366 "Get the id of the control following the one with the given
367 autogenerated) id", "");
371 static int , PrevControlId(int winid),
372 "Get the id of the control preceding the one with the given
373 autogenerated) id", "");
377 virtual wxLayoutDirection , GetLayoutDirection() const,
378 "Get the layout direction (LTR or RTL) for this window. Returns
379 ``wx.Layout_Default`` if layout direction is not supported.", "");
382 virtual void , SetLayoutDirection(wxLayoutDirection dir),
383 "Set the layout direction (LTR or RTL) for this window.", "");
387 virtual wxCoord , AdjustForLayoutDirection(wxCoord x,
389 wxCoord widthTotal) const,
390 "Mirror coordinates for RTL layout if this window uses it and if the
391 mirroring is not done automatically like Win32.", "");
402 void , SetSize( const wxSize& size ),
403 "Sets the size of the window in pixels.", "");
407 void , SetSize( int x, int y, int width, int height,
408 int sizeFlags = wxSIZE_AUTO ),
409 "Sets the position and size of the window in pixels. The sizeFlags
410 parameter indicates the interpretation of the other params if they are
413 ======================== ======================================
414 wx.SIZE_AUTO A -1 indicates that a class-specific
415 default should be used.
416 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
417 -1 values are supplied.
418 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
419 interpreted as real dimensions, not
421 ======================== ======================================
427 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
428 "Sets the position and size of the window in pixels using a wx.Rect.", "",
433 void , SetSize( int width, int height ),
434 "Sets the size of the window in pixels.", "",
439 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
440 "Moves the window to the given position.", "");
442 %pythoncode { SetPosition = Move }
446 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
447 "Moves the window to the given position.", "",
451 void , SetInitialSize(const wxSize& size=wxDefaultSize),
452 "A 'Smart' SetSize that will fill in default size components with the
453 window's *best size* values. Also set's the minsize for use with sizers.", "");
454 %pythoncode { SetBestFittingSize = wx._deprecated(SetInitialSize, 'Use `SetInitialSize`') }
458 virtual void , Raise(),
459 "Raises the window to the top of the window hierarchy. In current
460 version of wxWidgets this works both for manage and child windows.", "");
463 virtual void , Lower(),
464 "Lowers the window to the bottom of the window hierarchy. In current
465 version of wxWidgets this works both for manage and child windows.", "");
469 // client size is the size of the area available for subwindows
470 DocStr(SetClientSize,
471 "This sets the size of the window client area in pixels. Using this
472 function to size a window tends to be more device-independent than
473 wx.Window.SetSize, since the application need not worry about what
474 dimensions the border or title bar have when trying to fit the window
475 around panel items, for example.", "");
476 void SetClientSize( const wxSize& size );
477 %Rename(SetClientSizeWH, void, SetClientSize( int width, int height ));
478 %Rename(SetClientRect, void, SetClientSize(const wxRect& rect));
481 DocStr(GetPosition, // sets the docstring for both
482 "Get the window's position. Notice that the position is in client
483 coordinates for child windows and screen coordinates for the top level
484 ones, use `GetScreenPosition` if you need screen coordinates for all
485 kinds of windows.", "");
486 wxPoint GetPosition() const;
489 void, GetPosition(int *OUTPUT, int *OUTPUT) const,
490 "GetPositionTuple() -> (x,y)",
494 DocStr(GetScreenPosition, // sets the docstring for both
495 "Get the position of the window in screen coordinantes.", "");
496 wxPoint GetScreenPosition() const;
498 void, GetScreenPosition(int *OUTPUT, int *OUTPUT) const,
499 "GetScreenPositionTuple() -> (x,y)",
500 GetScreenPositionTuple);
503 wxRect , GetScreenRect() const,
504 "Returns the size and position of the window in screen coordinantes as
505 a `wx.Rect` object.", "
506 :see: `GetRect`, `GetScreenPosition`");
509 DocStr(GetSize, "Get the window size.", "");
510 wxSize GetSize() const;
512 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
513 "GetSizeTuple() -> (width, height)",
519 wxRect , GetRect() const,
520 "Returns the size and position of the window as a `wx.Rect` object.", "");
523 DocStr(GetClientSize,
524 "This gets the size of the window's 'client area' in pixels. The client
525 area is the area which may be drawn on by the programmer, excluding
526 title bar, border, scrollbars, etc.", "");
527 wxSize GetClientSize() const;
529 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
530 "GetClientSizeTuple() -> (width, height)",
536 virtual wxPoint , GetClientAreaOrigin() const,
537 "Get the origin of the client area of the window relative to the
538 window's top left corner (the client area may be shifted because of
539 the borders, scrollbars, other decorations...)", "");
543 wxRect , GetClientRect() const,
544 "Get the client area position and size as a `wx.Rect` object.", "");
549 "This function returns the best acceptable minimal size for the
550 window, if applicable. For example, for a static text control, it will
551 be the minimal size such that the control label is not truncated. For
552 windows containing subwindows (suzh aswx.Panel), the size returned by
553 this function will be the same as the size the window would have had
554 after calling Fit.", "");
555 wxSize GetBestSize() const;
557 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
558 "GetBestSizeTuple() -> (width, height)",
563 void , InvalidateBestSize(),
564 "Reset the cached best size value so it will be recalculated the next
565 time it is needed.", "");
568 void , CacheBestSize(const wxSize& size) const,
569 "Cache the best size so it doesn't need to be calculated again, (at least until
570 some properties of the window change.)", "");
574 wxSize , GetEffectiveMinSize() const,
575 "This function will merge the window's best size into the window's
576 minimum size, giving priority to the min size components, and returns
579 %pythoncode { GetBestFittingSize = wx._deprecated(GetEffectiveMinSize, 'Use `GetEffectiveMinSize` instead.') }
582 def GetAdjustedBestSize(self):
583 s = self.GetBestSize()
584 return wx.Size(max(s.width, self.GetMinWidth()),
585 max(s.height, self.GetMinHeight()))
586 GetAdjustedBestSize = wx._deprecated(GetAdjustedBestSize, 'Use `GetEffectiveMinSize` instead.')
592 void , Center( int direction = wxBOTH ),
593 "Centers the window. The parameter specifies the direction for
594 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
595 also include wx.CENTER_ON_SCREEN flag if you want to center the window
596 on the entire screen and not on its parent window. If it is a
597 top-level window and has no parent then it will always be centered
598 relative to the screen.", "");
599 %pythoncode { Centre = Center }
603 void , CenterOnParent(int dir = wxBOTH),
604 "Center with respect to the the parent window", "");
605 %pythoncode { CentreOnParent = CenterOnParent }
610 virtual void , Fit(),
611 "Sizes the window so that it fits around its subwindows. This function
612 won't do anything if there are no subwindows and will only really work
613 correctly if sizers are used for the subwindows layout. Also, if the
614 window has exactly one subwindow it is better (faster and the result
615 is more precise as Fit adds some margin to account for fuzziness of
616 its calculations) to call window.SetClientSize(child.GetSize())
617 instead of calling Fit.", "");
621 virtual void , FitInside(),
622 "Similar to Fit, but sizes the interior (virtual) size of a
623 window. Mainly useful with scrolled windows to reset scrollbars after
624 sizing changes that do not trigger a size event, and/or scrolled
625 windows without an interior sizer. This function similarly won't do
626 anything if there are no subwindows.", "");
631 "Allows specification of minimum and maximum window sizes, and window
632 size increments. If a pair of values is not set (or set to -1), the
633 default values will be used. If this function is called, the user
634 will not be able to size the window outside the given bounds (if it is
635 a top-level window.) Sizers will also inspect the minimum window size
636 and will use that value if set when calculating layout.
638 The resizing increments are only significant under Motif or Xt.", "
640 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
642 virtual void SetSizeHints( int minW, int minH,
643 int maxW = -1, int maxH = -1,
644 int incW = -1, int incH = -1 );
645 %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize,
646 const wxSize& maxSize=wxDefaultSize,
647 const wxSize& incSize=wxDefaultSize));
650 DocStr(SetVirtualSizeHints,
651 "Allows specification of minimum and maximum virtual window sizes. If a
652 pair of values is not set (or set to -1), the default values will be
653 used. If this function is called, the user will not be able to size
654 the virtual area of the window outside the given bounds.", "");
655 virtual void SetVirtualSizeHints( int minW, int minH,
656 int maxW = -1, int maxH = -1 );
657 %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints(
658 const wxSize& minSize, const wxSize& maxSize=wxDefaultSize));
663 virtual wxSize , GetMaxSize() const,
667 virtual wxSize , GetMinSize() const,
671 virtual void , SetMinSize(const wxSize& minSize),
672 "A more convenient method than `SetSizeHints` for setting just the
676 virtual void , SetMaxSize(const wxSize& maxSize),
677 "A more convenient method than `SetSizeHints` for setting just the
683 virtual int , GetMinWidth() const,
687 virtual int , GetMinHeight() const,
691 int , GetMaxWidth() const,
695 int , GetMaxHeight() const,
700 DocStr(SetVirtualSize,
701 "Set the the virtual size of a window in pixels. For most windows this
702 is just the client area of the window, but for some like scrolled
703 windows it is more or less independent of the screen window size.", "");
704 void SetVirtualSize(const wxSize& size );
705 %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h ));
708 DocStr(GetVirtualSize,
709 "Get the the virtual size of the window in pixels. For most windows
710 this is just the client area of the window, but for some like scrolled
711 windows it is more or less independent of the screen window size.", "");
712 wxSize GetVirtualSize() const;
714 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
715 "GetVirtualSizeTuple() -> (width, height)",
716 GetVirtualSizeTuple);
719 // TODO: using directors?
720 // // Override these methods for windows that have a virtual size
721 // // independent of their client size. eg. the virtual area of a
722 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
723 // virtual void DoSetVirtualSize( int x, int y );
724 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
728 virtual wxSize , GetBestVirtualSize() const,
729 "Return the largest of ClientSize and BestSize (as determined by a
730 sizer, interior children, or other means)", "");
734 // void SetScrollHelper( wxScrollHelper *sh );
735 // wxScrollHelper *GetScrollHelper();
742 virtual bool , Show( bool show = true ),
743 "Shows or hides the window. You may need to call Raise for a top level
744 window if you want to bring it to top, although this is not needed if
745 Show is called immediately after the frame creation. Returns True if
746 the window has been shown or hidden or False if nothing was done
747 because it already was in the requested state.", "");
751 "Equivalent to calling Show(False).", "");
755 virtual bool , Enable( bool enable = true ),
756 "Enable or disable the window for user input. Note that when a parent
757 window is disabled, all of its children are disabled as well and they
758 are reenabled again when the parent is. Returns true if the window
759 has been enabled or disabled, false if nothing was done, i.e. if the
760 window had already been in the specified state.", "");
764 "Disables the window, same as Enable(false).", "");
768 bool , IsShown() const,
769 "Returns true if the window is shown, false if it has been hidden.", "");
772 bool , IsEnabled() const,
773 "Returns true if the window is enabled for input, false otherwise.", "");
776 virtual bool , IsShownOnScreen() const,
777 "Returns ``True`` if the window is physically visible on the screen,
778 i.e. it is shown and all its parents up to the toplevel window are
779 shown as well.", "");
785 virtual void , SetWindowStyleFlag( long style ),
786 "Sets the style of the window. Please note that some styles cannot be
787 changed after the window creation and that Refresh() might need to be
788 called after changing the others for the change to take place
792 virtual long , GetWindowStyleFlag() const,
793 "Gets the window style that was passed to the constructor or Create
796 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
800 bool , HasFlag(int flag) const,
801 "Test if the given style is set for this window.", "");
805 virtual bool , IsRetained() const,
806 "Returns true if the window is retained, false otherwise. Retained
807 windows are only available on X platforms.", "");
812 virtual void , SetExtraStyle(long exStyle),
813 "Sets the extra style bits for the window. Extra styles are the less
814 often used style bits which can't be set with the constructor or with
815 SetWindowStyleFlag()", "");
818 long , GetExtraStyle() const,
819 "Returns the extra style bits for the window.", "");
824 virtual void , MakeModal(bool modal = true),
825 "Disables all other windows in the application so that the user can
826 only interact with this window. Passing False will reverse this
832 virtual void , SetThemeEnabled(bool enableTheme),
833 "This function tells a window if it should use the system's \"theme\"
834 code to draw the windows' background instead if its own background
835 drawing code. This will only have an effect on platforms that support
836 the notion of themes in user defined windows. One such platform is
837 GTK+ where windows can have (very colourful) backgrounds defined by a
838 user's selected theme.
840 Dialogs, notebook pages and the status bar have this flag set to true
841 by default so that the default look and feel is simulated best.", "");
844 virtual bool , GetThemeEnabled() const,
845 "Return the themeEnabled flag.", "");
848 // TODO with directors
849 // // controls by default inherit the colours of their parents, if a
850 // // particular control class doesn't want to do it, it can override
851 // // ShouldInheritColours() to return False
852 // virtual bool ShouldInheritColours() const;
858 // focus and keyboard handling
859 // ---------------------------
863 virtual void , SetFocus(),
864 "Set's the focus to this window, allowing it to receive keyboard input.", "");
867 virtual void , SetFocusFromKbd(),
868 "Set focus to this window as the result of a keyboard action. Normally
869 only called internally.", "");
874 static wxWindow *, FindFocus(),
875 "Returns the window or control that currently has the keyboard focus,
880 virtual bool , AcceptsFocus() const,
881 "Can this window have focus?", "");
885 virtual bool , AcceptsFocusFromKeyboard() const,
886 "Can this window be given focus by keyboard navigation? if not, the
887 only way to give it focus (provided it accepts it at all) is to click
894 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
895 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
896 "Does keyboard navigation from this window to another, by sending a
897 `wx.NavigationKeyEvent`.", "
899 :param flags: A combination of the ``IsForward`` or ``IsBackward``
900 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
901 class, which determine if the navigation should be in forward
902 or reverse order, and if it should be able to cross parent
903 window boundaries, such as between notebook pages or MDI child
904 frames. Typically the status of the Shift key (for forward or
905 backward) or the Control key (for WinChange) would be used to
906 determine how to set the flags.
908 One situation in which you may wish to call this method is from a text
909 control custom keypress handler to do the default navigation behaviour
910 for the tab key, since the standard default behaviour for a multiline
911 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
912 not navigate to the next control.");
917 void , MoveAfterInTabOrder(wxWindow *win),
918 "Moves this window in the tab navigation order after the specified
919 sibling window. This means that when the user presses the TAB key on
920 that other window, the focus switches to this window.
922 The default tab order is the same as creation order. This function
923 and `MoveBeforeInTabOrder` allow to change it after creating all the
929 void , MoveBeforeInTabOrder(wxWindow *win),
930 "Same as `MoveAfterInTabOrder` except that it inserts this window just
931 before win instead of putting it right after it.", "");
940 // parent/children relations
941 // -------------------------
944 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
947 "Returns a list of the window's children. NOTE: Currently this is a
948 copy of the child window list maintained by the window, so the return
949 value of this function is only valid as long as the window's children
950 do not change.", "");
951 PyObject* GetChildren() {
952 wxWindowList& list = self->GetChildren();
953 return wxPy_ConvertList(&list);
958 wxWindow *, GetParent() const,
959 "Returns the parent window of this window, or None if there isn't one.", "");
962 wxWindow *, GetGrandParent() const,
963 "Returns the parent of the parent of this window, or None if there
969 virtual bool , IsTopLevel() const,
970 "Returns true if the given window is a top-level one. Currently all
971 frames and dialogs are always considered to be top-level windows (even
972 if they have a parent window).", "");
975 // change the real parent of this window, return True if the parent
976 // was changed, False otherwise (error or newParent == oldParent)
978 virtual bool , Reparent( wxWindow *newParent ),
979 "Reparents the window, i.e the window will be removed from its current
980 parent window (e.g. a non-standard toolbar in a wxFrame) and then
981 re-inserted into another. Available on Windows and GTK. Returns True
982 if the parent was changed, False otherwise (error or newParent ==
987 virtual void , AddChild( wxWindow *child ),
988 "Adds a child window. This is called automatically by window creation
989 functions so should not be required by the application programmer.", "");
992 virtual void , RemoveChild( wxWindow *child ),
993 "Removes a child window. This is called automatically by window
994 deletion functions so should not be required by the application
998 DocStr(SetDoubleBuffered,
999 "Currently wxGTK2 only.", "");
1001 void SetDoubleBuffered(bool on);
1004 void SetDoubleBuffered(bool on) {}
1009 // looking for windows
1010 // -------------------
1013 wxWindow *, FindWindow( long winid ),
1014 "Find a chld of this window by window ID", "",
1018 wxWindow *, FindWindow( const wxString& name ),
1019 "Find a child of this window by name", "",
1024 // event handler stuff
1025 // -------------------
1028 wxEvtHandler *, GetEventHandler() const,
1029 "Returns the event handler for this window. By default, the window is
1030 its own event handler.", "");
1034 void , SetEventHandler( wxEvtHandler *handler ),
1035 "Sets the event handler for this window. An event handler is an object
1036 that is capable of processing the events sent to a window. (In other
1037 words, is able to dispatch the events to handler function.) By
1038 default, the window is its own event handler, but an application may
1039 wish to substitute another, for example to allow central
1040 implementation of event-handling for a variety of different window
1043 It is usually better to use `wx.Window.PushEventHandler` since this sets
1044 up a chain of event handlers, where an event not handled by one event
1045 handler is handed off to the next one in the chain.", "");
1049 void , PushEventHandler( wxEvtHandler *handler ),
1050 "Pushes this event handler onto the event handler stack for the window.
1051 An event handler is an object that is capable of processing the events
1052 sent to a window. (In other words, is able to dispatch the events to
1053 handler function.) By default, the window is its own event handler,
1054 but an application may wish to substitute another, for example to
1055 allow central implementation of event-handling for a variety of
1056 different window classes.
1058 wx.Window.PushEventHandler allows an application to set up a chain of
1059 event handlers, where an event not handled by one event handler is
1060 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
1061 to remove the event handler. Ownership of the handler is *not* given
1062 to the window, so you should be sure to pop the handler before the
1063 window is destroyed and either let PopEventHandler destroy it, or call
1064 its Destroy method yourself.", "");
1068 wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
1069 "Removes and returns the top-most event handler on the event handler
1070 stack. If deleteHandler is True then the wx.EvtHandler object will be
1071 destroyed after it is popped, and ``None`` will be returned instead.", "");
1075 bool , RemoveEventHandler(wxEvtHandler *handler),
1076 "Find the given handler in the event handler chain and remove (but not
1077 delete) it from the event handler chain, returns True if it was found
1078 and False otherwise (this also results in an assert failure so this
1079 function should only be called when the handler is supposed to be
1088 // a window may have an associated validator which is used to control
1091 virtual void , SetValidator( const wxValidator &validator ),
1092 "Deletes the current validator (if any) and sets the window validator,
1093 having called wx.Validator.Clone to create a new validator of this
1097 virtual wxValidator *, GetValidator(),
1098 "Returns a pointer to the current validator for the window, or None if
1099 there is none.", "");
1103 virtual bool , Validate(),
1104 "Validates the current values of the child controls using their
1105 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1106 style flag set, the method will also call Validate() of all child
1107 windows. Returns false if any of the validations failed.", "");
1111 virtual bool , TransferDataToWindow(),
1112 "Transfers values to child controls from data areas specified by their
1113 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1114 style flag set, the method will also call TransferDataToWindow() of
1115 all child windows.", "");
1118 virtual bool , TransferDataFromWindow(),
1119 "Transfers values from child controls to data areas specified by their
1120 validators. Returns false if a transfer failed. If the window has
1121 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1122 also call TransferDataFromWindow() of all child windows.", "");
1126 virtual void , InitDialog(),
1127 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1128 to the dialog via validators.", "");
1137 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1138 "Sets the accelerator table for this window.", "");
1141 wxAcceleratorTable *, GetAcceleratorTable(),
1142 "Gets the accelerator table for this window.", "");
1148 // hot keys (system wide accelerators)
1149 // -----------------------------------
1151 DocStr(RegisterHotKey,
1152 "Registers a system wide hotkey. Every time the user presses the hotkey
1153 registered here, this window will receive a hotkey event. It will
1154 receive the event even if the application is in the background and
1155 does not have the input focus because the user is working with some
1156 other application. To bind an event handler function to this hotkey
1157 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1158 hotkey was registered successfully.", "");
1159 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1161 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1168 DocStr(UnregisterHotKey,
1169 "Unregisters a system wide hotkey.", "");
1170 bool UnregisterHotKey(int hotkeyId) {
1172 return self->UnregisterHotKey(hotkeyId);
1181 // "dialog units" translations
1182 // ---------------------------
1184 DocStr(ConvertDialogToPixels,
1185 "Converts a point or size from dialog units to pixels. Dialog units
1186 are used for maintaining a dialog's proportions even if the font
1187 changes. For the x dimension, the dialog units are multiplied by the
1188 average character width and then divided by 4. For the y dimension,
1189 the dialog units are multiplied by the average character height and
1190 then divided by 8.", "");
1191 %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1192 %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
1193 %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1194 %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
1197 DocStr(ConvertPixelPointToDialog,
1198 "Converts a point or size from pixels to dialog units. Dialog units
1199 are used for maintaining a dialog's proportions even if the font
1200 changes. For the x dimension, the dialog units are multiplied by the
1201 average character width and then divided by 4. For the y dimension,
1202 the dialog units are multiplied by the average character height and
1203 then divided by 8.", "");
1204 %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
1205 %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
1213 virtual void , WarpPointer(int x, int y),
1214 "Moves the pointer to the given position on the window.
1216 NOTE: This function is not supported under Mac because Apple Human
1217 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1221 void , CaptureMouse(),
1222 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1223 release the capture.
1225 Note that wxWindows maintains the stack of windows having captured the
1226 mouse and when the mouse is released the capture returns to the window
1227 which had had captured it previously and it is only really released if
1228 there were no previous window. In particular, this means that you must
1229 release the mouse as many times as you capture it, unless the window
1230 receives the `wx.MouseCaptureLostEvent` event.
1232 Any application which captures the mouse in the beginning of some
1233 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
1234 operation when it receives the event. The event handler must not
1235 recapture mouse.", "");
1238 void , ReleaseMouse(),
1239 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1243 static wxWindow *, GetCapture(),
1244 "Returns the window which currently captures the mouse or None", "");
1248 virtual bool , HasCapture() const,
1249 "Returns true if this window has the current mouse capture.", "");
1255 // painting the window
1256 // -------------------
1259 virtual void , Refresh( bool eraseBackground = true,
1260 const wxRect *rect = NULL ),
1261 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1262 will be repainted. Causes an EVT_PAINT event to be generated and sent
1263 to the window.", "");
1267 void , RefreshRect(const wxRect& rect, bool eraseBackground = true),
1268 "Redraws the contents of the given rectangle: the area inside it will
1269 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1273 virtual void , Update(),
1274 "Calling this method immediately repaints the invalidated area of the
1275 window instead of waiting for the EVT_PAINT event to happen, (normally
1276 this would usually only happen when the flow of control returns to the
1277 event loop.) Notice that this function doesn't refresh the window and
1278 does nothing if the window has been already repainted. Use `Refresh`
1279 first if you want to immediately redraw the window (or some portion of
1280 it) unconditionally.", "");
1284 virtual void , ClearBackground(),
1285 "Clears the window by filling it with the current background
1286 colour. Does not cause an erase background event to be generated.", "");
1291 virtual void , Freeze(),
1292 "Freezes the window or, in other words, prevents any updates from
1293 taking place on screen, the window is not redrawn at all. Thaw must be
1294 called to reenable window redrawing. Calls to Freeze/Thaw may be
1295 nested, with the actual Thaw being delayed until all the nesting has
1298 This method is useful for visual appearance optimization (for example,
1299 it is a good idea to use it before inserting large amount of text into
1300 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1301 for all controls so it is mostly just a hint to wxWindows and not a
1302 mandatory directive.", "");
1306 virtual bool , IsFrozen() const,
1307 "Returns ``True`` if the window has been frozen and not thawed yet.
1309 :see: `Freeze` and `Thaw`", "");
1314 virtual void , Thaw(),
1315 "Reenables window updating after a previous call to Freeze. Calls to
1316 Freeze/Thaw may be nested, so Thaw must be called the same number of
1317 times that Freeze was before the window will be updated.", "");
1321 virtual void , PrepareDC( wxDC & dc ),
1322 "Call this function to prepare the device context for drawing a
1323 scrolled image. It sets the device origin according to the current
1324 scroll position.", "");
1327 virtual bool , IsDoubleBuffered() const,
1328 "Returns ``True`` if the window contents is double-buffered by the
1329 system, i.e. if any drawing done on the window is really done on a
1330 temporary backing surface and transferred to the screen all at once
1335 wxRegion& , GetUpdateRegion(),
1336 "Returns the region specifying which parts of the window have been
1337 damaged. Should only be called within an EVT_PAINT handler.", "");
1341 wxRect , GetUpdateClientRect() const,
1342 "Get the update rectangle region bounding box in client coords.", "");
1346 "Returns true if the given point or rectangle area has been exposed
1347 since the last repaint. Call this in an paint event handler to
1348 optimize redrawing by only redrawing those areas, which have been
1350 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1351 %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
1352 %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
1356 // colours, fonts and cursors
1357 // --------------------------
1361 virtual wxVisualAttributes , GetDefaultAttributes() const,
1362 "Get the default attributes for an instance of this class. This is
1363 useful if you want to use the same font or colour in your own control
1364 as in a standard control -- which is a much better idea than hard
1365 coding specific colours or fonts which might look completely out of
1366 place on the user's system, especially if it uses themes.", "");
1370 static wxVisualAttributes ,
1371 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1372 "Get the default attributes for this class. This is useful if you want
1373 to use the same font or colour in your own control as in a standard
1374 control -- which is a much better idea than hard coding specific
1375 colours or fonts which might look completely out of place on the
1376 user's system, especially if it uses themes.
1378 The variant parameter is only relevant under Mac currently and is
1379 ignore under other platforms. Under Mac, it will change the size of
1380 the returned font. See `wx.Window.SetWindowVariant` for more about
1385 virtual bool , SetBackgroundColour( const wxColour &colour ),
1386 "Sets the background colour of the window. Returns True if the colour
1387 was changed. The background colour is usually painted by the default
1388 EVT_ERASE_BACKGROUND event handler function under Windows and
1389 automatically under GTK. Using `wx.NullColour` will reset the window
1390 to the default background colour.
1392 Note that setting the background colour may not cause an immediate
1393 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1394 calling this function.
1396 Using this function will disable attempts to use themes for this
1397 window, if the system supports them. Use with care since usually the
1398 themes represent the appearance chosen by the user to be used for all
1399 applications on the system.", "");
1402 void , SetOwnBackgroundColour(const wxColour& colour),
1408 virtual bool , SetForegroundColour( const wxColour &colour ),
1409 "Sets the foreground colour of the window. Returns True is the colour
1410 was changed. The interpretation of foreground colour is dependent on
1411 the window class; it may be the text colour or other colour, or it may
1412 not be used at all.", "");
1415 void , SetOwnForegroundColour(const wxColour& colour),
1421 wxColour , GetBackgroundColour() const,
1422 "Returns the background colour of the window.", "");
1425 wxColour , GetForegroundColour() const,
1426 "Returns the foreground colour of the window. The interpretation of
1427 foreground colour is dependent on the window class; it may be the text
1428 colour or other colour, or it may not be used at all.", "");
1431 bool , InheritsBackgroundColour() const,
1435 bool , UseBgCol() const,
1440 // // if the window shouldn't inherit its colour from the parent, override
1441 // // this function to return true
1443 // // this is currently only used by wxMSW and wxUniv but should be useful for
1444 // // the other ports too
1445 // virtual bool ProvidesBackground() const;
1448 // Set/get the background style.
1449 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1451 virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
1452 "Returns the background style of the window. The background style
1453 indicates how the background of the window is drawn.
1455 ====================== ========================================
1456 wx.BG_STYLE_SYSTEM The background colour or pattern should
1457 be determined by the system
1458 wx.BG_STYLE_COLOUR The background should be a solid colour
1459 wx.BG_STYLE_CUSTOM The background will be implemented by the
1461 ====================== ========================================
1463 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
1464 a custom background, such as a tiled bitmap. Currently the style has
1465 no effect on other platforms.
1467 :see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
1470 virtual wxBackgroundStyle , GetBackgroundStyle() const,
1471 "Returns the background style of the window.
1473 :see: `SetBackgroundStyle`", "");
1477 bool , HasTransparentBackground(),
1478 "Returns True if this window's background is transparent (as, for
1479 example, for `wx.StaticText`) and should show the parent window's
1482 This method is mostly used internally by the library itself and you
1483 normally shouldn't have to call it. You may, however, have to override
1484 it in your custom control classes to ensure that background is painted
1489 virtual bool , SetCursor( const wxCursor &cursor ),
1490 "Sets the window's cursor. Notice that the window cursor also sets it
1491 for the children of the window implicitly.
1493 The cursor may be wx.NullCursor in which case the window cursor will
1494 be reset back to default.", "");
1497 wxCursor , GetCursor(),
1498 "Return the cursor associated with this window.", "");
1503 virtual bool , SetFont( const wxFont &font ),
1504 "Sets the font for this window.", "");
1507 void , SetOwnFont(const wxFont& font),
1514 "Returns the default font used for this window.", "");
1518 %disownarg( wxCaret *caret );
1520 void , SetCaret(wxCaret *caret),
1521 "Sets the caret associated with the window.", "");
1522 %cleardisown( wxCaret *caret );
1525 wxCaret *, GetCaret() const,
1526 "Returns the caret associated with the window.", "");
1531 virtual int , GetCharHeight() const,
1532 "Get the (average) character size for the current font.", "");
1535 virtual int , GetCharWidth() const,
1536 "Get the (average) character size for the current font.", "");
1541 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1542 "GetTextExtent(String string) -> (width, height)",
1543 "Get the width and height of the text using the current font.", "");
1545 void, GetTextExtent(const wxString& string,
1546 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1547 const wxFont* font = NULL),
1548 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1549 "Get the width, height, decent and leading of the text using the
1550 current or specified font.", "",
1555 // client <-> screen coords
1556 // ------------------------
1558 %apply int * INOUT { int* x, int* y };
1560 // translate to/from screen/client coordinates
1562 void , ClientToScreen( int *x, int *y ) const,
1563 "ClientToScreenXY(int x, int y) -> (x,y)",
1564 "Converts to screen coordinates from coordinates relative to this window.", "",
1568 void , ScreenToClient( int *x, int *y ) const,
1569 "ScreenToClientXY(int x, int y) -> (x,y)",
1570 "Converts from screen to client window coordinates.", "",
1575 wxPoint , ClientToScreen(const wxPoint& pt) const,
1576 "Converts to screen coordinates from coordinates relative to this window.", "");
1579 wxPoint , ScreenToClient(const wxPoint& pt) const,
1580 "Converts from screen to client window coordinates.", "");
1585 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1586 "Test where the given (in client coords) point lies", "",
1590 wxHitTest , HitTest(const wxPoint& pt) const,
1591 "Test where the given (in client coords) point lies", "");
1599 %nokwargs GetBorder;
1601 wxBorder , GetBorder(long flags) const,
1602 "Get the window border style from the given flags: this is different
1603 from simply doing flags & wxBORDER_MASK because it uses
1604 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1609 wxBorder , GetBorder() const,
1610 "Get border for the flags of this window", "");
1616 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1617 "This function sends EVT_UPDATE_UI events to the window. The particular
1618 implementation depends on the window; for example a wx.ToolBar will
1619 send an update UI event for each toolbar button, and a wx.Frame will
1620 send an update UI event for each menubar menu item. You can call this
1621 function from your application to ensure that your UI is up-to-date at
1622 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1623 concerned). This may be necessary if you have called
1624 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
1625 limit the overhead that wxWindows incurs by sending update UI events
1628 The flags should be a bitlist of one or more of the following values:
1630 ===================== ==============================
1631 wx.UPDATE_UI_NONE No particular value
1632 wx.UPDATE_UI_RECURSE Call the function for descendants
1633 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1634 ===================== ==============================
1636 If you are calling this function from an OnIdle function, make sure
1637 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1638 to only update the UI elements that need to be updated in idle
1639 time. Some windows update their elements only when necessary, for
1640 example when a menu is about to be shown. The following is an example
1641 of how to call UpdateWindowUI from an idle function::
1643 def OnIdle(self, evt):
1644 if wx.UpdateUIEvent.CanUpdate(self):
1645 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1649 // TODO: using directors?
1650 // // do the window-specific processing after processing the update event
1651 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1655 "Pops up the given menu at the specified coordinates, relative to this window,
1656 and returns control when the user has dismissed the menu. If a menu item is
1657 selected, the corresponding menu event is generated and will be processed as
1658 usual. If the default position is given then the current position of the
1659 mouse cursor will be used.", "");
1660 %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
1661 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1665 virtual bool , HasMultiplePages() const,
1671 "Returns the platform-specific handle (as a long integer) of the
1672 physical window. Currently on wxMac it returns the handle of the
1673 toplevel parent of the window.", "");
1675 return wxPyGetWinHandle(self);
1681 "Associate the window with a new native handle", "");
1683 void AssociateHandle(long handle) {
1684 self->AssociateHandle((WXWidget)handle);
1690 virtual void , DissociateHandle(),
1691 "Dissociate the current native handle from the window", "");
1696 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1697 void OnPaint(wxPaintEvent& event);
1707 bool , HasScrollbar(int orient) const,
1708 "Does the window have the scrollbar for this orientation?", "");
1711 // configure the window scrollbars
1713 virtual void , SetScrollbar( int orientation,
1717 bool refresh = true ),
1718 "Sets the scrollbar properties of a built-in scrollbar.",
1720 :param orientation: Determines the scrollbar whose page size is to
1721 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1723 :param position: The position of the scrollbar in scroll units.
1725 :param thumbSize: The size of the thumb, or visible portion of the
1726 scrollbar, in scroll units.
1728 :param range: The maximum position of the scrollbar.
1730 :param refresh: True to redraw the scrollbar, false otherwise.
1734 virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
1735 "Sets the position of one of the built-in scrollbars.", "");
1738 virtual int , GetScrollPos( int orientation ) const,
1739 "Returns the built-in scrollbar position.", "");
1742 virtual int , GetScrollThumb( int orientation ) const,
1743 "Returns the built-in scrollbar thumb size.", "");
1746 virtual int , GetScrollRange( int orientation ) const,
1747 "Returns the built-in scrollbar range.", "");
1753 virtual void , ScrollWindow( int dx, int dy,
1754 const wxRect* rect = NULL ),
1755 "Physically scrolls the pixels in the window and move child windows
1756 accordingly. Use this function to optimise your scrolling
1757 implementations, to minimise the area that must be redrawn. Note that
1758 it is rarely required to call this function from a user program.","
1760 :param dx: Amount to scroll horizontally.
1762 :param dy: Amount to scroll vertically.
1764 :param rect: Rectangle to invalidate. If this is None, the whole
1765 window is invalidated. If you pass a rectangle corresponding
1766 to the area of the window exposed by the scroll, your
1767 painting handler can optimize painting by checking for the
1768 invalidated region.");
1772 virtual bool , ScrollLines(int lines),
1773 "If the platform and window class supports it, scrolls the window by
1774 the given number of lines down, if lines is positive, or up if lines
1775 is negative. Returns True if the window was scrolled, False if it was
1776 already on top/bottom and nothing was done.", "");
1779 virtual bool , ScrollPages(int pages),
1780 "If the platform and window class supports it, scrolls the window by
1781 the given number of pages down, if pages is positive, or up if pages
1782 is negative. Returns True if the window was scrolled, False if it was
1783 already on top/bottom and nothing was done.", "");
1788 "This is just a wrapper for ScrollLines(-1).", "");
1792 "This is just a wrapper for ScrollLines(1).", "");
1796 "This is just a wrapper for ScrollPages(-1).", "");
1800 "This is just a wrapper for ScrollPages(1).", "");
1805 // context-sensitive help
1806 // ----------------------
1809 void , SetHelpText(const wxString& text),
1810 "Sets the help text to be used as context-sensitive help for this
1811 window. Note that the text is actually stored by the current
1812 `wx.HelpProvider` implementation, and not in the window object itself.", "");
1816 void , SetHelpTextForId(const wxString& text),
1817 "Associate this help text with all windows with the same id as this
1822 virtual wxString , GetHelpTextAtPoint(const wxPoint& pt,
1823 wxHelpEvent::Origin origin) const,
1824 "Get the help string associated with the given position in this window.
1826 Notice that pt may be invalid if event origin is keyboard or unknown
1827 and this method should return the global window help text then
1832 wxString , GetHelpText() const,
1833 "Gets the help text to be used as context-sensitive help for this
1834 window. Note that the text is actually stored by the current
1835 `wx.HelpProvider` implementation, and not in the window object itself.", "");
1844 "Attach a tooltip to the window.", "");
1845 %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
1847 %disownarg( wxToolTip *tip );
1848 void SetToolTip( wxToolTip *tip );
1849 %cleardisown( wxToolTip *tip );
1852 wxToolTip* , GetToolTip() const,
1853 "get the associated tooltip or None if none", "");
1855 // LINK ERROR --> wxString GetToolTipText() const;
1864 %disownarg( wxPyDropTarget *dropTarget );
1866 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1867 "Associates a drop target with this window. If the window already has
1868 a drop target, it is deleted.", "");
1869 %cleardisown( wxPyDropTarget *dropTarget );
1873 virtual wxPyDropTarget *, GetDropTarget() const,
1874 "Returns the associated drop target, which may be None.", "");
1877 DocStr(DragAcceptFiles,
1878 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1879 Only functional on Windows.", "");
1881 void DragAcceptFiles(bool accept);
1884 void DragAcceptFiles(bool accept) {}
1890 // constraints and sizers
1891 // ----------------------
1893 %disownarg(wxLayoutConstraints*);
1895 void , SetConstraints( wxLayoutConstraints *constraints ),
1896 "Sets the window to have the given layout constraints. If an existing
1897 layout constraints object is already owned by the window, it will be
1898 deleted. Pass None to disassociate and delete the window's current
1901 You must call SetAutoLayout to tell a window to use the constraints
1902 automatically in its default EVT_SIZE handler; otherwise, you must
1903 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1904 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1908 wxLayoutConstraints *, GetConstraints() const,
1909 "Returns a pointer to the window's layout constraints, or None if there
1911 %cleardisown(wxLayoutConstraints*);
1915 void , SetAutoLayout( bool autoLayout ),
1916 "Determines whether the Layout function will be called automatically
1917 when the window is resized. lease note that this only happens for the
1918 windows usually used to contain children, namely `wx.Panel` and
1919 `wx.TopLevelWindow` (and the classes deriving from them).
1921 This method is called implicitly by `SetSizer` but if you use
1922 `SetConstraints` you should call it manually or otherwise the window
1923 layout won't be correctly updated when its size changes.", "");
1926 bool , GetAutoLayout() const,
1927 "Returns the current autoLayout setting", "");
1931 virtual bool , Layout(),
1932 "Invokes the constraint-based layout algorithm or the sizer-based
1933 algorithm for this window. See SetAutoLayout: when auto layout is on,
1934 this function gets called automatically by the default EVT_SIZE
1935 handler when the window is resized.", "");
1938 %disownarg( wxSizer *sizer );
1940 void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
1941 "Sets the window to have the given layout sizer. The window will then
1942 own the object, and will take care of its deletion. If an existing
1943 layout sizer object is already owned by the window, it will be deleted
1944 if the deleteOld parameter is true. Note that this function will also
1945 call SetAutoLayout implicitly with a True parameter if the sizer is
1946 non-None, and False otherwise.", "");
1949 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
1950 "The same as SetSizer, except it also sets the size hints for the
1951 window based on the sizer's minimum size.", "");
1952 %cleardisown( wxSizer *sizer );
1956 wxSizer *, GetSizer() const,
1957 "Return the sizer associated with the window by a previous call to
1958 SetSizer or None if there isn't one.", "");
1961 // Track if this window is a member of a sizer
1963 void , SetContainingSizer(wxSizer* sizer),
1964 "This normally does not need to be called by application code. It is
1965 called internally when a window is added to a sizer, and is used so
1966 the window can remove itself from the sizer when it is destroyed.", "");
1969 wxSizer *, GetContainingSizer() const,
1970 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1976 // ----------------------
1977 #if wxUSE_ACCESSIBILITY
1978 // Override to create a specific accessible object.
1979 virtual wxAccessible* CreateAccessible();
1981 // Sets the accessible object.
1982 void SetAccessible(wxAccessible* accessible) ;
1984 // Returns the accessible object.
1985 wxAccessible* GetAccessible() { return m_accessible; };
1987 // Returns the accessible object, creating if necessary.
1988 wxAccessible* GetOrCreateAccessible() ;
1995 virtual void , InheritAttributes(),
1996 "This function is (or should be, in case of custom controls) called
1997 during window creation to intelligently set up the window visual
1998 attributes, that is the font and the foreground and background
2001 By 'intelligently' the following is meant: by default, all windows use
2002 their own default attributes. However if some of the parent's
2003 attributes are explicitly changed (that is, using SetFont and not
2004 SetOwnFont) and if the corresponding attribute hadn't been
2005 explicitly set for this window itself, then this window takes the same
2006 value as used by the parent. In addition, if the window overrides
2007 ShouldInheritColours to return false, the colours will not be changed
2008 no matter what and only the font might.
2010 This rather complicated logic is necessary in order to accommodate the
2011 different usage scenarios. The most common one is when all default
2012 attributes are used and in this case, nothing should be inherited as
2013 in modern GUIs different controls use different fonts (and colours)
2014 than their siblings so they can't inherit the same value from the
2015 parent. However it was also deemed desirable to allow to simply change
2016 the attributes of all children at once by just changing the font or
2017 colour of their common parent, hence in this case we do inherit the
2022 // TODO: Virtualize this with directors
2024 virtual bool , ShouldInheritColours() const,
2025 "Return true from here to allow the colours of this window to be
2026 changed by InheritAttributes, returning false forbids inheriting them
2027 from the parent window.
2029 The base class version returns false, but this method is overridden in
2030 wxControl where it returns true.", "");
2035 virtual bool , CanSetTransparent(),
2036 "Returns ``True`` if the platform supports setting the transparency for
2037 this window. Note that this method will err on the side of caution,
2038 so it is possible that this will return ``False`` when it is in fact
2039 possible to set the transparency.
2041 NOTE: On X-windows systems the X server must have the composite
2042 extension loaded, and there must be a composite manager program (such
2043 as xcompmgr) running.", "");
2046 virtual bool , SetTransparent(byte alpha),
2047 "Attempt to set the transparency of this window to the ``alpha`` value,
2048 returns True on success. The ``alpha`` value is an integer in the
2049 range of 0 to 255, where 0 is fully transparent and 255 is fully
2055 def PostCreate(self, pre):
2057 Phase 3 of the 2-phase create <wink!>
2058 Call this method after precreating the window with the 2-phase create method.
2060 self.this = pre.this
2061 self.thisown = pre.thisown
2063 if hasattr(self, '_setOORInfo'):
2064 self._setOORInfo(self)
2065 if hasattr(self, '_setCallbackInfo'):
2066 self._setCallbackInfo(self, pre.__class__)
2070 def SendSizeEvent(self):
2071 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
2075 %property(AcceleratorTable, GetAcceleratorTable, SetAcceleratorTable, doc="See `GetAcceleratorTable` and `SetAcceleratorTable`");
2076 %property(AdjustedBestSize, GetAdjustedBestSize, doc="See `GetAdjustedBestSize`");
2077 %property(AutoLayout, GetAutoLayout, SetAutoLayout, doc="See `GetAutoLayout` and `SetAutoLayout`");
2078 %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
2079 %property(BackgroundStyle, GetBackgroundStyle, SetBackgroundStyle, doc="See `GetBackgroundStyle` and `SetBackgroundStyle`");
2080 %property(EffectiveMinSize, GetEffectiveMinSize, doc="See `GetEffectiveMinSize`");
2081 %property(BestSize, GetBestSize, doc="See `GetBestSize`");
2082 %property(BestVirtualSize, GetBestVirtualSize, doc="See `GetBestVirtualSize`");
2083 %property(Border, GetBorder, doc="See `GetBorder`");
2084 %property(Caret, GetCaret, SetCaret, doc="See `GetCaret` and `SetCaret`");
2085 %property(CharHeight, GetCharHeight, doc="See `GetCharHeight`");
2086 %property(CharWidth, GetCharWidth, doc="See `GetCharWidth`");
2087 %property(Children, GetChildren, doc="See `GetChildren`");
2088 %property(ClientAreaOrigin, GetClientAreaOrigin, doc="See `GetClientAreaOrigin`");
2089 %property(ClientRect, GetClientRect, SetClientRect, doc="See `GetClientRect` and `SetClientRect`");
2090 %property(ClientSize, GetClientSize, SetClientSize, doc="See `GetClientSize` and `SetClientSize`");
2091 %property(Constraints, GetConstraints, SetConstraints, doc="See `GetConstraints` and `SetConstraints`");
2092 %property(ContainingSizer, GetContainingSizer, SetContainingSizer, doc="See `GetContainingSizer` and `SetContainingSizer`");
2093 %property(Cursor, GetCursor, SetCursor, doc="See `GetCursor` and `SetCursor`");
2094 %property(DefaultAttributes, GetDefaultAttributes, doc="See `GetDefaultAttributes`");
2095 %property(DropTarget, GetDropTarget, SetDropTarget, doc="See `GetDropTarget` and `SetDropTarget`");
2096 %property(EventHandler, GetEventHandler, SetEventHandler, doc="See `GetEventHandler` and `SetEventHandler`");
2097 %property(ExtraStyle, GetExtraStyle, SetExtraStyle, doc="See `GetExtraStyle` and `SetExtraStyle`");
2098 %property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
2099 %property(ForegroundColour, GetForegroundColour, SetForegroundColour, doc="See `GetForegroundColour` and `SetForegroundColour`");
2100 %property(GrandParent, GetGrandParent, doc="See `GetGrandParent`");
2101 %property(Handle, GetHandle, doc="See `GetHandle`");
2102 %property(HelpText, GetHelpText, SetHelpText, doc="See `GetHelpText` and `SetHelpText`");
2103 %property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
2104 %property(Label, GetLabel, SetLabel, doc="See `GetLabel` and `SetLabel`");
2105 %property(LayoutDirection, GetLayoutDirection, SetLayoutDirection, doc="See `GetLayoutDirection` and `SetLayoutDirection`");
2106 %property(MaxHeight, GetMaxHeight, doc="See `GetMaxHeight`");
2107 %property(MaxSize, GetMaxSize, SetMaxSize, doc="See `GetMaxSize` and `SetMaxSize`");
2108 %property(MaxWidth, GetMaxWidth, doc="See `GetMaxWidth`");
2109 %property(MinHeight, GetMinHeight, doc="See `GetMinHeight`");
2110 %property(MinSize, GetMinSize, SetMinSize, doc="See `GetMinSize` and `SetMinSize`");
2111 %property(MinWidth, GetMinWidth, doc="See `GetMinWidth`");
2112 %property(Name, GetName, SetName, doc="See `GetName` and `SetName`");
2113 %property(Parent, GetParent, doc="See `GetParent`");
2114 %property(Position, GetPosition, SetPosition, doc="See `GetPosition` and `SetPosition`");
2115 %property(Rect, GetRect, SetRect, doc="See `GetRect` and `SetRect`");
2116 %property(ScreenPosition, GetScreenPosition, doc="See `GetScreenPosition`");
2117 %property(ScreenRect, GetScreenRect, doc="See `GetScreenRect`");
2118 %property(Size, GetSize, SetSize, doc="See `GetSize` and `SetSize`");
2119 %property(Sizer, GetSizer, SetSizer, doc="See `GetSizer` and `SetSizer`");
2120 %property(ThemeEnabled, GetThemeEnabled, SetThemeEnabled, doc="See `GetThemeEnabled` and `SetThemeEnabled`");
2121 %property(ToolTip, GetToolTip, SetToolTip, doc="See `GetToolTip` and `SetToolTip`");
2122 %property(UpdateClientRect, GetUpdateClientRect, doc="See `GetUpdateClientRect`");
2123 %property(UpdateRegion, GetUpdateRegion, doc="See `GetUpdateRegion`");
2124 %property(Validator, GetValidator, SetValidator, doc="See `GetValidator` and `SetValidator`");
2125 %property(VirtualSize, GetVirtualSize, SetVirtualSize, doc="See `GetVirtualSize` and `SetVirtualSize`");
2126 %property(WindowStyle, GetWindowStyle, SetWindowStyle, doc="See `GetWindowStyle` and `SetWindowStyle`");
2127 %property(WindowStyleFlag, GetWindowStyleFlag, SetWindowStyleFlag, doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`");
2128 %property(WindowVariant, GetWindowVariant, SetWindowVariant, doc="See `GetWindowVariant` and `SetWindowVariant`");
2130 %property(Shown, IsShown, Show, doc="See `IsShown` and `Show`");
2131 %property(Enabled, IsEnabled, Enable, doc="See `IsEnabled` and `Enable`");
2132 %property(TopLevel, IsTopLevel, doc="See `IsTopLevel`");
2142 def DLG_PNT(win, point_or_x, y=None):
2144 Convenience function for converting a Point or (x,y) in
2145 dialog units to pixel units.
2148 return win.ConvertDialogPointToPixels(point_or_x)
2150 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
2152 def DLG_SZE(win, size_width, height=None):
2154 Convenience function for converting a Size or (w,h) in
2155 dialog units to pixel units.
2158 return win.ConvertDialogSizeToPixels(size_width)
2160 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
2166 // Unfortunatly the names of these new static methods clash with the
2167 // names wxPython has been using forever for the overloaded
2168 // wxWindow::FindWindow, so instead of swigging them as statics create
2169 // standalone functions for them.
2172 DocStr(wxFindWindowById,
2173 "Find the first window in the application with the given id. If parent
2174 is None, the search will start from all top-level frames and dialog
2175 boxes; if non-None, the search will be limited to the given window
2176 hierarchy. The search is recursive in both cases.", "");
2178 DocStr(wxFindWindowByName,
2179 "Find a window by its name (as given in a window constructor or Create
2180 function call). If parent is None, the search will start from all
2181 top-level frames and dialog boxes; if non-None, the search will be
2182 limited to the given window hierarchy. The search is recursive in both
2185 If no window with such name is found, wx.FindWindowByLabel is called.", "");
2187 DocStr(wxFindWindowByLabel,
2188 "Find a window by its label. Depending on the type of window, the label
2189 may be a window title or panel item label. If parent is None, the
2190 search will start from all top-level frames and dialog boxes; if
2191 non-None, the search will be limited to the given window
2192 hierarchy. The search is recursive in both cases.", "");
2195 MustHaveApp(wxFindWindowById);
2196 MustHaveApp(wxFindWindowByName);
2197 MustHaveApp(wxFindWindowByLabel);
2200 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
2201 return wxWindow::FindWindowById(id, parent);
2204 wxWindow* wxFindWindowByName( const wxString& name,
2205 const wxWindow *parent = NULL ) {
2206 return wxWindow::FindWindowByName(name, parent);
2209 wxWindow* wxFindWindowByLabel( const wxString& label,
2210 const wxWindow *parent = NULL ) {
2211 return wxWindow::FindWindowByLabel(label, parent);
2219 #include <wx/msw/private.h> // to get wxGetWindowId
2224 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
2226 WXHWND hWnd = (WXHWND)_hWnd;
2227 long id = wxGetWindowId(hWnd);
2228 wxWindow* win = new wxWindow;
2230 parent->AddChild(win);
2231 win->SetEventHandler(win);
2234 win->SubclassWin(hWnd);
2235 win->AdoptAttributesFromHWND();
2236 win->SetupColours();
2239 wxPyRaiseNotImplemented();
2245 //---------------------------------------------------------------------------
2247 DocStr(GetTopLevelWindows,
2248 "Returns a list of the the application's top-level windows, (frames,
2249 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
2250 by wxWidgets, and so it is only valid as long as no top-level windows
2251 are closed or new top-level windows are created.
2254 PyObject* GetTopLevelWindows() {
2255 return wxPy_ConvertList(&wxTopLevelWindows);
2259 //---------------------------------------------------------------------------
2260 //---------------------------------------------------------------------------