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 %pythonAppend Destroy "args[0].thisown = 0"
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", "");
383 void , SetSize( const wxSize& size ),
384 "Sets the size of the window in pixels.", "");
388 void , SetSize( int x, int y, int width, int height,
389 int sizeFlags = wxSIZE_AUTO ),
390 "Sets the position and size of the window in pixels. The sizeFlags
391 parameter indicates the interpretation of the other params if they are
394 ======================== ======================================
395 wx.SIZE_AUTO A -1 indicates that a class-specific
396 default should be used.
397 wx.SIZE_USE_EXISTING Axisting dimensions should be used if
398 -1 values are supplied.
399 wxSIZE_ALLOW_MINUS_ONE Allow dimensions of -1 and less to be
400 interpreted as real dimensions, not
402 ======================== ======================================
408 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
409 "Sets the position and size of the window in pixels using a wx.Rect.", "",
414 void , SetSize( int width, int height ),
415 "Sets the size of the window in pixels.", "",
420 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
421 "Moves the window to the given position.", "");
423 %pythoncode { SetPosition = Move }
427 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
428 "Moves the window to the given position.", "",
432 void , SetBestFittingSize(const wxSize& size=wxDefaultSize),
433 "A 'Smart' SetSize that will fill in default size components with the
434 window's *best size* values. Also set's the minsize for use with sizers.", "");
439 virtual void , Raise(),
440 "Raises the window to the top of the window hierarchy. In current
441 version of wxWidgets this works both for manage and child windows.", "");
444 virtual void , Lower(),
445 "Lowers the window to the bottom of the window hierarchy. In current
446 version of wxWidgets this works both for manage and child windows.", "");
450 // client size is the size of the area available for subwindows
451 DocStr(SetClientSize,
452 "This sets the size of the window client area in pixels. Using this
453 function to size a window tends to be more device-independent than
454 wx.Window.SetSize, since the application need not worry about what
455 dimensions the border or title bar have when trying to fit the window
456 around panel items, for example.", "");
457 void SetClientSize( const wxSize& size );
458 %Rename(SetClientSizeWH, void, SetClientSize( int width, int height ));
459 %Rename(SetClientRect, void, SetClientSize(const wxRect& rect));
462 DocStr(GetPosition, // sets the docstring for both
463 "Get the window's position. Notice that the position is in client
464 coordinates for child windows and screen coordinates for the top level
465 ones, use `GetScreenPosition` if you need screen coordinates for all
466 kinds of windows.", "");
467 wxPoint GetPosition() const;
470 void, GetPosition(int *OUTPUT, int *OUTPUT) const,
471 "GetPositionTuple() -> (x,y)",
475 DocStr(GetScreenPosition, // sets the docstring for both
476 "Get the position of the window in screen coordinantes.", "");
477 wxPoint GetScreenPosition() const;
479 void, GetScreenPosition(int *OUTPUT, int *OUTPUT) const,
480 "GetScreenPositionTuple() -> (x,y)",
481 GetScreenPositionTuple);
484 wxRect , GetScreenRect() const,
485 "Returns the size and position of the window in screen coordinantes as
486 a `wx.Rect` object.", "
487 :see: `GetRect`, `GetScreenPosition`");
490 DocStr(GetSize, "Get the window size.", "");
491 wxSize GetSize() const;
493 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
494 "GetSizeTuple() -> (width, height)",
500 wxRect , GetRect() const,
501 "Returns the size and position of the window as a `wx.Rect` object.", "");
504 DocStr(GetClientSize,
505 "This gets the size of the window's 'client area' in pixels. The client
506 area is the area which may be drawn on by the programmer, excluding
507 title bar, border, scrollbars, etc.", "");
508 wxSize GetClientSize() const;
510 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
511 "GetClientSizeTuple() -> (width, height)",
517 virtual wxPoint , GetClientAreaOrigin() const,
518 "Get the origin of the client area of the window relative to the
519 window's top left corner (the client area may be shifted because of
520 the borders, scrollbars, other decorations...)", "");
524 wxRect , GetClientRect() const,
525 "Get the client area position and size as a `wx.Rect` object.", "");
530 "This function returns the best acceptable minimal size for the
531 window, if applicable. For example, for a static text control, it will
532 be the minimal size such that the control label is not truncated. For
533 windows containing subwindows (suzh aswx.Panel), the size returned by
534 this function will be the same as the size the window would have had
535 after calling Fit.", "");
536 wxSize GetBestSize() const;
538 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
539 "GetBestSizeTuple() -> (width, height)",
544 void , InvalidateBestSize(),
545 "Reset the cached best size value so it will be recalculated the next
546 time it is needed.", "");
549 void , CacheBestSize(const wxSize& size) const,
550 "Cache the best size so it doesn't need to be calculated again, (at least until
551 some properties of the window change.)", "");
555 wxSize , GetBestFittingSize() const,
556 "This function will merge the window's best size into the window's
557 minimum size, giving priority to the min size components, and returns
563 wxSize , GetAdjustedBestSize() const,
564 "This method is similar to GetBestSize, except in one
565 thing. GetBestSize should return the minimum untruncated size of the
566 window, while this method will return the largest of BestSize and any
567 user specified minimum size. ie. it is the minimum size the window
568 should currently be drawn at, not the minimal size it can possibly
575 void , Center( int direction = wxBOTH ),
576 "Centers the window. The parameter specifies the direction for
577 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
578 also include wx.CENTER_ON_SCREEN flag if you want to center the window
579 on the entire screen and not on its parent window. If it is a
580 top-level window and has no parent then it will always be centered
581 relative to the screen.", "");
582 %pythoncode { Centre = Center }
586 void , CenterOnParent(int dir = wxBOTH),
587 "Center with respect to the the parent window", "");
588 %pythoncode { CentreOnParent = CenterOnParent }
593 virtual void , Fit(),
594 "Sizes the window so that it fits around its subwindows. This function
595 won't do anything if there are no subwindows and will only really work
596 correctly if sizers are used for the subwindows layout. Also, if the
597 window has exactly one subwindow it is better (faster and the result
598 is more precise as Fit adds some margin to account for fuzziness of
599 its calculations) to call window.SetClientSize(child.GetSize())
600 instead of calling Fit.", "");
604 virtual void , FitInside(),
605 "Similar to Fit, but sizes the interior (virtual) size of a
606 window. Mainly useful with scrolled windows to reset scrollbars after
607 sizing changes that do not trigger a size event, and/or scrolled
608 windows without an interior sizer. This function similarly won't do
609 anything if there are no subwindows.", "");
614 "Allows specification of minimum and maximum window sizes, and window
615 size increments. If a pair of values is not set (or set to -1), the
616 default values will be used. If this function is called, the user
617 will not be able to size the window outside the given bounds (if it is
618 a top-level window.) Sizers will also inspect the minimum window size
619 and will use that value if set when calculating layout.
621 The resizing increments are only significant under Motif or Xt.", "
623 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
625 virtual void SetSizeHints( int minW, int minH,
626 int maxW = -1, int maxH = -1,
627 int incW = -1, int incH = -1 );
628 %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize,
629 const wxSize& maxSize=wxDefaultSize,
630 const wxSize& incSize=wxDefaultSize));
633 DocStr(SetVirtualSizeHints,
634 "Allows specification of minimum and maximum virtual window sizes. If a
635 pair of values is not set (or set to -1), the default values will be
636 used. If this function is called, the user will not be able to size
637 the virtual area of the window outside the given bounds.", "");
638 virtual void SetVirtualSizeHints( int minW, int minH,
639 int maxW = -1, int maxH = -1 );
640 %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints(
641 const wxSize& minSize, const wxSize& maxSize=wxDefaultSize));
646 virtual wxSize , GetMaxSize() const,
650 virtual wxSize , GetMinSize() const,
654 void , SetMinSize(const wxSize& minSize),
655 "A more convenient method than `SetSizeHints` for setting just the
659 void , SetMaxSize(const wxSize& maxSize),
660 "A more convenient method than `SetSizeHints` for setting just the
666 virtual int , GetMinWidth() const,
670 virtual int , GetMinHeight() const,
674 int , GetMaxWidth() const,
678 int , GetMaxHeight() const,
683 DocStr(SetVirtualSize,
684 "Set the the virtual size of a window in pixels. For most windows this
685 is just the client area of the window, but for some like scrolled
686 windows it is more or less independent of the screen window size.", "");
687 void SetVirtualSize(const wxSize& size );
688 %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h ));
691 DocStr(GetVirtualSize,
692 "Get the the virtual size of the window in pixels. For most windows
693 this is just the client area of the window, but for some like scrolled
694 windows it is more or less independent of the screen window size.", "");
695 wxSize GetVirtualSize() const;
697 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
698 "GetVirtualSizeTuple() -> (width, height)",
699 GetVirtualSizeTuple);
702 // TODO: using directors?
703 // // Override these methods for windows that have a virtual size
704 // // independent of their client size. eg. the virtual area of a
705 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
706 // virtual void DoSetVirtualSize( int x, int y );
707 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
711 virtual wxSize , GetBestVirtualSize() const,
712 "Return the largest of ClientSize and BestSize (as determined by a
713 sizer, interior children, or other means)", "");
721 virtual bool , Show( bool show = true ),
722 "Shows or hides the window. You may need to call Raise for a top level
723 window if you want to bring it to top, although this is not needed if
724 Show is called immediately after the frame creation. Returns True if
725 the window has been shown or hidden or False if nothing was done
726 because it already was in the requested state.", "");
730 "Equivalent to calling Show(False).", "");
734 virtual bool , Enable( bool enable = true ),
735 "Enable or disable the window for user input. Note that when a parent
736 window is disabled, all of its children are disabled as well and they
737 are reenabled again when the parent is. Returns true if the window
738 has been enabled or disabled, false if nothing was done, i.e. if the
739 window had already been in the specified state.", "");
743 "Disables the window, same as Enable(false).", "");
747 bool , IsShown() const,
748 "Returns true if the window is shown, false if it has been hidden.", "");
751 bool , IsEnabled() const,
752 "Returns true if the window is enabled for input, false otherwise.", "");
758 virtual void , SetWindowStyleFlag( long style ),
759 "Sets the style of the window. Please note that some styles cannot be
760 changed after the window creation and that Refresh() might need to be
761 called after changing the others for the change to take place
765 virtual long , GetWindowStyleFlag() const,
766 "Gets the window style that was passed to the constructor or Create
769 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
773 bool , HasFlag(int flag) const,
774 "Test if the given style is set for this window.", "");
778 virtual bool , IsRetained() const,
779 "Returns true if the window is retained, false otherwise. Retained
780 windows are only available on X platforms.", "");
785 virtual void , SetExtraStyle(long exStyle),
786 "Sets the extra style bits for the window. Extra styles are the less
787 often used style bits which can't be set with the constructor or with
788 SetWindowStyleFlag()", "");
791 long , GetExtraStyle() const,
792 "Returns the extra style bits for the window.", "");
797 virtual void , MakeModal(bool modal = true),
798 "Disables all other windows in the application so that the user can
799 only interact with this window. Passing False will reverse this
805 virtual void , SetThemeEnabled(bool enableTheme),
806 "This function tells a window if it should use the system's \"theme\"
807 code to draw the windows' background instead if its own background
808 drawing code. This will only have an effect on platforms that support
809 the notion of themes in user defined windows. One such platform is
810 GTK+ where windows can have (very colourful) backgrounds defined by a
811 user's selected theme.
813 Dialogs, notebook pages and the status bar have this flag set to true
814 by default so that the default look and feel is simulated best.", "");
817 virtual bool , GetThemeEnabled() const,
818 "Return the themeEnabled flag.", "");
821 // TODO with directors
822 // // controls by default inherit the colours of their parents, if a
823 // // particular control class doesn't want to do it, it can override
824 // // ShouldInheritColours() to return False
825 // virtual bool ShouldInheritColours() const;
831 // focus and keyboard handling
832 // ---------------------------
836 virtual void , SetFocus(),
837 "Set's the focus to this window, allowing it to receive keyboard input.", "");
840 virtual void , SetFocusFromKbd(),
841 "Set focus to this window as the result of a keyboard action. Normally
842 only called internally.", "");
847 static wxWindow *, FindFocus(),
848 "Returns the window or control that currently has the keyboard focus,
853 virtual bool , AcceptsFocus() const,
854 "Can this window have focus?", "");
858 virtual bool , AcceptsFocusFromKeyboard() const,
859 "Can this window be given focus by keyboard navigation? if not, the
860 only way to give it focus (provided it accepts it at all) is to click
867 virtual wxWindow *, GetDefaultItem() const,
868 "Get the default child of this parent, i.e. the one which is activated
869 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
872 virtual wxWindow *, SetDefaultItem(wxWindow * child),
873 "Set this child as default, return the old default.", "");
876 virtual void , SetTmpDefaultItem(wxWindow * win),
877 "Set this child as temporary default", "");
881 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
882 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
883 "Does keyboard navigation from this window to another, by sending a
884 `wx.NavigationKeyEvent`.", "
886 :param flags: A combination of the ``IsForward`` or ``IsBackward``
887 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
888 class, which determine if the navigation should be in forward
889 or reverse order, and if it should be able to cross parent
890 window boundaries, such as between notebook pages or MDI child
891 frames. Typically the status of the Shift key (for forward or
892 backward) or the Control key (for WinChange) would be used to
893 determine how to set the flags.
895 One situation in which you may wish to call this method is from a text
896 control custom keypress handler to do the default navigation behaviour
897 for the tab key, since the standard default behaviour for a multiline
898 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
899 not navigate to the next control.");
904 void , MoveAfterInTabOrder(wxWindow *win),
905 "Moves this window in the tab navigation order after the specified
906 sibling window. This means that when the user presses the TAB key on
907 that other window, the focus switches to this window.
909 The default tab order is the same as creation order. This function
910 and `MoveBeforeInTabOrder` allow to change it after creating all the
916 void , MoveBeforeInTabOrder(wxWindow *win),
917 "Same as `MoveAfterInTabOrder` except that it inserts this window just
918 before win instead of putting it right after it.", "");
927 // parent/children relations
928 // -------------------------
931 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
934 "Returns a list of the window's children. NOTE: Currently this is a
935 copy of the child window list maintained by the window, so the return
936 value of this function is only valid as long as the window's children
937 do not change.", "");
938 PyObject* GetChildren() {
939 wxWindowList& list = self->GetChildren();
940 return wxPy_ConvertList(&list);
945 wxWindow *, GetParent() const,
946 "Returns the parent window of this window, or None if there isn't one.", "");
949 wxWindow *, GetGrandParent() const,
950 "Returns the parent of the parent of this window, or None if there
956 virtual bool , IsTopLevel() const,
957 "Returns true if the given window is a top-level one. Currently all
958 frames and dialogs are always considered to be top-level windows (even
959 if they have a parent window).", "");
962 // change the real parent of this window, return True if the parent
963 // was changed, False otherwise (error or newParent == oldParent)
965 virtual bool , Reparent( wxWindow *newParent ),
966 "Reparents the window, i.e the window will be removed from its current
967 parent window (e.g. a non-standard toolbar in a wxFrame) and then
968 re-inserted into another. Available on Windows and GTK. Returns True
969 if the parent was changed, False otherwise (error or newParent ==
974 virtual void , AddChild( wxWindow *child ),
975 "Adds a child window. This is called automatically by window creation
976 functions so should not be required by the application programmer.", "");
979 virtual void , RemoveChild( wxWindow *child ),
980 "Removes a child window. This is called automatically by window
981 deletion functions so should not be required by the application
985 DocStr(SetDoubleBuffered,
986 "Currently wxGTK2 only.", "");
988 void SetDoubleBuffered(bool on);
991 void SetDoubleBuffered(bool on) {}
996 // looking for windows
997 // -------------------
1000 wxWindow *, FindWindow( long winid ),
1001 "Find a chld of this window by window ID", "",
1005 wxWindow *, FindWindow( const wxString& name ),
1006 "Find a child of this window by name", "",
1011 // event handler stuff
1012 // -------------------
1015 wxEvtHandler *, GetEventHandler() const,
1016 "Returns the event handler for this window. By default, the window is
1017 its own event handler.", "");
1021 void , SetEventHandler( wxEvtHandler *handler ),
1022 "Sets the event handler for this window. An event handler is an object
1023 that is capable of processing the events sent to a window. By default,
1024 the window is its own event handler, but an application may wish to
1025 substitute another, for example to allow central implementation of
1026 event-handling for a variety of different window classes.
1028 It is usually better to use `wx.Window.PushEventHandler` since this sets
1029 up a chain of event handlers, where an event not handled by one event
1030 handler is handed to the next one in the chain.", "");
1034 void , PushEventHandler( wxEvtHandler *handler ),
1035 "Pushes this event handler onto the event handler stack for the window.
1036 An event handler is an object that is capable of processing the events
1037 sent to a window. By default, the window is its own event handler, but
1038 an application may wish to substitute another, for example to allow
1039 central implementation of event-handling for a variety of different
1042 wx.Window.PushEventHandler allows an application to set up a chain of
1043 event handlers, where an event not handled by one event handler is
1044 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
1045 remove the event handler.", "");
1049 wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
1050 "Removes and returns the top-most event handler on the event handler
1051 stack. If deleteHandler is True then the wx.EvtHandler object will be
1052 destroyed after it is popped.", "");
1056 bool , RemoveEventHandler(wxEvtHandler *handler),
1057 "Find the given handler in the event handler chain and remove (but not
1058 delete) it from the event handler chain, return True if it was found
1059 and False otherwise (this also results in an assert failure so this
1060 function should only be called when the handler is supposed to be
1069 // a window may have an associated validator which is used to control
1072 virtual void , SetValidator( const wxValidator &validator ),
1073 "Deletes the current validator (if any) and sets the window validator,
1074 having called wx.Validator.Clone to create a new validator of this
1078 virtual wxValidator *, GetValidator(),
1079 "Returns a pointer to the current validator for the window, or None if
1080 there is none.", "");
1084 virtual bool , Validate(),
1085 "Validates the current values of the child controls using their
1086 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1087 style flag set, the method will also call Validate() of all child
1088 windows. Returns false if any of the validations failed.", "");
1092 virtual bool , TransferDataToWindow(),
1093 "Transfers values to child controls from data areas specified by their
1094 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1095 style flag set, the method will also call TransferDataToWindow() of
1096 all child windows.", "");
1099 virtual bool , TransferDataFromWindow(),
1100 "Transfers values from child controls to data areas specified by their
1101 validators. Returns false if a transfer failed. If the window has
1102 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1103 also call TransferDataFromWindow() of all child windows.", "");
1107 virtual void , InitDialog(),
1108 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1109 to the dialog via validators.", "");
1118 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1119 "Sets the accelerator table for this window.", "");
1122 wxAcceleratorTable *, GetAcceleratorTable(),
1123 "Gets the accelerator table for this window.", "");
1129 // hot keys (system wide accelerators)
1130 // -----------------------------------
1132 DocStr(RegisterHotKey,
1133 "Registers a system wide hotkey. Every time the user presses the hotkey
1134 registered here, this window will receive a hotkey event. It will
1135 receive the event even if the application is in the background and
1136 does not have the input focus because the user is working with some
1137 other application. To bind an event handler function to this hotkey
1138 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1139 hotkey was registered successfully.", "");
1140 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1142 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1149 DocStr(UnregisterHotKey,
1150 "Unregisters a system wide hotkey.", "");
1151 bool UnregisterHotKey(int hotkeyId) {
1153 return self->UnregisterHotKey(hotkeyId);
1162 // "dialog units" translations
1163 // ---------------------------
1165 DocStr(ConvertDialogToPixels,
1166 "Converts a point or size from dialog units to pixels. Dialog units
1167 are used for maintaining a dialog's proportions even if the font
1168 changes. For the x dimension, the dialog units are multiplied by the
1169 average character width and then divided by 4. For the y dimension,
1170 the dialog units are multiplied by the average character height and
1171 then divided by 8.", "");
1172 %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1173 %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
1174 %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1175 %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
1178 DocStr(ConvertPixelPointToDialog,
1179 "Converts a point or size from pixels to dialog units. Dialog units
1180 are used for maintaining a dialog's proportions even if the font
1181 changes. For the x dimension, the dialog units are multiplied by the
1182 average character width and then divided by 4. For the y dimension,
1183 the dialog units are multiplied by the average character height and
1184 then divided by 8.", "");
1185 %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
1186 %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
1194 virtual void , WarpPointer(int x, int y),
1195 "Moves the pointer to the given position on the window.
1197 NOTE: This function is not supported under Mac because Apple Human
1198 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1202 void , CaptureMouse(),
1203 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1204 release the capture.
1206 Note that wxWindows maintains the stack of windows having captured the
1207 mouse and when the mouse is released the capture returns to the window
1208 which had had captured it previously and it is only really released if
1209 there were no previous window. In particular, this means that you must
1210 release the mouse as many times as you capture it.", "");
1213 void , ReleaseMouse(),
1214 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1218 static wxWindow *, GetCapture(),
1219 "Returns the window which currently captures the mouse or None", "");
1223 virtual bool , HasCapture() const,
1224 "Returns true if this window has the current mouse capture.", "");
1230 // painting the window
1231 // -------------------
1234 virtual void , Refresh( bool eraseBackground = true,
1235 const wxRect *rect = NULL ),
1236 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1237 will be repainted. Causes an EVT_PAINT event to be generated and sent
1238 to the window.", "");
1242 void , RefreshRect(const wxRect& rect, bool eraseBackground = true),
1243 "Redraws the contents of the given rectangle: the area inside it will
1244 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1248 virtual void , Update(),
1249 "Calling this method immediately repaints the invalidated area of the
1250 window instead of waiting for the EVT_PAINT event to happen, (normally
1251 this would usually only happen when the flow of control returns to the
1252 event loop.) Notice that this function doesn't refresh the window and
1253 does nothing if the window has been already repainted. Use Refresh
1254 first if you want to immediately redraw the window (or some portion of
1255 it) unconditionally.", "");
1259 virtual void , ClearBackground(),
1260 "Clears the window by filling it with the current background
1261 colour. Does not cause an erase background event to be generated.", "");
1266 virtual void , Freeze(),
1267 "Freezes the window or, in other words, prevents any updates from
1268 taking place on screen, the window is not redrawn at all. Thaw must be
1269 called to reenable window redrawing. Calls to Freeze/Thaw may be
1270 nested, with the actual Thaw being delayed until all the nesting has
1273 This method is useful for visual appearance optimization (for example,
1274 it is a good idea to use it before inserting large amount of text into
1275 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1276 for all controls so it is mostly just a hint to wxWindows and not a
1277 mandatory directive.", "");
1281 virtual void , Thaw(),
1282 "Reenables window updating after a previous call to Freeze. Calls to
1283 Freeze/Thaw may be nested, so Thaw must be called the same number of
1284 times that Freeze was before the window will be updated.", "");
1288 virtual void , PrepareDC( wxDC & dc ),
1289 "Call this function to prepare the device context for drawing a
1290 scrolled image. It sets the device origin according to the current
1291 scroll position.", "");
1295 wxRegion& , GetUpdateRegion(),
1296 "Returns the region specifying which parts of the window have been
1297 damaged. Should only be called within an EVT_PAINT handler.", "");
1301 wxRect , GetUpdateClientRect() const,
1302 "Get the update rectangle region bounding box in client coords.", "");
1306 "Returns true if the given point or rectangle area has been exposed
1307 since the last repaint. Call this in an paint event handler to
1308 optimize redrawing by only redrawing those areas, which have been
1310 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1311 %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
1312 %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
1316 // colours, fonts and cursors
1317 // --------------------------
1321 virtual wxVisualAttributes , GetDefaultAttributes() const,
1322 "Get the default attributes for an instance of this class. This is
1323 useful if you want to use the same font or colour in your own control
1324 as in a standard control -- which is a much better idea than hard
1325 coding specific colours or fonts which might look completely out of
1326 place on the user's system, especially if it uses themes.", "");
1330 static wxVisualAttributes ,
1331 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1332 "Get the default attributes for this class. This is useful if you want
1333 to use the same font or colour in your own control as in a standard
1334 control -- which is a much better idea than hard coding specific
1335 colours or fonts which might look completely out of place on the
1336 user's system, especially if it uses themes.
1338 The variant parameter is only relevant under Mac currently and is
1339 ignore under other platforms. Under Mac, it will change the size of
1340 the returned font. See `wx.Window.SetWindowVariant` for more about
1345 virtual bool , SetBackgroundColour( const wxColour &colour ),
1346 "Sets the background colour of the window. Returns True if the colour
1347 was changed. The background colour is usually painted by the default
1348 EVT_ERASE_BACKGROUND event handler function under Windows and
1349 automatically under GTK. Using `wx.NullColour` will reset the window
1350 to the default background colour.
1352 Note that setting the background colour may not cause an immediate
1353 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1354 calling this function.
1356 Using this function will disable attempts to use themes for this
1357 window, if the system supports them. Use with care since usually the
1358 themes represent the appearance chosen by the user to be used for all
1359 applications on the system.", "");
1362 void , SetOwnBackgroundColour(const wxColour& colour),
1368 virtual bool , SetForegroundColour( const wxColour &colour ),
1369 "Sets the foreground colour of the window. Returns True is the colour
1370 was changed. The interpretation of foreground colour is dependent on
1371 the window class; it may be the text colour or other colour, or it may
1372 not be used at all.", "");
1375 void , SetOwnForegroundColour(const wxColour& colour),
1381 wxColour , GetBackgroundColour() const,
1382 "Returns the background colour of the window.", "");
1385 wxColour , GetForegroundColour() const,
1386 "Returns the foreground colour of the window. The interpretation of
1387 foreground colour is dependent on the window class; it may be the text
1388 colour or other colour, or it may not be used at all.", "");
1391 bool , InheritsBackgroundColour() const,
1395 bool , UseBgCol() const,
1400 // // if the window shouldn't inherit its colour from the parent, override
1401 // // this function to return true
1403 // // this is currently only used by wxMSW and wxUniv but should be useful for
1404 // // the other ports too
1405 // virtual bool ProvidesBackground() const;
1408 // Set/get the background style.
1409 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1411 virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
1412 "Returns the background style of the window. The background style
1413 indicates how the background of the window is drawn.
1415 ====================== ========================================
1416 wx.BG_STYLE_SYSTEM The background colour or pattern should
1417 be determined by the system
1418 wx.BG_STYLE_COLOUR The background should be a solid colour
1419 wx.BG_STYLE_CUSTOM The background will be implemented by the
1421 ====================== ========================================
1423 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
1424 a custom background, such as a tiled bitmap. Currently the style has
1425 no effect on other platforms.
1427 :see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
1430 virtual wxBackgroundStyle , GetBackgroundStyle() const,
1431 "Returns the background style of the window.
1433 :see: `SetBackgroundStyle`", "");
1437 bool , HasTransparentBackground(),
1438 "Returns True if this window's background is transparent (as, for
1439 example, for `wx.StaticText`) and should show the parent window's
1442 This method is mostly used internally by the library itself and you
1443 normally shouldn't have to call it. You may, however, have to override
1444 it in your custom control classes to ensure that background is painted
1449 virtual bool , SetCursor( const wxCursor &cursor ),
1450 "Sets the window's cursor. Notice that the window cursor also sets it
1451 for the children of the window implicitly.
1453 The cursor may be wx.NullCursor in which case the window cursor will
1454 be reset back to default.", "");
1457 wxCursor , GetCursor(),
1458 "Return the cursor associated with this window.", "");
1463 virtual bool , SetFont( const wxFont &font ),
1464 "Sets the font for this window.", "");
1467 void , SetOwnFont(const wxFont& font),
1474 "Returns the default font used for this window.", "");
1478 %disownarg( wxCaret *caret );
1480 void , SetCaret(wxCaret *caret),
1481 "Sets the caret associated with the window.", "");
1482 %cleardisown( wxCaret *caret );
1485 wxCaret *, GetCaret() const,
1486 "Returns the caret associated with the window.", "");
1491 virtual int , GetCharHeight() const,
1492 "Get the (average) character size for the current font.", "");
1495 virtual int , GetCharWidth() const,
1496 "Get the (average) character size for the current font.", "");
1501 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1502 "GetTextExtent(String string) -> (width, height)",
1503 "Get the width and height of the text using the current font.", "");
1505 void, GetTextExtent(const wxString& string,
1506 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1507 const wxFont* font = NULL),
1508 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1509 "Get the width, height, decent and leading of the text using the
1510 current or specified font.", "",
1515 // client <-> screen coords
1516 // ------------------------
1518 %apply int * INOUT { int* x, int* y };
1520 // translate to/from screen/client coordinates
1522 void , ClientToScreen( int *x, int *y ) const,
1523 "ClientToScreenXY(int x, int y) -> (x,y)",
1524 "Converts to screen coordinates from coordinates relative to this window.", "",
1528 void , ScreenToClient( int *x, int *y ) const,
1529 "ScreenToClientXY(int x, int y) -> (x,y)",
1530 "Converts from screen to client window coordinates.", "",
1535 wxPoint , ClientToScreen(const wxPoint& pt) const,
1536 "Converts to screen coordinates from coordinates relative to this window.", "");
1539 wxPoint , ScreenToClient(const wxPoint& pt) const,
1540 "Converts from screen to client window coordinates.", "");
1545 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1546 "Test where the given (in client coords) point lies", "",
1550 wxHitTest , HitTest(const wxPoint& pt) const,
1551 "Test where the given (in client coords) point lies", "");
1559 %nokwargs GetBorder;
1561 wxBorder , GetBorder(long flags) const,
1562 "Get the window border style from the given flags: this is different
1563 from simply doing flags & wxBORDER_MASK because it uses
1564 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1569 wxBorder , GetBorder() const,
1570 "Get border for the flags of this window", "");
1576 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1577 "This function sends EVT_UPDATE_UI events to the window. The particular
1578 implementation depends on the window; for example a wx.ToolBar will
1579 send an update UI event for each toolbar button, and a wx.Frame will
1580 send an update UI event for each menubar menu item. You can call this
1581 function from your application to ensure that your UI is up-to-date at
1582 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1583 concerned). This may be necessary if you have called
1584 `wx.UpdateUIEvent.SetMode` or `wx.UpdateUIEvent.SetUpdateInterval` to
1585 limit the overhead that wxWindows incurs by sending update UI events
1588 The flags should be a bitlist of one or more of the following values:
1590 ===================== ==============================
1591 wx.UPDATE_UI_NONE No particular value
1592 wx.UPDATE_UI_RECURSE Call the function for descendants
1593 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1594 ===================== ==============================
1596 If you are calling this function from an OnIdle function, make sure
1597 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1598 to only update the UI elements that need to be updated in idle
1599 time. Some windows update their elements only when necessary, for
1600 example when a menu is about to be shown. The following is an example
1601 of how to call UpdateWindowUI from an idle function::
1603 def OnIdle(self, evt):
1604 if wx.UpdateUIEvent.CanUpdate(self):
1605 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1609 // TODO: using directors?
1610 // // do the window-specific processing after processing the update event
1611 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1615 "Pops up the given menu at the specified coordinates, relative to this window,
1616 and returns control when the user has dismissed the menu. If a menu item is
1617 selected, the corresponding menu event is generated and will be processed as
1618 usual. If the default position is given then the current position of the
1619 mouse cursor will be used.", "");
1620 %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
1621 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1628 "Returns the platform-specific handle (as a long integer) of the
1629 physical window. Currently on wxMac it returns the handle of the
1630 toplevel parent of the window.", "");
1632 return wxPyGetWinHandle(self);
1638 "Associate the window with a new native handle", "");
1640 void AssociateHandle(long handle) {
1641 self->AssociateHandle((WXWidget)handle);
1647 virtual void , DissociateHandle(),
1648 "Dissociate the current native handle from the window", "");
1653 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1654 void OnPaint(wxPaintEvent& event);
1664 bool , HasScrollbar(int orient) const,
1665 "Does the window have the scrollbar for this orientation?", "");
1668 // configure the window scrollbars
1670 virtual void , SetScrollbar( int orientation,
1674 bool refresh = true ),
1675 "Sets the scrollbar properties of a built-in scrollbar.",
1677 :param orientation: Determines the scrollbar whose page size is to
1678 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1680 :param position: The position of the scrollbar in scroll units.
1682 :param thumbSize: The size of the thumb, or visible portion of the
1683 scrollbar, in scroll units.
1685 :param range: The maximum position of the scrollbar.
1687 :param refresh: True to redraw the scrollbar, false otherwise.
1691 virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
1692 "Sets the position of one of the built-in scrollbars.", "");
1695 virtual int , GetScrollPos( int orientation ) const,
1696 "Returns the built-in scrollbar position.", "");
1699 virtual int , GetScrollThumb( int orientation ) const,
1700 "Returns the built-in scrollbar thumb size.", "");
1703 virtual int , GetScrollRange( int orientation ) const,
1704 "Returns the built-in scrollbar range.", "");
1710 virtual void , ScrollWindow( int dx, int dy,
1711 const wxRect* rect = NULL ),
1712 "Physically scrolls the pixels in the window and move child windows
1713 accordingly. Use this function to optimise your scrolling
1714 implementations, to minimise the area that must be redrawn. Note that
1715 it is rarely required to call this function from a user program.","
1717 :param dx: Amount to scroll horizontally.
1719 :param dy: Amount to scroll vertically.
1721 :param rect: Rectangle to invalidate. If this is None, the whole
1722 window is invalidated. If you pass a rectangle corresponding
1723 to the area of the window exposed by the scroll, your
1724 painting handler can optimize painting by checking for the
1725 invalidated region.");
1729 virtual bool , ScrollLines(int lines),
1730 "If the platform and window class supports it, scrolls the window by
1731 the given number of lines down, if lines is positive, or up if lines
1732 is negative. Returns True if the window was scrolled, False if it was
1733 already on top/bottom and nothing was done.", "");
1736 virtual bool , ScrollPages(int pages),
1737 "If the platform and window class supports it, scrolls the window by
1738 the given number of pages down, if pages is positive, or up if pages
1739 is negative. Returns True if the window was scrolled, False if it was
1740 already on top/bottom and nothing was done.", "");
1745 "This is just a wrapper for ScrollLines(-1).", "");
1749 "This is just a wrapper for ScrollLines(1).", "");
1753 "This is just a wrapper for ScrollPages(-1).", "");
1757 "This is just a wrapper for ScrollPages(1).", "");
1762 // context-sensitive help
1763 // ----------------------
1766 void , SetHelpText(const wxString& text),
1767 "Sets the help text to be used as context-sensitive help for this
1768 window. Note that the text is actually stored by the current
1769 `wx.HelpProvider` implementation, and not in the window object itself.", "");
1773 void , SetHelpTextForId(const wxString& text),
1774 "Associate this help text with all windows with the same id as this
1779 virtual wxString , GetHelpTextAtPoint(const wxPoint& pt,
1780 wxHelpEvent::Origin origin) const,
1781 "Get the help string associated with the given position in this window.
1783 Notice that pt may be invalid if event origin is keyboard or unknown
1784 and this method should return the global window help text then
1789 wxString , GetHelpText() const,
1790 "Gets the help text to be used as context-sensitive help for this
1791 window. Note that the text is actually stored by the current
1792 `wx.HelpProvider` implementation, and not in the window object itself.", "");
1801 "Attach a tooltip to the window.", "");
1802 %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
1804 %disownarg( wxToolTip *tip );
1805 void SetToolTip( wxToolTip *tip );
1806 %cleardisown( wxToolTip *tip );
1809 wxToolTip* , GetToolTip() const,
1810 "get the associated tooltip or None if none", "");
1812 // LINK ERROR --> wxString GetToolTipText() const;
1821 %disownarg( wxPyDropTarget *dropTarget );
1823 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1824 "Associates a drop target with this window. If the window already has
1825 a drop target, it is deleted.", "");
1826 %cleardisown( wxPyDropTarget *dropTarget );
1830 virtual wxPyDropTarget *, GetDropTarget() const,
1831 "Returns the associated drop target, which may be None.", "");
1834 DocStr(DragAcceptFiles,
1835 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1836 Only functional on Windows.", "");
1838 void DragAcceptFiles(bool accept);
1841 void DragAcceptFiles(bool accept) {}
1847 // constraints and sizers
1848 // ----------------------
1850 %disownarg(wxLayoutConstraints*);
1852 void , SetConstraints( wxLayoutConstraints *constraints ),
1853 "Sets the window to have the given layout constraints. If an existing
1854 layout constraints object is already owned by the window, it will be
1855 deleted. Pass None to disassociate and delete the window's current
1858 You must call SetAutoLayout to tell a window to use the constraints
1859 automatically in its default EVT_SIZE handler; otherwise, you must
1860 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1861 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1865 wxLayoutConstraints *, GetConstraints() const,
1866 "Returns a pointer to the window's layout constraints, or None if there
1868 %cleardisown(wxLayoutConstraints*);
1872 void , SetAutoLayout( bool autoLayout ),
1873 "Determines whether the Layout function will be called automatically
1874 when the window is resized. lease note that this only happens for the
1875 windows usually used to contain children, namely `wx.Panel` and
1876 `wx.TopLevelWindow` (and the classes deriving from them).
1878 This method is called implicitly by `SetSizer` but if you use
1879 `SetConstraints` you should call it manually or otherwise the window
1880 layout won't be correctly updated when its size changes.", "");
1883 bool , GetAutoLayout() const,
1884 "Returns the current autoLayout setting", "");
1888 virtual bool , Layout(),
1889 "Invokes the constraint-based layout algorithm or the sizer-based
1890 algorithm for this window. See SetAutoLayout: when auto layout is on,
1891 this function gets called automatically by the default EVT_SIZE
1892 handler when the window is resized.", "");
1895 %disownarg( wxSizer *sizer );
1897 void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
1898 "Sets the window to have the given layout sizer. The window will then
1899 own the object, and will take care of its deletion. If an existing
1900 layout sizer object is already owned by the window, it will be deleted
1901 if the deleteOld parameter is true. Note that this function will also
1902 call SetAutoLayout implicitly with a True parameter if the sizer is
1903 non-None, and False otherwise.", "");
1906 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
1907 "The same as SetSizer, except it also sets the size hints for the
1908 window based on the sizer's minimum size.", "");
1909 %cleardisown( wxSizer *sizer );
1913 wxSizer *, GetSizer() const,
1914 "Return the sizer associated with the window by a previous call to
1915 SetSizer or None if there isn't one.", "");
1918 // Track if this window is a member of a sizer
1920 void , SetContainingSizer(wxSizer* sizer),
1921 "This normally does not need to be called by application code. It is
1922 called internally when a window is added to a sizer, and is used so
1923 the window can remove itself from the sizer when it is destroyed.", "");
1926 wxSizer *, GetContainingSizer() const,
1927 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1933 // ----------------------
1934 #if wxUSE_ACCESSIBILITY
1935 // Override to create a specific accessible object.
1936 virtual wxAccessible* CreateAccessible();
1938 // Sets the accessible object.
1939 void SetAccessible(wxAccessible* accessible) ;
1941 // Returns the accessible object.
1942 wxAccessible* GetAccessible() { return m_accessible; };
1944 // Returns the accessible object, creating if necessary.
1945 wxAccessible* GetOrCreateAccessible() ;
1952 virtual void , InheritAttributes(),
1953 "This function is (or should be, in case of custom controls) called
1954 during window creation to intelligently set up the window visual
1955 attributes, that is the font and the foreground and background
1958 By 'intelligently' the following is meant: by default, all windows use
1959 their own default attributes. However if some of the parent's
1960 attributes are explicitly changed (that is, using SetFont and not
1961 SetOwnFont) and if the corresponding attribute hadn't been
1962 explicitly set for this window itself, then this window takes the same
1963 value as used by the parent. In addition, if the window overrides
1964 ShouldInheritColours to return false, the colours will not be changed
1965 no matter what and only the font might.
1967 This rather complicated logic is necessary in order to accommodate the
1968 different usage scenarios. The most common one is when all default
1969 attributes are used and in this case, nothing should be inherited as
1970 in modern GUIs different controls use different fonts (and colours)
1971 than their siblings so they can't inherit the same value from the
1972 parent. However it was also deemed desirable to allow to simply change
1973 the attributes of all children at once by just changing the font or
1974 colour of their common parent, hence in this case we do inherit the
1979 // TODO: Virtualize this with directors
1981 virtual bool , ShouldInheritColours() const,
1982 "Return true from here to allow the colours of this window to be
1983 changed by InheritAttributes, returning false forbids inheriting them
1984 from the parent window.
1986 The base class version returns false, but this method is overridden in
1987 wxControl where it returns true.", "");
1992 def PostCreate(self, pre):
1994 Phase 3 of the 2-phase create <wink!>
1995 Call this method after precreating the window with the 2-phase create method.
1997 self.this = pre.this
1998 self.thisown = pre.thisown
2000 if hasattr(self, '_setOORInfo'):
2001 self._setOORInfo(self)
2002 if hasattr(self, '_setCallbackInfo'):
2003 self._setCallbackInfo(self, self.__class__)
2007 def SendSizeEvent(self):
2008 self.GetEventHandler().ProcessEvent(wx.SizeEvent((-1,-1)))
2020 def DLG_PNT(win, point_or_x, y=None):
2022 Convenience function for converting a Point or (x,y) in
2023 dialog units to pixel units.
2026 return win.ConvertDialogPointToPixels(point_or_x)
2028 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
2030 def DLG_SZE(win, size_width, height=None):
2032 Convenience function for converting a Size or (w,h) in
2033 dialog units to pixel units.
2036 return win.ConvertDialogSizeToPixels(size_width)
2038 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
2044 // Unfortunatly the names of these new static methods clash with the
2045 // names wxPython has been using forever for the overloaded
2046 // wxWindow::FindWindow, so instead of swigging them as statics create
2047 // standalone functions for them.
2050 DocStr(wxFindWindowById,
2051 "Find the first window in the application with the given id. If parent
2052 is None, the search will start from all top-level frames and dialog
2053 boxes; if non-None, the search will be limited to the given window
2054 hierarchy. The search is recursive in both cases.", "");
2056 DocStr(wxFindWindowByName,
2057 "Find a window by its name (as given in a window constructor or Create
2058 function call). If parent is None, the search will start from all
2059 top-level frames and dialog boxes; if non-None, the search will be
2060 limited to the given window hierarchy. The search is recursive in both
2063 If no window with such name is found, wx.FindWindowByLabel is called.", "");
2065 DocStr(wxFindWindowByLabel,
2066 "Find a window by its label. Depending on the type of window, the label
2067 may be a window title or panel item label. If parent is None, the
2068 search will start from all top-level frames and dialog boxes; if
2069 non-None, the search will be limited to the given window
2070 hierarchy. The search is recursive in both cases.", "");
2073 MustHaveApp(wxFindWindowById);
2074 MustHaveApp(wxFindWindowByName);
2075 MustHaveApp(wxFindWindowByLabel);
2078 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
2079 return wxWindow::FindWindowById(id, parent);
2082 wxWindow* wxFindWindowByName( const wxString& name,
2083 const wxWindow *parent = NULL ) {
2084 return wxWindow::FindWindowByName(name, parent);
2087 wxWindow* wxFindWindowByLabel( const wxString& label,
2088 const wxWindow *parent = NULL ) {
2089 return wxWindow::FindWindowByLabel(label, parent);
2097 #include <wx/msw/private.h> // to get wxGetWindowId
2102 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
2104 WXHWND hWnd = (WXHWND)_hWnd;
2105 long id = wxGetWindowId(hWnd);
2106 wxWindow* win = new wxWindow;
2108 parent->AddChild(win);
2109 win->SetEventHandler(win);
2112 win->SubclassWin(hWnd);
2113 win->AdoptAttributesFromHWND();
2114 win->SetupColours();
2117 wxPyRaiseNotImplemented();
2123 //---------------------------------------------------------------------------
2125 DocStr(GetTopLevelWindows,
2126 "Returns a list of the the application's top-level windows, (frames,
2127 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
2128 by wxWidgets, and so it is only valid as long as no top-level windows
2129 are closed or new top-level windows are created.
2132 PyObject* GetTopLevelWindows() {
2133 return wxPy_ConvertList(&wxTopLevelWindows);
2137 //---------------------------------------------------------------------------
2138 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob