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 managed 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 managed 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);
720 virtual wxSize , GetWindowBorderSize() const,
721 "Return the size of the left/right and top/bottom borders.", "");
724 // TODO: using directors?
725 // // Override these methods for windows that have a virtual size
726 // // independent of their client size. eg. the virtual area of a
727 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
728 // virtual void DoSetVirtualSize( int x, int y );
729 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
733 virtual wxSize , GetBestVirtualSize() const,
734 "Return the largest of ClientSize and BestSize (as determined by a
735 sizer, interior children, or other means)", "");
739 // void SetScrollHelper( wxScrollHelper *sh );
740 // wxScrollHelper *GetScrollHelper();
747 virtual bool , Show( bool show = true ),
748 "Shows or hides the window. You may need to call Raise for a top level
749 window if you want to bring it to top, although this is not needed if
750 Show is called immediately after the frame creation. Returns True if
751 the window has been shown or hidden or False if nothing was done
752 because it already was in the requested state.", "");
756 "Equivalent to calling Show(False).", "");
760 virtual bool , Enable( bool enable = true ),
761 "Enable or disable the window for user input. Note that when a parent
762 window is disabled, all of its children are disabled as well and they
763 are reenabled again when the parent is. Returns true if the window
764 has been enabled or disabled, false if nothing was done, i.e. if the
765 window had already been in the specified state.", "");
769 "Disables the window, same as Enable(false).", "");
773 bool , IsShown() const,
774 "Returns true if the window is shown, false if it has been hidden.", "");
777 bool , IsEnabled() const,
778 "Returns true if the window is enabled for input, false otherwise.
779 This method takes into account the enabled state of parent windows up
780 to the top-level window.", "");
783 bool , IsThisEnabled() const,
784 "Returns the internal enabled state independent of the parent(s) state,
785 i.e. the state in which the window would be if all of its parents are
786 enabled. Use `IsEnabled` to get the effective window state.", "");
790 virtual bool , IsShownOnScreen() const,
791 "Returns ``True`` if the window is physically visible on the screen,
792 i.e. it is shown and all its parents up to the toplevel window are
793 shown as well.", "");
799 virtual void , SetWindowStyleFlag( long style ),
800 "Sets the style of the window. Please note that some styles cannot be
801 changed after the window creation and that Refresh() might need to be
802 called after changing the others for the change to take place
806 virtual long , GetWindowStyleFlag() const,
807 "Gets the window style that was passed to the constructor or Create
810 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
814 bool , HasFlag(int flag) const,
815 "Test if the given style is set for this window.", "");
819 virtual bool , IsRetained() const,
820 "Returns true if the window is retained, false otherwise. Retained
821 windows are only available on X platforms.", "");
825 bool , ToggleWindowStyle(int flag),
826 "Turn the flag on if it had been turned off before and vice versa,
827 returns True if the flag is turned on by this function call.", "");
832 virtual void , SetExtraStyle(long exStyle),
833 "Sets the extra style bits for the window. Extra styles are the less
834 often used style bits which can't be set with the constructor or with
835 SetWindowStyleFlag()", "");
838 long , GetExtraStyle() const,
839 "Returns the extra style bits for the window.", "");
844 virtual void , MakeModal(bool modal = true),
845 "Disables all other windows in the application so that the user can
846 only interact with this window. Passing False will reverse this
852 virtual void , SetThemeEnabled(bool enableTheme),
853 "This function tells a window if it should use the system's \"theme\"
854 code to draw the windows' background instead if its own background
855 drawing code. This will only have an effect on platforms that support
856 the notion of themes in user defined windows. One such platform is
857 GTK+ where windows can have (very colourful) backgrounds defined by a
858 user's selected theme.
860 Dialogs, notebook pages and the status bar have this flag set to true
861 by default so that the default look and feel is simulated best.", "");
864 virtual bool , GetThemeEnabled() const,
865 "Return the themeEnabled flag.", "");
868 // TODO with directors
869 // // controls by default inherit the colours of their parents, if a
870 // // particular control class doesn't want to do it, it can override
871 // // ShouldInheritColours() to return False
872 // virtual bool ShouldInheritColours() const;
878 // focus and keyboard handling
879 // ---------------------------
883 virtual void , SetFocus(),
884 "Set's the focus to this window, allowing it to receive keyboard input.", "");
887 virtual void , SetFocusFromKbd(),
888 "Set focus to this window as the result of a keyboard action. Normally
889 only called internally.", "");
894 static wxWindow *, FindFocus(),
895 "Returns the window or control that currently has the keyboard focus,
900 virtual bool , AcceptsFocus() const,
901 "Can this window have focus?", "");
905 bool , CanAcceptFocus() const,
906 "Can this window have focus right now?", "");
911 virtual bool , AcceptsFocusFromKeyboard() const,
912 "Can this window be given focus by keyboard navigation? if not, the
913 only way to give it focus (provided it accepts it at all) is to click
919 bool , CanAcceptFocusFromKeyboard() const,
920 "Can this window be assigned focus from keyboard right now?", "");
925 virtual bool , NavigateIn(int flags = wxNavigationKeyEvent::IsForward),
926 "NavigateIn(self, int flags=NavigationKeyEvent.IsForward) -> bool",
927 "Navigates inside this window.", "");
931 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
932 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
933 "Does keyboard navigation starting from this window to another. This is
934 equivalient to self.GetParent().NavigateIn().", "
936 :param flags: A combination of the ``IsForward`` or ``IsBackward``
937 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
938 class, which determine if the navigation should be in forward
939 or reverse order, and if it should be able to cross parent
940 window boundaries, such as between notebook pages or MDI child
941 frames. Typically the status of the Shift key (for forward or
942 backward) or the Control key (for WinChange) would be used to
943 determine how to set the flags.
945 One situation in which you may wish to call this method is from a text
946 control custom keypress handler to do the default navigation behaviour
947 for the tab key, since the standard default behaviour for a multiline
948 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
949 not navigate to the next control.");
954 void , MoveAfterInTabOrder(wxWindow *win),
955 "Moves this window in the tab navigation order after the specified
956 sibling window. This means that when the user presses the TAB key on
957 that other window, the focus switches to this window.
959 The default tab order is the same as creation order. This function
960 and `MoveBeforeInTabOrder` allow to change it after creating all the
966 void , MoveBeforeInTabOrder(wxWindow *win),
967 "Same as `MoveAfterInTabOrder` except that it inserts this window just
968 before win instead of putting it right after it.", "");
977 // parent/children relations
978 // -------------------------
981 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
984 "Returns a list of the window's children. NOTE: Currently this is a
985 copy of the child window list maintained by the window, so the return
986 value of this function is only valid as long as the window's children
987 do not change.", "");
988 PyObject* GetChildren() {
989 wxWindowList& list = self->GetChildren();
990 return wxPy_ConvertList(&list);
995 wxWindow *, GetParent() const,
996 "Returns the parent window of this window, or None if there isn't one.", "");
999 wxWindow *, GetGrandParent() const,
1000 "Returns the parent of the parent of this window, or None if there
1005 DocDeclStr(wxWindow *, GetTopLevelParent(),
1006 "Returns the first frame or dialog in this window's parental hierarchy.", "")
1008 return wxGetTopLevelParent(self);
1014 virtual bool , IsTopLevel() const,
1015 "Returns true if the given window is a top-level one. Currently all
1016 frames and dialogs are always considered to be top-level windows (even
1017 if they have a parent window).", "");
1020 // change the real parent of this window, return True if the parent
1021 // was changed, False otherwise (error or newParent == oldParent)
1023 virtual bool , Reparent( wxWindow *newParent ),
1024 "Reparents the window, i.e the window will be removed from its current
1025 parent window (e.g. a non-standard toolbar in a wxFrame) and then
1026 re-inserted into another. Available on Windows and GTK. Returns True
1027 if the parent was changed, False otherwise (error or newParent ==
1032 virtual void , AddChild( wxWindow *child ),
1033 "Adds a child window. This is called automatically by window creation
1034 functions so should not be required by the application programmer.", "");
1037 virtual void , RemoveChild( wxWindow *child ),
1038 "Removes a child window. This is called automatically by window
1039 deletion functions so should not be required by the application
1043 DocStr(SetDoubleBuffered,
1044 "Currently wxGTK2 only.", "");
1046 void SetDoubleBuffered(bool on);
1049 void SetDoubleBuffered(bool on) {}
1054 // looking for windows
1055 // -------------------
1058 wxWindow *, FindWindow( long winid ),
1059 "Find a chld of this window by window ID", "",
1063 wxWindow *, FindWindow( const wxString& name ),
1064 "Find a child of this window by name", "",
1069 // event handler stuff
1070 // -------------------
1073 wxEvtHandler *, GetEventHandler() const,
1074 "Returns the event handler for this window. By default, the window is
1075 its own event handler.", "");
1079 void , SetEventHandler( wxEvtHandler *handler ),
1080 "Sets the event handler for this window. An event handler is an object
1081 that is capable of processing the events sent to a window. (In other
1082 words, is able to dispatch the events to handler function.) By
1083 default, the window is its own event handler, but an application may
1084 wish to substitute another, for example to allow central
1085 implementation of event-handling for a variety of different window
1088 It is usually better to use `wx.Window.PushEventHandler` since this sets
1089 up a chain of event handlers, where an event not handled by one event
1090 handler is handed off to the next one in the chain.", "");
1094 void , PushEventHandler( wxEvtHandler *handler ),
1095 "Pushes this event handler onto the event handler stack for the window.
1096 An event handler is an object that is capable of processing the events
1097 sent to a window. (In other words, is able to dispatch the events to
1098 handler function.) By default, the window is its own event handler,
1099 but an application may wish to substitute another, for example to
1100 allow central implementation of event-handling for a variety of
1101 different window classes.
1103 wx.Window.PushEventHandler allows an application to set up a chain of
1104 event handlers, where an event not handled by one event handler is
1105 handed to the next one in the chain. Use `wx.Window.PopEventHandler`
1106 to remove the event handler. Ownership of the handler is *not* given
1107 to the window, so you should be sure to pop the handler before the
1108 window is destroyed and either let PopEventHandler destroy it, or call
1109 its Destroy method yourself.", "");
1113 wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
1114 "Removes and returns the top-most event handler on the event handler
1115 stack. If deleteHandler is True then the wx.EvtHandler object will be
1116 destroyed after it is popped, and ``None`` will be returned instead.", "");
1120 bool , RemoveEventHandler(wxEvtHandler *handler),
1121 "Find the given handler in the event handler chain and remove (but not
1122 delete) it from the event handler chain, returns True if it was found
1123 and False otherwise (this also results in an assert failure so this
1124 function should only be called when the handler is supposed to be
1133 // a window may have an associated validator which is used to control
1136 virtual void , SetValidator( const wxValidator &validator ),
1137 "Deletes the current validator (if any) and sets the window validator,
1138 having called wx.Validator.Clone to create a new validator of this
1142 virtual wxValidator *, GetValidator(),
1143 "Returns a pointer to the current validator for the window, or None if
1144 there is none.", "");
1148 virtual bool , Validate(),
1149 "Validates the current values of the child controls using their
1150 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1151 style flag set, the method will also call Validate() of all child
1152 windows. Returns false if any of the validations failed.", "");
1156 virtual bool , TransferDataToWindow(),
1157 "Transfers values to child controls from data areas specified by their
1158 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1159 style flag set, the method will also call TransferDataToWindow() of
1160 all child windows.", "");
1163 virtual bool , TransferDataFromWindow(),
1164 "Transfers values from child controls to data areas specified by their
1165 validators. Returns false if a transfer failed. If the window has
1166 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1167 also call TransferDataFromWindow() of all child windows.", "");
1171 virtual void , InitDialog(),
1172 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1173 to the dialog via validators.", "");
1182 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1183 "Sets the accelerator table for this window.", "");
1186 wxAcceleratorTable *, GetAcceleratorTable(),
1187 "Gets the accelerator table for this window.", "");
1193 // hot keys (system wide accelerators)
1194 // -----------------------------------
1196 DocStr(RegisterHotKey,
1197 "Registers a system wide hotkey. Every time the user presses the hotkey
1198 registered here, this window will receive a hotkey event. It will
1199 receive the event even if the application is in the background and
1200 does not have the input focus because the user is working with some
1201 other application. To bind an event handler function to this hotkey
1202 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1203 hotkey was registered successfully.", "");
1204 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1206 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1213 DocStr(UnregisterHotKey,
1214 "Unregisters a system wide hotkey.", "");
1215 bool UnregisterHotKey(int hotkeyId) {
1217 return self->UnregisterHotKey(hotkeyId);
1226 // "dialog units" translations
1227 // ---------------------------
1229 DocStr(ConvertDialogToPixels,
1230 "Converts a point or size from dialog units to pixels. Dialog units
1231 are used for maintaining a dialog's proportions even if the font
1232 changes. For the x dimension, the dialog units are multiplied by the
1233 average character width and then divided by 4. For the y dimension,
1234 the dialog units are multiplied by the average character height and
1235 then divided by 8.", "");
1236 %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1237 %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
1238 %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1239 %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
1242 DocStr(ConvertPixelPointToDialog,
1243 "Converts a point or size from pixels to dialog units. Dialog units
1244 are used for maintaining a dialog's proportions even if the font
1245 changes. For the x dimension, the dialog units are multiplied by the
1246 average character width and then divided by 4. For the y dimension,
1247 the dialog units are multiplied by the average character height and
1248 then divided by 8.", "");
1249 %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
1250 %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
1258 virtual void , WarpPointer(int x, int y),
1259 "Moves the pointer to the given position on the window.
1261 NOTE: This function is not supported under Mac because Apple Human
1262 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1266 void , CaptureMouse(),
1267 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1268 release the capture.
1270 Note that wxWindows maintains the stack of windows having captured the
1271 mouse and when the mouse is released the capture returns to the window
1272 which had had captured it previously and it is only really released if
1273 there were no previous window. In particular, this means that you must
1274 release the mouse as many times as you capture it, unless the window
1275 receives the `wx.MouseCaptureLostEvent` event.
1277 Any application which captures the mouse in the beginning of some
1278 operation *must* handle `wx.MouseCaptureLostEvent` and cancel this
1279 operation when it receives the event. The event handler must not
1280 recapture mouse.", "");
1283 void , ReleaseMouse(),
1284 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1288 static wxWindow *, GetCapture(),
1289 "Returns the window which currently captures the mouse or None", "");
1293 virtual bool , HasCapture() const,
1294 "Returns true if this window has the current mouse capture.", "");
1300 // painting the window
1301 // -------------------
1304 virtual void , Refresh( bool eraseBackground = true,
1305 const wxRect *rect = NULL ),
1306 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1307 will be repainted. Causes an EVT_PAINT event to be generated and sent
1308 to the window.", "");
1312 void , RefreshRect(const wxRect& rect, bool eraseBackground = true),
1313 "Redraws the contents of the given rectangle: the area inside it will
1314 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1318 virtual void , Update(),
1319 "Calling this method immediately repaints the invalidated area of the
1320 window instead of waiting for the EVT_PAINT event to happen, (normally
1321 this would usually only happen when the flow of control returns to the
1322 event loop.) Notice that this function doesn't refresh the window and
1323 does nothing if the window has been already repainted. Use `Refresh`
1324 first if you want to immediately redraw the window (or some portion of
1325 it) unconditionally.", "");
1329 virtual void , ClearBackground(),
1330 "Clears the window by filling it with the current background
1331 colour. Does not cause an erase background event to be generated.", "");
1336 virtual void , Freeze(),
1337 "Freezes the window or, in other words, prevents any updates from
1338 taking place on screen, the window is not redrawn at all. Thaw must be
1339 called to reenable window redrawing. Calls to Freeze/Thaw may be
1340 nested, with the actual Thaw being delayed until all the nesting has
1343 This method is useful for visual appearance optimization (for example,
1344 it is a good idea to use it before inserting large amount of text into
1345 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1346 for all controls so it is mostly just a hint to wxWindows and not a
1347 mandatory directive.", "");
1351 virtual bool , IsFrozen() const,
1352 "Returns ``True`` if the window has been frozen and not thawed yet.
1354 :see: `Freeze` and `Thaw`", "");
1359 virtual void , Thaw(),
1360 "Reenables window updating after a previous call to Freeze. Calls to
1361 Freeze/Thaw may be nested, so Thaw must be called the same number of
1362 times that Freeze was before the window will be updated.", "");
1366 virtual void , PrepareDC( wxDC & dc ),
1367 "Call this function to prepare the device context for drawing a
1368 scrolled image. It sets the device origin according to the current
1369 scroll position.", "");
1372 virtual bool , IsDoubleBuffered() const,
1373 "Returns ``True`` if the window contents is double-buffered by the
1374 system, i.e. if any drawing done on the window is really done on a
1375 temporary backing surface and transferred to the screen all at once
1380 wxRegion& , GetUpdateRegion(),
1381 "Returns the region specifying which parts of the window have been
1382 damaged. Should only be called within an EVT_PAINT handler.", "");
1386 wxRect , GetUpdateClientRect() const,
1387 "Get the update rectangle region bounding box in client coords.", "");
1391 "Returns true if the given point or rectangle area has been exposed
1392 since the last repaint. Call this in an paint event handler to
1393 optimize redrawing by only redrawing those areas, which have been
1395 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1396 %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
1397 %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
1401 // colours, fonts and cursors
1402 // --------------------------
1406 virtual wxVisualAttributes , GetDefaultAttributes() const,
1407 "Get the default attributes for an instance of this class. This is
1408 useful if you want to use the same font or colour in your own control
1409 as in a standard control -- which is a much better idea than hard
1410 coding specific colours or fonts which might look completely out of
1411 place on the user's system, especially if it uses themes.", "");
1415 static wxVisualAttributes ,
1416 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1417 "Get the default attributes for this class. This is useful if you want
1418 to use the same font or colour in your own control as in a standard
1419 control -- which is a much better idea than hard coding specific
1420 colours or fonts which might look completely out of place on the
1421 user's system, especially if it uses themes.
1423 The variant parameter is only relevant under Mac currently and is
1424 ignore under other platforms. Under Mac, it will change the size of
1425 the returned font. See `wx.Window.SetWindowVariant` for more about
1430 virtual bool , SetBackgroundColour( const wxColour &colour ),
1431 "Sets the background colour of the window. Returns True if the colour
1432 was changed. The background colour is usually painted by the default
1433 EVT_ERASE_BACKGROUND event handler function under Windows and
1434 automatically under GTK. Using `wx.NullColour` will reset the window
1435 to the default background colour.
1437 Note that setting the background colour may not cause an immediate
1438 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1439 calling this function.
1441 Using this function will disable attempts to use themes for this
1442 window, if the system supports them. Use with care since usually the
1443 themes represent the appearance chosen by the user to be used for all
1444 applications on the system.", "");
1447 void , SetOwnBackgroundColour(const wxColour& colour),
1453 virtual bool , SetForegroundColour( const wxColour &colour ),
1454 "Sets the foreground colour of the window. Returns True is the colour
1455 was changed. The interpretation of foreground colour is dependent on
1456 the window class; it may be the text colour or other colour, or it may
1457 not be used at all.", "");
1460 void , SetOwnForegroundColour(const wxColour& colour),
1466 wxColour , GetBackgroundColour() const,
1467 "Returns the background colour of the window.", "");
1470 wxColour , GetForegroundColour() const,
1471 "Returns the foreground colour of the window. The interpretation of
1472 foreground colour is dependent on the window class; it may be the text
1473 colour or other colour, or it may not be used at all.", "");
1476 bool , InheritsBackgroundColour() const,
1480 bool , UseBgCol() const,
1485 // // if the window shouldn't inherit its colour from the parent, override
1486 // // this function to return true
1488 // // this is currently only used by wxMSW and wxUniv but should be useful for
1489 // // the other ports too
1490 // virtual bool ProvidesBackground() const;
1493 // Set/get the background style.
1494 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1496 virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
1497 "Returns the background style of the window. The background style
1498 indicates how the background of the window is drawn.
1500 ====================== ========================================
1501 wx.BG_STYLE_SYSTEM The background colour or pattern should
1502 be determined by the system
1503 wx.BG_STYLE_COLOUR The background should be a solid colour
1504 wx.BG_STYLE_CUSTOM The background will be implemented by the
1506 ====================== ========================================
1508 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
1509 a custom background, such as a tiled bitmap. Currently the style has
1510 no effect on other platforms.
1512 :see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
1515 virtual wxBackgroundStyle , GetBackgroundStyle() const,
1516 "Returns the background style of the window.
1518 :see: `SetBackgroundStyle`", "");
1522 bool , HasTransparentBackground(),
1523 "Returns True if this window's background is transparent (as, for
1524 example, for `wx.StaticText`) and should show the parent window's
1527 This method is mostly used internally by the library itself and you
1528 normally shouldn't have to call it. You may, however, have to override
1529 it in your custom control classes to ensure that background is painted
1534 virtual bool , SetCursor( const wxCursor &cursor ),
1535 "Sets the window's cursor. Notice that the window cursor also sets it
1536 for the children of the window implicitly.
1538 The cursor may be wx.NullCursor in which case the window cursor will
1539 be reset back to default.", "");
1542 wxCursor , GetCursor(),
1543 "Return the cursor associated with this window.", "");
1548 virtual bool , SetFont( const wxFont &font ),
1549 "Sets the font for this window.", "");
1552 void , SetOwnFont(const wxFont& font),
1559 "Returns the default font used for this window.", "");
1563 %disownarg( wxCaret *caret );
1565 void , SetCaret(wxCaret *caret),
1566 "Sets the caret associated with the window.", "");
1567 %cleardisown( wxCaret *caret );
1570 wxCaret *, GetCaret() const,
1571 "Returns the caret associated with the window.", "");
1576 virtual int , GetCharHeight() const,
1577 "Get the (average) character size for the current font.", "");
1580 virtual int , GetCharWidth() const,
1581 "Get the (average) character size for the current font.", "");
1586 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1587 "GetTextExtent(String string) -> (width, height)",
1588 "Get the width and height of the text using the current font.", "");
1590 void, GetTextExtent(const wxString& string,
1591 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1592 const wxFont* font = NULL),
1593 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1594 "Get the width, height, decent and leading of the text using the
1595 current or specified font.", "",
1600 // client <-> screen coords
1601 // ------------------------
1603 %apply int * INOUT { int* x, int* y };
1605 // translate to/from screen/client coordinates
1607 void , ClientToScreen( int *x, int *y ) const,
1608 "ClientToScreenXY(int x, int y) -> (x,y)",
1609 "Converts to screen coordinates from coordinates relative to this window.", "",
1613 void , ScreenToClient( int *x, int *y ) const,
1614 "ScreenToClientXY(int x, int y) -> (x,y)",
1615 "Converts from screen to client window coordinates.", "",
1620 wxPoint , ClientToScreen(const wxPoint& pt) const,
1621 "Converts to screen coordinates from coordinates relative to this window.", "");
1624 wxPoint , ScreenToClient(const wxPoint& pt) const,
1625 "Converts from screen to client window coordinates.", "");
1630 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1631 "Test where the given (in client coords) point lies", "",
1635 wxHitTest , HitTest(const wxPoint& pt) const,
1636 "Test where the given (in client coords) point lies", "");
1644 %nokwargs GetBorder;
1646 wxBorder , GetBorder(long flags) const,
1647 "Get the window border style from the given flags: this is different
1648 from simply doing flags & wxBORDER_MASK because it uses
1649 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1654 wxBorder , GetBorder() const,
1655 "Get border for the flags of this window", "");
1661 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1662 "This function sends EVT_UPDATE_UI events to the window. The particular
1663 implementation depends on the window; for example a wx.ToolBar will
1664 send an update UI event for each toolbar button, and a wx.Frame will
1665 send an update UI event for each menubar menu item. You can call this
1666 function from your application to ensure that your UI is up-to-date at
1667 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1668 concerned). This may be necessary if you have called
1669 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
1670 limit the overhead that wxWindows incurs by sending update UI events
1673 The flags should be a bitlist of one or more of the following values:
1675 ===================== ==============================
1676 wx.UPDATE_UI_NONE No particular value
1677 wx.UPDATE_UI_RECURSE Call the function for descendants
1678 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1679 ===================== ==============================
1681 If you are calling this function from an OnIdle function, make sure
1682 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1683 to only update the UI elements that need to be updated in idle
1684 time. Some windows update their elements only when necessary, for
1685 example when a menu is about to be shown. The following is an example
1686 of how to call UpdateWindowUI from an idle function::
1688 def OnIdle(self, evt):
1689 if wx.UpdateUIEvent.CanUpdate(self):
1690 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1694 // TODO: using directors?
1695 // // do the window-specific processing after processing the update event
1696 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1700 "Pops up the given menu at the specified coordinates, relative to this window,
1701 and returns control when the user has dismissed the menu. If a menu item is
1702 selected, the corresponding menu event is generated and will be processed as
1703 usual. If the default position is given then the current position of the
1704 mouse cursor will be used.", "");
1705 %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
1706 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1710 virtual bool , HasMultiplePages() const,
1716 "Returns the platform-specific handle (as a long integer) of the
1717 physical window. Currently on wxMac it returns the handle of the
1718 toplevel parent of the window.", "");
1720 return wxPyGetWinHandle(self);
1726 "Associate the window with a new native handle", "");
1728 void AssociateHandle(long handle) {
1729 self->AssociateHandle((WXWidget)handle);
1735 virtual void , DissociateHandle(),
1736 "Dissociate the current native handle from the window", "");
1741 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1742 void OnPaint(wxPaintEvent& event);
1752 bool , HasScrollbar(int orient) const,
1753 "Does the window have the scrollbar for this orientation?", "");
1756 // configure the window scrollbars
1758 virtual void , SetScrollbar( int orientation,
1762 bool refresh = true ),
1763 "Sets the scrollbar properties of a built-in scrollbar.",
1765 :param orientation: Determines the scrollbar whose page size is to
1766 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1768 :param position: The position of the scrollbar in scroll units.
1770 :param thumbSize: The size of the thumb, or visible portion of the
1771 scrollbar, in scroll units.
1773 :param range: The maximum position of the scrollbar.
1775 :param refresh: True to redraw the scrollbar, false otherwise.
1779 virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
1780 "Sets the position of one of the built-in scrollbars.", "");
1783 virtual int , GetScrollPos( int orientation ) const,
1784 "Returns the built-in scrollbar position.", "");
1787 virtual int , GetScrollThumb( int orientation ) const,
1788 "Returns the built-in scrollbar thumb size.", "");
1791 virtual int , GetScrollRange( int orientation ) const,
1792 "Returns the built-in scrollbar range.", "");
1798 virtual void , ScrollWindow( int dx, int dy,
1799 const wxRect* rect = NULL ),
1800 "Physically scrolls the pixels in the window and move child windows
1801 accordingly. Use this function to optimise your scrolling
1802 implementations, to minimise the area that must be redrawn. Note that
1803 it is rarely required to call this function from a user program.","
1805 :param dx: Amount to scroll horizontally.
1807 :param dy: Amount to scroll vertically.
1809 :param rect: Rectangle to invalidate. If this is None, the whole
1810 window is invalidated. If you pass a rectangle corresponding
1811 to the area of the window exposed by the scroll, your
1812 painting handler can optimize painting by checking for the
1813 invalidated region.");
1817 virtual bool , ScrollLines(int lines),
1818 "If the platform and window class supports it, scrolls the window by
1819 the given number of lines down, if lines is positive, or up if lines
1820 is negative. Returns True if the window was scrolled, False if it was
1821 already on top/bottom and nothing was done.", "");
1824 virtual bool , ScrollPages(int pages),
1825 "If the platform and window class supports it, scrolls the window by
1826 the given number of pages down, if pages is positive, or up if pages
1827 is negative. Returns True if the window was scrolled, False if it was
1828 already on top/bottom and nothing was done.", "");
1833 "This is just a wrapper for ScrollLines(-1).", "");
1837 "This is just a wrapper for ScrollLines(1).", "");
1841 "This is just a wrapper for ScrollPages(-1).", "");
1845 "This is just a wrapper for ScrollPages(1).", "");
1850 // context-sensitive help
1851 // ----------------------
1854 void , SetHelpText(const wxString& text),
1855 "Sets the help text to be used as context-sensitive help for this
1856 window. Note that the text is actually stored by the current
1857 `wx.HelpProvider` implementation, and not in the window object itself.", "");
1861 void , SetHelpTextForId(const wxString& text),
1862 "Associate this help text with all windows with the same id as this
1867 virtual wxString , GetHelpTextAtPoint(const wxPoint& pt,
1868 wxHelpEvent::Origin origin) const,
1869 "Get the help string associated with the given position in this window.
1871 Notice that pt may be invalid if event origin is keyboard or unknown
1872 and this method should return the global window help text then
1877 wxString , GetHelpText() const,
1878 "Gets the help text to be used as context-sensitive help for this
1879 window. Note that the text is actually stored by the current
1880 `wx.HelpProvider` implementation, and not in the window object itself.", "");
1889 "Attach a tooltip to the window.", "");
1890 %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
1892 %disownarg( wxToolTip *tip );
1893 void SetToolTip( wxToolTip *tip );
1894 %cleardisown( wxToolTip *tip );
1897 wxToolTip* , GetToolTip() const,
1898 "get the associated tooltip or None if none", "");
1900 // LINK ERROR --> wxString GetToolTipText() const;
1909 %disownarg( wxPyDropTarget *dropTarget );
1911 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1912 "Associates a drop target with this window. If the window already has
1913 a drop target, it is deleted.", "");
1914 %cleardisown( wxPyDropTarget *dropTarget );
1918 virtual wxPyDropTarget *, GetDropTarget() const,
1919 "Returns the associated drop target, which may be None.", "");
1922 DocStr(DragAcceptFiles,
1923 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1924 Only functional on Windows.", "");
1926 void DragAcceptFiles(bool accept);
1929 void DragAcceptFiles(bool accept) {}
1935 // constraints and sizers
1936 // ----------------------
1938 %disownarg(wxLayoutConstraints*);
1940 void , SetConstraints( wxLayoutConstraints *constraints ),
1941 "Sets the window to have the given layout constraints. If an existing
1942 layout constraints object is already owned by the window, it will be
1943 deleted. Pass None to disassociate and delete the window's current
1946 You must call SetAutoLayout to tell a window to use the constraints
1947 automatically in its default EVT_SIZE handler; otherwise, you must
1948 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1949 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1953 wxLayoutConstraints *, GetConstraints() const,
1954 "Returns a pointer to the window's layout constraints, or None if there
1956 %cleardisown(wxLayoutConstraints*);
1960 void , SetAutoLayout( bool autoLayout ),
1961 "Determines whether the Layout function will be called automatically
1962 when the window is resized. lease note that this only happens for the
1963 windows usually used to contain children, namely `wx.Panel` and
1964 `wx.TopLevelWindow` (and the classes deriving from them).
1966 This method is called implicitly by `SetSizer` but if you use
1967 `SetConstraints` you should call it manually or otherwise the window
1968 layout won't be correctly updated when its size changes.", "");
1971 bool , GetAutoLayout() const,
1972 "Returns the current autoLayout setting", "");
1976 virtual bool , Layout(),
1977 "Invokes the constraint-based layout algorithm or the sizer-based
1978 algorithm for this window. See SetAutoLayout: when auto layout is on,
1979 this function gets called automatically by the default EVT_SIZE
1980 handler when the window is resized.", "");
1983 %disownarg( wxSizer *sizer );
1985 void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
1986 "Sets the window to have the given layout sizer. The window will then
1987 own the object, and will take care of its deletion. If an existing
1988 layout sizer object is already owned by the window, it will be deleted
1989 if the deleteOld parameter is true. Note that this function will also
1990 call SetAutoLayout implicitly with a True parameter if the sizer is
1991 non-None, and False otherwise.", "");
1994 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
1995 "The same as SetSizer, except it also sets the size hints for the
1996 window based on the sizer's minimum size.", "");
1997 %cleardisown( wxSizer *sizer );
2001 wxSizer *, GetSizer() const,
2002 "Return the sizer associated with the window by a previous call to
2003 SetSizer or None if there isn't one.", "");
2006 // Track if this window is a member of a sizer
2008 void , SetContainingSizer(wxSizer* sizer),
2009 "This normally does not need to be called by application code. It is
2010 called internally when a window is added to a sizer, and is used so
2011 the window can remove itself from the sizer when it is destroyed.", "");
2014 wxSizer *, GetContainingSizer() const,
2015 "Return the sizer that this window is a member of, if any, otherwise None.", "");
2021 // ----------------------
2022 #if wxUSE_ACCESSIBILITY
2023 // Override to create a specific accessible object.
2024 virtual wxAccessible* CreateAccessible();
2026 // Sets the accessible object.
2027 void SetAccessible(wxAccessible* accessible) ;
2029 // Returns the accessible object.
2030 wxAccessible* GetAccessible() { return m_accessible; };
2032 // Returns the accessible object, creating if necessary.
2033 wxAccessible* GetOrCreateAccessible() ;
2040 virtual void , InheritAttributes(),
2041 "This function is (or should be, in case of custom controls) called
2042 during window creation to intelligently set up the window visual
2043 attributes, that is the font and the foreground and background
2046 By 'intelligently' the following is meant: by default, all windows use
2047 their own default attributes. However if some of the parent's
2048 attributes are explicitly changed (that is, using SetFont and not
2049 SetOwnFont) and if the corresponding attribute hadn't been
2050 explicitly set for this window itself, then this window takes the same
2051 value as used by the parent. In addition, if the window overrides
2052 ShouldInheritColours to return false, the colours will not be changed
2053 no matter what and only the font might.
2055 This rather complicated logic is necessary in order to accommodate the
2056 different usage scenarios. The most common one is when all default
2057 attributes are used and in this case, nothing should be inherited as
2058 in modern GUIs different controls use different fonts (and colours)
2059 than their siblings so they can't inherit the same value from the
2060 parent. However it was also deemed desirable to allow to simply change
2061 the attributes of all children at once by just changing the font or
2062 colour of their common parent, hence in this case we do inherit the
2067 // TODO: Virtualize this with directors
2069 virtual bool , ShouldInheritColours() const,
2070 "Return true from here to allow the colours of this window to be
2071 changed by InheritAttributes, returning false forbids inheriting them
2072 from the parent window.
2074 The base class version returns false, but this method is overridden in
2075 wxControl where it returns true.", "");
2080 virtual bool , CanSetTransparent(),
2081 "Returns ``True`` if the platform supports setting the transparency for
2082 this window. Note that this method will err on the side of caution,
2083 so it is possible that this will return ``False`` when it is in fact
2084 possible to set the transparency.
2086 NOTE: On X-windows systems the X server must have the composite
2087 extension loaded, and there must be a composite manager program (such
2088 as xcompmgr) running.", "");
2091 virtual bool , SetTransparent(byte alpha),
2092 "Attempt to set the transparency of this window to the ``alpha`` value,
2093 returns True on success. The ``alpha`` value is an integer in the
2094 range of 0 to 255, where 0 is fully transparent and 255 is fully
2100 def PostCreate(self, pre):
2102 Phase 3 of the 2-phase create <wink!>
2103 Call this method after precreating the window with the 2-phase create method.
2105 self.this = pre.this
2106 self.thisown = pre.thisown
2108 if hasattr(self, '_setOORInfo'):
2110 self._setOORInfo(self)
2113 if hasattr(self, '_setCallbackInfo'):
2115 self._setCallbackInfo(self, pre.__class__)
2121 def SendSizeEvent(self):
2122 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
2126 %property(AcceleratorTable, GetAcceleratorTable, SetAcceleratorTable, doc="See `GetAcceleratorTable` and `SetAcceleratorTable`");
2127 %property(AutoLayout, GetAutoLayout, SetAutoLayout, doc="See `GetAutoLayout` and `SetAutoLayout`");
2128 %property(BackgroundColour, GetBackgroundColour, SetBackgroundColour, doc="See `GetBackgroundColour` and `SetBackgroundColour`");
2129 %property(BackgroundStyle, GetBackgroundStyle, SetBackgroundStyle, doc="See `GetBackgroundStyle` and `SetBackgroundStyle`");
2130 %property(EffectiveMinSize, GetEffectiveMinSize, doc="See `GetEffectiveMinSize`");
2131 %property(BestSize, GetBestSize, doc="See `GetBestSize`");
2132 %property(BestVirtualSize, GetBestVirtualSize, doc="See `GetBestVirtualSize`");
2133 %property(Border, GetBorder, doc="See `GetBorder`");
2134 %property(Caret, GetCaret, SetCaret, doc="See `GetCaret` and `SetCaret`");
2135 %property(CharHeight, GetCharHeight, doc="See `GetCharHeight`");
2136 %property(CharWidth, GetCharWidth, doc="See `GetCharWidth`");
2137 %property(Children, GetChildren, doc="See `GetChildren`");
2138 %property(ClientAreaOrigin, GetClientAreaOrigin, doc="See `GetClientAreaOrigin`");
2139 %property(ClientRect, GetClientRect, SetClientRect, doc="See `GetClientRect` and `SetClientRect`");
2140 %property(ClientSize, GetClientSize, SetClientSize, doc="See `GetClientSize` and `SetClientSize`");
2141 %property(Constraints, GetConstraints, SetConstraints, doc="See `GetConstraints` and `SetConstraints`");
2142 %property(ContainingSizer, GetContainingSizer, SetContainingSizer, doc="See `GetContainingSizer` and `SetContainingSizer`");
2143 %property(Cursor, GetCursor, SetCursor, doc="See `GetCursor` and `SetCursor`");
2144 %property(DefaultAttributes, GetDefaultAttributes, doc="See `GetDefaultAttributes`");
2145 %property(DropTarget, GetDropTarget, SetDropTarget, doc="See `GetDropTarget` and `SetDropTarget`");
2146 %property(EventHandler, GetEventHandler, SetEventHandler, doc="See `GetEventHandler` and `SetEventHandler`");
2147 %property(ExtraStyle, GetExtraStyle, SetExtraStyle, doc="See `GetExtraStyle` and `SetExtraStyle`");
2148 %property(Font, GetFont, SetFont, doc="See `GetFont` and `SetFont`");
2149 %property(ForegroundColour, GetForegroundColour, SetForegroundColour, doc="See `GetForegroundColour` and `SetForegroundColour`");
2150 %property(GrandParent, GetGrandParent, doc="See `GetGrandParent`");
2151 %property(TopLevelParent, GetTopLevelParent, doc="See `GetTopLevelParent`");
2152 %property(Handle, GetHandle, doc="See `GetHandle`");
2153 %property(HelpText, GetHelpText, SetHelpText, doc="See `GetHelpText` and `SetHelpText`");
2154 %property(Id, GetId, SetId, doc="See `GetId` and `SetId`");
2155 %property(Label, GetLabel, SetLabel, doc="See `GetLabel` and `SetLabel`");
2156 %property(LayoutDirection, GetLayoutDirection, SetLayoutDirection, doc="See `GetLayoutDirection` and `SetLayoutDirection`");
2157 %property(MaxHeight, GetMaxHeight, doc="See `GetMaxHeight`");
2158 %property(MaxSize, GetMaxSize, SetMaxSize, doc="See `GetMaxSize` and `SetMaxSize`");
2159 %property(MaxWidth, GetMaxWidth, doc="See `GetMaxWidth`");
2160 %property(MinHeight, GetMinHeight, doc="See `GetMinHeight`");
2161 %property(MinSize, GetMinSize, SetMinSize, doc="See `GetMinSize` and `SetMinSize`");
2162 %property(MinWidth, GetMinWidth, doc="See `GetMinWidth`");
2163 %property(Name, GetName, SetName, doc="See `GetName` and `SetName`");
2164 %property(Parent, GetParent, doc="See `GetParent`");
2165 %property(Position, GetPosition, SetPosition, doc="See `GetPosition` and `SetPosition`");
2166 %property(Rect, GetRect, SetRect, doc="See `GetRect` and `SetRect`");
2167 %property(ScreenPosition, GetScreenPosition, doc="See `GetScreenPosition`");
2168 %property(ScreenRect, GetScreenRect, doc="See `GetScreenRect`");
2169 %property(Size, GetSize, SetSize, doc="See `GetSize` and `SetSize`");
2170 %property(Sizer, GetSizer, SetSizer, doc="See `GetSizer` and `SetSizer`");
2171 %property(ThemeEnabled, GetThemeEnabled, SetThemeEnabled, doc="See `GetThemeEnabled` and `SetThemeEnabled`");
2172 %property(ToolTip, GetToolTip, SetToolTip, doc="See `GetToolTip` and `SetToolTip`");
2173 %property(UpdateClientRect, GetUpdateClientRect, doc="See `GetUpdateClientRect`");
2174 %property(UpdateRegion, GetUpdateRegion, doc="See `GetUpdateRegion`");
2175 %property(Validator, GetValidator, SetValidator, doc="See `GetValidator` and `SetValidator`");
2176 %property(VirtualSize, GetVirtualSize, SetVirtualSize, doc="See `GetVirtualSize` and `SetVirtualSize`");
2177 %property(WindowStyle, GetWindowStyle, SetWindowStyle, doc="See `GetWindowStyle` and `SetWindowStyle`");
2178 %property(WindowStyleFlag, GetWindowStyleFlag, SetWindowStyleFlag, doc="See `GetWindowStyleFlag` and `SetWindowStyleFlag`");
2179 %property(WindowVariant, GetWindowVariant, SetWindowVariant, doc="See `GetWindowVariant` and `SetWindowVariant`");
2181 %property(Shown, IsShown, Show, doc="See `IsShown` and `Show`");
2182 %property(Enabled, IsEnabled, Enable, doc="See `IsEnabled` and `Enable`");
2183 %property(TopLevel, IsTopLevel, doc="See `IsTopLevel`");
2193 def DLG_PNT(win, point_or_x, y=None):
2195 Convenience function for converting a Point or (x,y) in
2196 dialog units to pixel units.
2199 return win.ConvertDialogPointToPixels(point_or_x)
2201 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
2203 def DLG_SZE(win, size_width, height=None):
2205 Convenience function for converting a Size or (w,h) in
2206 dialog units to pixel units.
2209 return win.ConvertDialogSizeToPixels(size_width)
2211 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
2217 // Unfortunatly the names of these new static methods clash with the
2218 // names wxPython has been using forever for the overloaded
2219 // wxWindow::FindWindow, so instead of swigging them as statics create
2220 // standalone functions for them.
2223 DocStr(wxFindWindowById,
2224 "Find the first window in the application with the given id. If parent
2225 is None, the search will start from all top-level frames and dialog
2226 boxes; if non-None, the search will be limited to the given window
2227 hierarchy. The search is recursive in both cases.", "");
2229 DocStr(wxFindWindowByName,
2230 "Find a window by its name (as given in a window constructor or Create
2231 function call). If parent is None, the search will start from all
2232 top-level frames and dialog boxes; if non-None, the search will be
2233 limited to the given window hierarchy. The search is recursive in both
2236 If no window with such name is found, wx.FindWindowByLabel is called.", "");
2238 DocStr(wxFindWindowByLabel,
2239 "Find a window by its label. Depending on the type of window, the label
2240 may be a window title or panel item label. If parent is None, the
2241 search will start from all top-level frames and dialog boxes; if
2242 non-None, the search will be limited to the given window
2243 hierarchy. The search is recursive in both cases.", "");
2246 MustHaveApp(wxFindWindowById);
2247 MustHaveApp(wxFindWindowByName);
2248 MustHaveApp(wxFindWindowByLabel);
2251 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
2252 return wxWindow::FindWindowById(id, parent);
2255 wxWindow* wxFindWindowByName( const wxString& name,
2256 const wxWindow *parent = NULL ) {
2257 return wxWindow::FindWindowByName(name, parent);
2260 wxWindow* wxFindWindowByLabel( const wxString& label,
2261 const wxWindow *parent = NULL ) {
2262 return wxWindow::FindWindowByLabel(label, parent);
2270 #include <wx/msw/private.h> // to get wxGetWindowId
2274 MustHaveApp(wxWindow_FromHWND);
2277 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
2279 WXHWND hWnd = (WXHWND)_hWnd;
2280 long id = wxGetWindowId(hWnd);
2281 wxWindow* win = new wxWindow;
2283 parent->AddChild(win);
2284 win->SetEventHandler(win);
2287 win->SubclassWin(hWnd);
2288 win->AdoptAttributesFromHWND();
2289 win->SetupColours();
2292 wxPyRaiseNotImplemented();
2298 //---------------------------------------------------------------------------
2300 DocStr(GetTopLevelWindows,
2301 "Returns a list of the the application's top-level windows, (frames,
2302 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
2303 by wxWidgets, and so it is only valid as long as no top-level windows
2304 are closed or new top-level windows are created.
2307 PyObject* GetTopLevelWindows() {
2308 return wxPy_ConvertList(&wxTopLevelWindows);
2312 //---------------------------------------------------------------------------
2313 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob