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 wxUpdateUIEvent::SetMode is
184 wxUPDATE_UI_PROCESS_SPECIFIED.
185 ============================= =====================================
190 MustHaveApp(wxWindow);
191 MustHaveApp(wxWindow::FindFocus);
192 MustHaveApp(wxWindow::GetCapture);
194 // This one is not restricted to wxWindow
195 MustHaveApp(GetClassDefaultAttributes);
197 class wxWindow : public wxEvtHandler
200 %pythonAppend wxWindow "self._setOORInfo(self)"
201 %pythonAppend wxWindow() ""
202 %typemap(out) wxWindow*; // turn off this typemap
205 wxWindow(wxWindow* parent, const wxWindowID id=-1,
206 const wxPoint& pos = wxDefaultPosition,
207 const wxSize& size = wxDefaultSize,
209 const wxString& name = wxPyPanelNameStr),
210 "Construct and show a generic Window.", "");
214 "Precreate a Window for 2-phase creation.", "",
217 // Turn it back on again
218 %typemap(out) wxWindow* { $result = wxPyMake_wxObject($1, $owner); }
222 bool , Create(wxWindow* parent, const wxWindowID id=-1,
223 const wxPoint& pos = wxDefaultPosition,
224 const wxSize& size = wxDefaultSize,
226 const wxString& name = wxPyPanelNameStr),
227 "Create the GUI part of the Window for 2-phase creation mode.", "");
230 // deleting the window
231 // -------------------
235 bool , Close( bool force = false ),
236 "This function simply generates a EVT_CLOSE event whose handler usually
237 tries to close the window. It doesn't close the window itself,
238 however. If force is False (the default) then the window's close
239 handler will be allowed to veto the destruction of the window.",
241 Usually Close is only used with the top level windows (wx.Frame and
242 wx.Dialog classes) as the others are not supposed to have any special
245 The close handler should check whether the window is being deleted
246 forcibly, using wx.CloseEvent.GetForce, in which case it should
247 destroy the window using wx.Window.Destroy.
249 Note that calling Close does not guarantee that the window will be
250 destroyed; but it provides a way to simulate a manual close of a
251 window, which may or may not be implemented by destroying the
252 window. The default EVT_CLOSE handler for wx.Dialog does not
253 necessarily delete the dialog, since it will simply simulate an
254 wxID_CANCEL event which is handled by the appropriate button event
255 handler and may do anything at all.
257 To guarantee that the window will be destroyed, call wx.Window.Destroy
263 virtual bool , Destroy(),
264 "Destroys the window safely. Frames and dialogs are not destroyed
265 immediately when this function is called -- they are added to a list
266 of windows to be deleted on idle time, when all the window's events
267 have been processed. This prevents problems with events being sent to
268 non-existent windows.
270 Returns True if the window has either been successfully deleted, or it
271 has been added to the list of windows pending real deletion.", "");
275 bool , DestroyChildren(),
276 "Destroys all children of a window. Called automatically by the
281 bool , IsBeingDeleted() const,
282 "Is the window in the process of being deleted?", "");
290 virtual void , SetTitle( const wxString& title),
291 "Sets the window's title. Applicable only to frames and dialogs.", "");
294 virtual wxString , GetTitle() const,
295 "Gets the window's title. Applicable only to frames and dialogs.", "");
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 if it is a
441 managed window (dialog or frame).", "");
444 virtual void , Lower(),
445 "Lowers the window to the bottom of the window hierarchy if it is a
446 managed window (dialog or frame).", "");
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.", "");
464 wxPoint GetPosition();
467 void, GetPosition(int *OUTPUT, int *OUTPUT),
468 "GetPositionTuple() -> (x,y)",
472 DocStr(GetSize, "Get the window size.", "");
473 wxSize GetSize() const;
475 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
476 "GetSizeTuple() -> (width, height)",
482 wxRect , GetRect() const,
483 "Returns the size and position of the window as a wx.Rect object.", "");
486 DocStr(GetClientSize,
487 "This gets the size of the window's 'client area' in pixels. The client
488 area is the area which may be drawn on by the programmer, excluding
489 title bar, border, scrollbars, etc.", "");
490 wxSize GetClientSize() const;
492 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
493 "GetClientSizeTuple() -> (width, height)",
499 virtual wxPoint , GetClientAreaOrigin() const,
500 "Get the origin of the client area of the window relative to the
501 window's top left corner (the client area may be shifted because of
502 the borders, scrollbars, other decorations...)", "");
506 wxRect , GetClientRect() const,
507 "Get the client area position and size as a `wx.Rect` object.", "");
512 "This function returns the best acceptable minimal size for the
513 window, if applicable. For example, for a static text control, it will
514 be the minimal size such that the control label is not truncated. For
515 windows containing subwindows (suzh aswx.Panel), the size returned by
516 this function will be the same as the size the window would have had
517 after calling Fit.", "");
518 wxSize GetBestSize() const;
520 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
521 "GetBestSizeTuple() -> (width, height)",
526 void , InvalidateBestSize(),
527 "Reset the cached best size value so it will be recalculated the next
528 time it is needed.", "");
533 wxSize , GetBestFittingSize() const,
534 "This function will merge the window's best size into the window's
535 minimum size, giving priority to the min size components, and returns
541 wxSize , GetAdjustedBestSize() const,
542 "This method is similar to GetBestSize, except in one
543 thing. GetBestSize should return the minimum untruncated size of the
544 window, while this method will return the largest of BestSize and any
545 user specified minimum size. ie. it is the minimum size the window
546 should currently be drawn at, not the minimal size it can possibly
553 void , Center( int direction = wxBOTH ),
554 "Centers the window. The parameter specifies the direction for
555 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
556 also include wx.CENTER_ON_SCREEN flag if you want to center the window
557 on the entire screen and not on its parent window. If it is a
558 top-level window and has no parent then it will always be centered
559 relative to the screen.", "");
561 %pythoncode { Centre = Center }
565 void , CenterOnScreen(int dir = wxBOTH),
566 "Center on screen (only works for top level windows)", "");
567 %pythoncode { CentreOnScreen = CenterOnScreen }
571 void , CenterOnParent(int dir = wxBOTH),
572 "Center with respect to the the parent window", "");
573 %pythoncode { CentreOnParent = CenterOnParent }
578 virtual void , Fit(),
579 "Sizes the window so that it fits around its subwindows. This function
580 won't do anything if there are no subwindows and will only really work
581 correctly if sizers are used for the subwindows layout. Also, if the
582 window has exactly one subwindow it is better (faster and the result
583 is more precise as Fit adds some margin to account for fuzziness of
584 its calculations) to call window.SetClientSize(child.GetSize())
585 instead of calling Fit.", "");
589 virtual void , FitInside(),
590 "Similar to Fit, but sizes the interior (virtual) size of a
591 window. Mainly useful with scrolled windows to reset scrollbars after
592 sizing changes that do not trigger a size event, and/or scrolled
593 windows without an interior sizer. This function similarly won't do
594 anything if there are no subwindows.", "");
599 "Allows specification of minimum and maximum window sizes, and window
600 size increments. If a pair of values is not set (or set to -1), the
601 default values will be used. If this function is called, the user
602 will not be able to size the window outside the given bounds (if it is
603 a top-level window.) Sizers will also inspect the minimum window size
604 and will use that value if set when calculating layout.
606 The resizing increments are only significant under Motif or Xt.", "
608 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
610 virtual void SetSizeHints( int minW, int minH,
611 int maxW = -1, int maxH = -1,
612 int incW = -1, int incH = -1 );
613 %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize,
614 const wxSize& maxSize=wxDefaultSize,
615 const wxSize& incSize=wxDefaultSize));
618 DocStr(SetVirtualSizeHints,
619 "Allows specification of minimum and maximum virtual window sizes. If a
620 pair of values is not set (or set to -1), the default values will be
621 used. If this function is called, the user will not be able to size
622 the virtual area of the window outside the given bounds.", "");
623 virtual void SetVirtualSizeHints( int minW, int minH,
624 int maxW = -1, int maxH = -1 );
625 %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints(
626 const wxSize& minSize, const wxSize& maxSize=wxDefaultSize));
631 virtual wxSize , GetMaxSize() const,
635 virtual wxSize , GetMinSize() const,
639 void , SetMinSize(const wxSize& minSize),
640 "A more convenient method than `SetSizeHints` for setting just the
644 void , SetMaxSize(const wxSize& maxSize),
645 "A more convenient method than `SetSizeHints` for setting just the
651 virtual int , GetMinWidth() const,
655 virtual int , GetMinHeight() const,
659 int , GetMaxWidth() const,
663 int , GetMaxHeight() const,
668 DocStr(SetVirtualSize,
669 "Set the the virtual size of a window in pixels. For most windows this
670 is just the client area of the window, but for some like scrolled
671 windows it is more or less independent of the screen window size.", "");
672 void SetVirtualSize(const wxSize& size );
673 %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h ));
676 DocStr(GetVirtualSize,
677 "Get the the virtual size of the window in pixels. For most windows
678 this is just the client area of the window, but for some like scrolled
679 windows it is more or less independent of the screen window size.", "");
680 wxSize GetVirtualSize() const;
682 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
683 "GetVirtualSizeTuple() -> (width, height)",
684 GetVirtualSizeTuple);
687 // TODO: using directors?
688 // // Override these methods for windows that have a virtual size
689 // // independent of their client size. eg. the virtual area of a
690 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
691 // virtual void DoSetVirtualSize( int x, int y );
692 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
696 virtual wxSize , GetBestVirtualSize() const,
697 "Return the largest of ClientSize and BestSize (as determined by a
698 sizer, interior children, or other means)", "");
706 virtual bool , Show( bool show = true ),
707 "Shows or hides the window. You may need to call Raise for a top level
708 window if you want to bring it to top, although this is not needed if
709 Show is called immediately after the frame creation. Returns True if
710 the window has been shown or hidden or False if nothing was done
711 because it already was in the requested state.", "");
715 "Equivalent to calling Show(False).", "");
719 virtual bool , Enable( bool enable = true ),
720 "Enable or disable the window for user input. Note that when a parent
721 window is disabled, all of its children are disabled as well and they
722 are reenabled again when the parent is. Returns true if the window
723 has been enabled or disabled, false if nothing was done, i.e. if the
724 window had already been in the specified state.", "");
728 "Disables the window, same as Enable(false).", "");
732 bool , IsShown() const,
733 "Returns true if the window is shown, false if it has been hidden.", "");
736 bool , IsEnabled() const,
737 "Returns true if the window is enabled for input, false otherwise.", "");
743 virtual void , SetWindowStyleFlag( long style ),
744 "Sets the style of the window. Please note that some styles cannot be
745 changed after the window creation and that Refresh() might need to be
746 called after changing the others for the change to take place
750 virtual long , GetWindowStyleFlag() const,
751 "Gets the window style that was passed to the constructor or Create
754 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
758 bool , HasFlag(int flag) const,
759 "Test if the given style is set for this window.", "");
763 virtual bool , IsRetained() const,
764 "Returns true if the window is retained, false otherwise. Retained
765 windows are only available on X platforms.", "");
770 virtual void , SetExtraStyle(long exStyle),
771 "Sets the extra style bits for the window. Extra styles are the less
772 often used style bits which can't be set with the constructor or with
773 SetWindowStyleFlag()", "");
776 long , GetExtraStyle() const,
777 "Returns the extra style bits for the window.", "");
782 virtual void , MakeModal(bool modal = true),
783 "Disables all other windows in the application so that the user can
784 only interact with this window. Passing False will reverse this
790 virtual void , SetThemeEnabled(bool enableTheme),
791 "This function tells a window if it should use the system's \"theme\"
792 code to draw the windows' background instead if its own background
793 drawing code. This will only have an effect on platforms that support
794 the notion of themes in user defined windows. One such platform is
795 GTK+ where windows can have (very colourful) backgrounds defined by a
796 user's selected theme.
798 Dialogs, notebook pages and the status bar have this flag set to true
799 by default so that the default look and feel is simulated best.", "");
802 virtual bool , GetThemeEnabled() const,
803 "Return the themeEnabled flag.", "");
806 // TODO with directors
807 // // controls by default inherit the colours of their parents, if a
808 // // particular control class doesn't want to do it, it can override
809 // // ShouldInheritColours() to return False
810 // virtual bool ShouldInheritColours() const;
816 // focus and keyboard handling
817 // ---------------------------
821 virtual void , SetFocus(),
822 "Set's the focus to this window, allowing it to receive keyboard input.", "");
825 virtual void , SetFocusFromKbd(),
826 "Set focus to this window as the result of a keyboard action. Normally
827 only called internally.", "");
832 static wxWindow *, FindFocus(),
833 "Returns the window or control that currently has the keyboard focus,
838 virtual bool , AcceptsFocus() const,
839 "Can this window have focus?", "");
843 virtual bool , AcceptsFocusFromKeyboard() const,
844 "Can this window be given focus by keyboard navigation? if not, the
845 only way to give it focus (provided it accepts it at all) is to click
852 virtual wxWindow *, GetDefaultItem() const,
853 "Get the default child of this parent, i.e. the one which is activated
854 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
857 virtual wxWindow *, SetDefaultItem(wxWindow * child),
858 "Set this child as default, return the old default.", "");
861 virtual void , SetTmpDefaultItem(wxWindow * win),
862 "Set this child as temporary default", "");
866 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
867 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
868 "Does keyboard navigation from this window to another, by sending a
869 `wx.NavigationKeyEvent`.", "
871 :param flags: A combination of the ``IsForward`` or ``IsBackward``
872 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
873 class, which determine if the navigation should be in forward
874 or reverse order, and if it should be able to cross parent
875 window boundaries, such as between notebook pages or MDI child
876 frames. Typically the status of the Shift key (for forward or
877 backward) or the Control key (for WinChange) would be used to
878 determine how to set the flags.
880 One situation in which you may wish to call this method is from a text
881 control custom keypress handler to do the default navigation behaviour
882 for the tab key, since the standard default behaviour for a multiline
883 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
884 not navigate to the next control.");
889 void , MoveAfterInTabOrder(wxWindow *win),
890 "Moves this window in the tab navigation order after the specified
891 sibling window. This means that when the user presses the TAB key on
892 that other window, the focus switches to this window.
894 The default tab order is the same as creation order. This function
895 and `MoveBeforeInTabOrder` allow to change it after creating all the
901 void , MoveBeforeInTabOrder(wxWindow *win),
902 "Same as `MoveAfterInTabOrder` except that it inserts this window just
903 before win instead of putting it right after it.", "");
912 // parent/children relations
913 // -------------------------
916 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
919 "Returns a list of the window's children. NOTE: Currently this is a
920 copy of the child window list maintained by the window, so the return
921 value of this function is only valid as long as the window's children
922 do not change.", "");
923 PyObject* GetChildren() {
924 wxWindowList& list = self->GetChildren();
925 return wxPy_ConvertList(&list);
930 wxWindow *, GetParent() const,
931 "Returns the parent window of this window, or None if there isn't one.", "");
934 wxWindow *, GetGrandParent() const,
935 "Returns the parent of the parent of this window, or None if there
941 virtual bool , IsTopLevel() const,
942 "Returns true if the given window is a top-level one. Currently all
943 frames and dialogs are always considered to be top-level windows (even
944 if they have a parent window).", "");
947 // change the real parent of this window, return True if the parent
948 // was changed, False otherwise (error or newParent == oldParent)
950 virtual bool , Reparent( wxWindow *newParent ),
951 "Reparents the window, i.e the window will be removed from its current
952 parent window (e.g. a non-standard toolbar in a wxFrame) and then
953 re-inserted into another. Available on Windows and GTK. Returns True
954 if the parent was changed, False otherwise (error or newParent ==
959 virtual void , AddChild( wxWindow *child ),
960 "Adds a child window. This is called automatically by window creation
961 functions so should not be required by the application programmer.", "");
964 virtual void , RemoveChild( wxWindow *child ),
965 "Removes a child window. This is called automatically by window
966 deletion functions so should not be required by the application
972 // looking for windows
973 // -------------------
976 wxWindow *, FindWindow( long winid ),
977 "Find a chld of this window by window ID", "",
981 wxWindow *, FindWindow( const wxString& name ),
982 "Find a child of this window by name", "",
987 // event handler stuff
988 // -------------------
991 wxEvtHandler *, GetEventHandler() const,
992 "Returns the event handler for this window. By default, the window is
993 its own event handler.", "");
997 void , SetEventHandler( wxEvtHandler *handler ),
998 "Sets the event handler for this window. An event handler is an object
999 that is capable of processing the events sent to a window. By default,
1000 the window is its own event handler, but an application may wish to
1001 substitute another, for example to allow central implementation of
1002 event-handling for a variety of different window classes.
1004 It is usually better to use `wx.Window.PushEventHandler` since this sets
1005 up a chain of event handlers, where an event not handled by one event
1006 handler is handed to the next one in the chain.", "");
1010 void , PushEventHandler( wxEvtHandler *handler ),
1011 "Pushes this event handler onto the event handler stack for the window.
1012 An event handler is an object that is capable of processing the events
1013 sent to a window. By default, the window is its own event handler, but
1014 an application may wish to substitute another, for example to allow
1015 central implementation of event-handling for a variety of different
1018 wx.Window.PushEventHandler allows an application to set up a chain of
1019 event handlers, where an event not handled by one event handler is
1020 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
1021 remove the event handler.", "");
1025 wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
1026 "Removes and returns the top-most event handler on the event handler
1027 stack. If deleteHandler is True then the wx.EvtHandler object will be
1028 destroyed after it is popped.", "");
1032 bool , RemoveEventHandler(wxEvtHandler *handler),
1033 "Find the given handler in the event handler chain and remove (but not
1034 delete) it from the event handler chain, return True if it was found
1035 and False otherwise (this also results in an assert failure so this
1036 function should only be called when the handler is supposed to be
1045 // a window may have an associated validator which is used to control
1048 virtual void , SetValidator( const wxValidator &validator ),
1049 "Deletes the current validator (if any) and sets the window validator,
1050 having called wx.Validator.Clone to create a new validator of this
1054 virtual wxValidator *, GetValidator(),
1055 "Returns a pointer to the current validator for the window, or None if
1056 there is none.", "");
1060 virtual bool , Validate(),
1061 "Validates the current values of the child controls using their
1062 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1063 style flag set, the method will also call Validate() of all child
1064 windows. Returns false if any of the validations failed.", "");
1068 virtual bool , TransferDataToWindow(),
1069 "Transfers values to child controls from data areas specified by their
1070 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1071 style flag set, the method will also call TransferDataToWindow() of
1072 all child windows.", "");
1075 virtual bool , TransferDataFromWindow(),
1076 "Transfers values from child controls to data areas specified by their
1077 validators. Returns false if a transfer failed. If the window has
1078 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1079 also call TransferDataFromWindow() of all child windows.", "");
1083 virtual void , InitDialog(),
1084 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1085 to the dialog via validators.", "");
1094 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1095 "Sets the accelerator table for this window.", "");
1098 wxAcceleratorTable *, GetAcceleratorTable(),
1099 "Gets the accelerator table for this window.", "");
1105 // hot keys (system wide accelerators)
1106 // -----------------------------------
1108 DocStr(RegisterHotKey,
1109 "Registers a system wide hotkey. Every time the user presses the hotkey
1110 registered here, this window will receive a hotkey event. It will
1111 receive the event even if the application is in the background and
1112 does not have the input focus because the user is working with some
1113 other application. To bind an event handler function to this hotkey
1114 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1115 hotkey was registered successfully.", "");
1116 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1118 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1125 DocStr(UnregisterHotKey,
1126 "Unregisters a system wide hotkey.", "");
1127 bool UnregisterHotKey(int hotkeyId) {
1129 return self->UnregisterHotKey(hotkeyId);
1138 // "dialog units" translations
1139 // ---------------------------
1141 DocStr(ConvertDialogToPixels,
1142 "Converts a point or size from dialog units to pixels. Dialog units
1143 are used for maintaining a dialog's proportions even if the font
1144 changes. For the x dimension, the dialog units are multiplied by the
1145 average character width and then divided by 4. For the y dimension,
1146 the dialog units are multiplied by the average character height and
1147 then divided by 8.", "");
1148 %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1149 %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
1150 %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1151 %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
1154 DocStr(ConvertPixelPointToDialog,
1155 "Converts a point or size from pixels to dialog units. Dialog units
1156 are used for maintaining a dialog's proportions even if the font
1157 changes. For the x dimension, the dialog units are multiplied by the
1158 average character width and then divided by 4. For the y dimension,
1159 the dialog units are multiplied by the average character height and
1160 then divided by 8.", "");
1161 %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
1162 %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
1170 virtual void , WarpPointer(int x, int y),
1171 "Moves the pointer to the given position on the window.
1173 NOTE: This function is not supported under Mac because Apple Human
1174 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1178 void , CaptureMouse(),
1179 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1180 release the capture.
1182 Note that wxWindows maintains the stack of windows having captured the
1183 mouse and when the mouse is released the capture returns to the window
1184 which had had captured it previously and it is only really released if
1185 there were no previous window. In particular, this means that you must
1186 release the mouse as many times as you capture it.", "");
1189 void , ReleaseMouse(),
1190 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1194 static wxWindow *, GetCapture(),
1195 "Returns the window which currently captures the mouse or None", "");
1199 virtual bool , HasCapture() const,
1200 "Returns true if this window has the current mouse capture.", "");
1206 // painting the window
1207 // -------------------
1210 virtual void , Refresh( bool eraseBackground = true,
1211 const wxRect *rect = NULL ),
1212 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1213 will be repainted. Causes an EVT_PAINT event to be generated and sent
1214 to the window.", "");
1218 void , RefreshRect(const wxRect& rect, bool eraseBackground = true),
1219 "Redraws the contents of the given rectangle: the area inside it will
1220 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1224 virtual void , Update(),
1225 "Calling this method immediately repaints the invalidated area of the
1226 window instead of waiting for the EVT_PAINT event to happen, (normally
1227 this would usually only happen when the flow of control returns to the
1228 event loop.) Notice that this function doesn't refresh the window and
1229 does nothing if the window has been already repainted. Use Refresh
1230 first if you want to immediately redraw the window (or some portion of
1231 it) unconditionally.", "");
1235 virtual void , ClearBackground(),
1236 "Clears the window by filling it with the current background
1237 colour. Does not cause an erase background event to be generated.", "");
1242 virtual void , Freeze(),
1243 "Freezes the window or, in other words, prevents any updates from
1244 taking place on screen, the window is not redrawn at all. Thaw must be
1245 called to reenable window redrawing. Calls to Freeze/Thaw may be
1246 nested, with the actual Thaw being delayed until all the nesting has
1249 This method is useful for visual appearance optimization (for example,
1250 it is a good idea to use it before inserting large amount of text into
1251 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1252 for all controls so it is mostly just a hint to wxWindows and not a
1253 mandatory directive.", "");
1257 virtual void , Thaw(),
1258 "Reenables window updating after a previous call to Freeze. Calls to
1259 Freeze/Thaw may be nested, so Thaw must be called the same number of
1260 times that Freeze was before the window will be updated.", "");
1264 virtual void , PrepareDC( wxDC & dc ),
1265 "Call this function to prepare the device context for drawing a
1266 scrolled image. It sets the device origin according to the current
1267 scroll position.", "");
1271 wxRegion& , GetUpdateRegion(),
1272 "Returns the region specifying which parts of the window have been
1273 damaged. Should only be called within an EVT_PAINT handler.", "");
1277 wxRect , GetUpdateClientRect() const,
1278 "Get the update rectangle region bounding box in client coords.", "");
1282 "Returns true if the given point or rectangle area has been exposed
1283 since the last repaint. Call this in an paint event handler to
1284 optimize redrawing by only redrawing those areas, which have been
1286 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1287 %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
1288 %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
1292 // colours, fonts and cursors
1293 // --------------------------
1297 virtual wxVisualAttributes , GetDefaultAttributes() const,
1298 "Get the default attributes for an instance of this class. This is
1299 useful if you want to use the same font or colour in your own control
1300 as in a standard control -- which is a much better idea than hard
1301 coding specific colours or fonts which might look completely out of
1302 place on the user's system, especially if it uses themes.", "");
1306 static wxVisualAttributes ,
1307 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1308 "Get the default attributes for this class. This is useful if you want
1309 to use the same font or colour in your own control as in a standard
1310 control -- which is a much better idea than hard coding specific
1311 colours or fonts which might look completely out of place on the
1312 user's system, especially if it uses themes.
1314 The variant parameter is only relevant under Mac currently and is
1315 ignore under other platforms. Under Mac, it will change the size of
1316 the returned font. See `wx.Window.SetWindowVariant` for more about
1321 virtual bool , SetBackgroundColour( const wxColour &colour ),
1322 "Sets the background colour of the window. Returns True if the colour
1323 was changed. The background colour is usually painted by the default
1324 EVT_ERASE_BACKGROUND event handler function under Windows and
1325 automatically under GTK. Using `wx.NullColour` will reset the window
1326 to the default background colour.
1328 Note that setting the background colour may not cause an immediate
1329 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1330 calling this function.
1332 Using this function will disable attempts to use themes for this
1333 window, if the system supports them. Use with care since usually the
1334 themes represent the appearance chosen by the user to be used for all
1335 applications on the system.", "");
1338 void , SetOwnBackgroundColour(const wxColour& colour),
1344 virtual bool , SetForegroundColour( const wxColour &colour ),
1345 "Sets the foreground colour of the window. Returns True is the colour
1346 was changed. The interpretation of foreground colour is dependent on
1347 the window class; it may be the text colour or other colour, or it may
1348 not be used at all.", "");
1351 void , SetOwnForegroundColour(const wxColour& colour),
1357 wxColour , GetBackgroundColour() const,
1358 "Returns the background colour of the window.", "");
1361 wxColour , GetForegroundColour() const,
1362 "Returns the foreground colour of the window. The interpretation of
1363 foreground colour is dependent on the window class; it may be the text
1364 colour or other colour, or it may not be used at all.", "");
1367 bool , InheritsBackgroundColour() const,
1371 bool , UseBgCol() const,
1376 // // if the window shouldn't inherit its colour from the parent, override
1377 // // this function to return true
1379 // // this is currently only used by wxMSW and wxUniv but should be useful for
1380 // // the other ports too
1381 // virtual bool ProvidesBackground() const;
1384 // Set/get the background style.
1385 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1387 virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
1388 "Returns the background style of the window. The background style
1389 indicates how the background of the window is drawn.
1391 ====================== ========================================
1392 wx.BG_STYLE_SYSTEM The background colour or pattern should
1393 be determined by the system
1394 wx.BG_STYLE_COLOUR The background should be a solid colour
1395 wx.BG_STYLE_CUSTOM The background will be implemented by the
1397 ====================== ========================================
1399 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
1400 a custom background, such as a tiled bitmap. Currently the style has
1401 no effect on other platforms.
1403 :see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
1406 virtual wxBackgroundStyle , GetBackgroundStyle() const,
1407 "Returns the background style of the window.
1409 :see: `SetBackgroundStyle`", "");
1413 bool , HasTransparentBackground(),
1414 "Returns True if this window's background is transparent (as, for
1415 example, for `wx.StaticText`) and should show the parent window's
1418 This method is mostly used internally by the library itself and you
1419 normally shouldn't have to call it. You may, however, have to override
1420 it in your custom control classes to ensure that background is painted
1425 virtual bool , SetCursor( const wxCursor &cursor ),
1426 "Sets the window's cursor. Notice that the window cursor also sets it
1427 for the children of the window implicitly.
1429 The cursor may be wx.NullCursor in which case the window cursor will
1430 be reset back to default.", "");
1433 wxCursor , GetCursor(),
1434 "Return the cursor associated with this window.", "");
1439 virtual bool , SetFont( const wxFont &font ),
1440 "Sets the font for this window.", "");
1443 void , SetOwnFont(const wxFont& font),
1450 "Returns the default font used for this window.", "");
1455 void , SetCaret(wxCaret *caret),
1456 "Sets the caret associated with the window.", "");
1459 wxCaret *, GetCaret() const,
1460 "Returns the caret associated with the window.", "");
1465 virtual int , GetCharHeight() const,
1466 "Get the (average) character size for the current font.", "");
1469 virtual int , GetCharWidth() const,
1470 "Get the (average) character size for the current font.", "");
1475 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1476 "GetTextExtent(String string) -> (width, height)",
1477 "Get the width and height of the text using the current font.", "");
1479 void, GetTextExtent(const wxString& string,
1480 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1481 const wxFont* font = NULL),
1482 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1483 "Get the width, height, decent and leading of the text using the
1484 current or specified font.", "",
1489 // client <-> screen coords
1490 // ------------------------
1492 %apply int * INOUT { int* x, int* y };
1494 // translate to/from screen/client coordinates
1496 void , ClientToScreen( int *x, int *y ) const,
1497 "ClientToScreenXY(int x, int y) -> (x,y)",
1498 "Converts to screen coordinates from coordinates relative to this window.", "",
1502 void , ScreenToClient( int *x, int *y ) const,
1503 "ScreenToClientXY(int x, int y) -> (x,y)",
1504 "Converts from screen to client window coordinates.", "",
1509 wxPoint , ClientToScreen(const wxPoint& pt) const,
1510 "Converts to screen coordinates from coordinates relative to this window.", "");
1513 wxPoint , ScreenToClient(const wxPoint& pt) const,
1514 "Converts from screen to client window coordinates.", "");
1519 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1520 "Test where the given (in client coords) point lies", "",
1524 wxHitTest , HitTest(const wxPoint& pt) const,
1525 "Test where the given (in client coords) point lies", "");
1533 %nokwargs GetBorder;
1535 wxBorder , GetBorder(long flags) const,
1536 "Get the window border style from the given flags: this is different
1537 from simply doing flags & wxBORDER_MASK because it uses
1538 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1543 wxBorder , GetBorder() const,
1544 "Get border for the flags of this window", "");
1550 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1551 "This function sends EVT_UPDATE_UI events to the window. The particular
1552 implementation depends on the window; for example a wx.ToolBar will
1553 send an update UI event for each toolbar button, and a wx.Frame will
1554 send an update UI event for each menubar menu item. You can call this
1555 function from your application to ensure that your UI is up-to-date at
1556 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1557 concerned). This may be necessary if you have called
1558 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
1559 limit the overhead that wxWindows incurs by sending update UI events
1562 The flags should be a bitlist of one or more of the following values:
1564 ===================== ==============================
1565 wx.UPDATE_UI_NONE No particular value
1566 wx.UPDATE_UI_RECURSE Call the function for descendants
1567 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1568 ===================== ==============================
1570 If you are calling this function from an OnIdle function, make sure
1571 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1572 to only update the UI elements that need to be updated in idle
1573 time. Some windows update their elements only when necessary, for
1574 example when a menu is about to be shown. The following is an example
1575 of how to call UpdateWindowUI from an idle function::
1577 def OnIdle(self, evt):
1578 if wx.UpdateUIEvent.CanUpdate(self):
1579 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1583 // TODO: using directors?
1584 // // do the window-specific processing after processing the update event
1585 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1589 "Pops up the given menu at the specified coordinates, relative to this window,
1590 and returns control when the user has dismissed the menu. If a menu item is
1591 selected, the corresponding menu event is generated and will be processed as
1592 usual. If the default position is given then the current position of the
1593 mouse cursor will be used.", "");
1594 %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
1595 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1602 "Returns the platform-specific handle (as a long integer) of the
1603 physical window. Currently on wxMac it returns the handle of the
1604 toplevel parent of the window.", "");
1606 return wxPyGetWinHandle(self);
1612 "Associate the window with a new native handle", "");
1614 void AssociateHandle(long handle) {
1615 self->AssociateHandle((WXWidget)handle);
1621 virtual void , DissociateHandle(),
1622 "Dissociate the current native handle from the window", "");
1627 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1628 void OnPaint(wxPaintEvent& event);
1638 bool , HasScrollbar(int orient) const,
1639 "Does the window have the scrollbar for this orientation?", "");
1642 // configure the window scrollbars
1644 virtual void , SetScrollbar( int orientation,
1648 bool refresh = true ),
1649 "Sets the scrollbar properties of a built-in scrollbar.",
1651 :param orientation: Determines the scrollbar whose page size is to
1652 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1654 :param position: The position of the scrollbar in scroll units.
1656 :param thumbSize: The size of the thumb, or visible portion of the
1657 scrollbar, in scroll units.
1659 :param range: The maximum position of the scrollbar.
1661 :param refresh: True to redraw the scrollbar, false otherwise.
1665 virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
1666 "Sets the position of one of the built-in scrollbars.", "");
1669 virtual int , GetScrollPos( int orientation ) const,
1670 "Returns the built-in scrollbar position.", "");
1673 virtual int , GetScrollThumb( int orientation ) const,
1674 "Returns the built-in scrollbar thumb size.", "");
1677 virtual int , GetScrollRange( int orientation ) const,
1678 "Returns the built-in scrollbar range.", "");
1684 virtual void , ScrollWindow( int dx, int dy,
1685 const wxRect* rect = NULL ),
1686 "Physically scrolls the pixels in the window and move child windows
1687 accordingly. Use this function to optimise your scrolling
1688 implementations, to minimise the area that must be redrawn. Note that
1689 it is rarely required to call this function from a user program.","
1691 :param dx: Amount to scroll horizontally.
1693 :param dy: Amount to scroll vertically.
1695 :param rect: Rectangle to invalidate. If this is None, the whole
1696 window is invalidated. If you pass a rectangle corresponding
1697 to the area of the window exposed by the scroll, your
1698 painting handler can optimize painting by checking for the
1699 invalidated region.");
1703 virtual bool , ScrollLines(int lines),
1704 "If the platform and window class supports it, scrolls the window by
1705 the given number of lines down, if lines is positive, or up if lines
1706 is negative. Returns True if the window was scrolled, False if it was
1707 already on top/bottom and nothing was done.", "");
1710 virtual bool , ScrollPages(int pages),
1711 "If the platform and window class supports it, scrolls the window by
1712 the given number of pages down, if pages is positive, or up if pages
1713 is negative. Returns True if the window was scrolled, False if it was
1714 already on top/bottom and nothing was done.", "");
1719 "This is just a wrapper for ScrollLines(-1).", "");
1723 "This is just a wrapper for ScrollLines(1).", "");
1727 "This is just a wrapper for ScrollPages(-1).", "");
1731 "This is just a wrapper for ScrollPages(1).", "");
1736 // context-sensitive help
1737 // ----------------------
1740 void , SetHelpText(const wxString& text),
1741 "Sets the help text to be used as context-sensitive help for this
1742 window. Note that the text is actually stored by the current
1743 wxHelpProvider implementation, and not in the window object itself.", "");
1747 void , SetHelpTextForId(const wxString& text),
1748 "Associate this help text with all windows with the same id as this
1753 wxString , GetHelpText() const,
1754 "Gets the help text to be used as context-sensitive help for this
1755 window. Note that the text is actually stored by the current
1756 wxHelpProvider implementation, and not in the window object itself.", "");
1765 "Attach a tooltip to the window.", "");
1766 %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
1767 void SetToolTip( wxToolTip *tip );
1770 wxToolTip* , GetToolTip() const,
1771 "get the associated tooltip or None if none", "");
1773 // LINK ERROR --> wxString GetToolTipText() const;
1782 // set/retrieve the drop target associated with this window (may be
1783 // NULL; it's owned by the window and will be deleted by it)
1784 %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
1787 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1788 "Associates a drop target with this window. If the window already has
1789 a drop target, it is deleted.", "");
1791 %clear wxPyDropTarget *dropTarget;
1795 virtual wxPyDropTarget *, GetDropTarget() const,
1796 "Returns the associated drop target, which may be None.", "");
1799 #ifdef __WXMSW__ // TODO: should I drop-kick this?
1801 void , DragAcceptFiles(bool accept),
1802 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1803 Only available on Windows.", "");
1808 // constraints and sizers
1809 // ----------------------
1811 // set the constraints for this window or retrieve them (may be NULL)
1813 void , SetConstraints( wxLayoutConstraints *constraints ),
1814 "Sets the window to have the given layout constraints. If an existing
1815 layout constraints object is already owned by the window, it will be
1816 deleted. Pass None to disassociate and delete the window's current
1819 You must call SetAutoLayout to tell a window to use the constraints
1820 automatically in its default EVT_SIZE handler; otherwise, you must
1821 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1822 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1826 wxLayoutConstraints *, GetConstraints() const,
1827 "Returns a pointer to the window's layout constraints, or None if there
1832 void , SetAutoLayout( bool autoLayout ),
1833 "Determines whether the Layout function will be called automatically
1834 when the window is resized. It is called implicitly by SetSizer but
1835 if you use SetConstraints you should call it manually or otherwise the
1836 window layout won't be correctly updated when its size changes.", "");
1839 bool , GetAutoLayout() const,
1840 "Returns the current autoLayout setting", "");
1844 virtual bool , Layout(),
1845 "Invokes the constraint-based layout algorithm or the sizer-based
1846 algorithm for this window. See SetAutoLayout: when auto layout is on,
1847 this function gets called automatically by the default EVT_SIZE
1848 handler when the window is resized.", "");
1852 void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
1853 "Sets the window to have the given layout sizer. The window will then
1854 own the object, and will take care of its deletion. If an existing
1855 layout sizer object is already owned by the window, it will be deleted
1856 if the deleteOld parameter is true. Note that this function will also
1857 call SetAutoLayout implicitly with a True parameter if the sizer is
1858 non-None, and False otherwise.", "");
1861 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
1862 "The same as SetSizer, except it also sets the size hints for the
1863 window based on the sizer's minimum size.", "");
1867 wxSizer *, GetSizer() const,
1868 "Return the sizer associated with the window by a previous call to
1869 SetSizer or None if there isn't one.", "");
1872 // Track if this window is a member of a sizer
1874 void , SetContainingSizer(wxSizer* sizer),
1875 "This normally does not need to be called by application code. It is
1876 called internally when a window is added to a sizer, and is used so
1877 the window can remove itself from the sizer when it is destroyed.", "");
1880 wxSizer *, GetContainingSizer() const,
1881 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1887 // ----------------------
1888 #if wxUSE_ACCESSIBILITY
1889 // Override to create a specific accessible object.
1890 virtual wxAccessible* CreateAccessible();
1892 // Sets the accessible object.
1893 void SetAccessible(wxAccessible* accessible) ;
1895 // Returns the accessible object.
1896 wxAccessible* GetAccessible() { return m_accessible; };
1898 // Returns the accessible object, creating if necessary.
1899 wxAccessible* GetOrCreateAccessible() ;
1906 virtual void , InheritAttributes(),
1907 "This function is (or should be, in case of custom controls) called
1908 during window creation to intelligently set up the window visual
1909 attributes, that is the font and the foreground and background
1912 By 'intelligently' the following is meant: by default, all windows use
1913 their own default attributes. However if some of the parent's
1914 attributes are explicitly changed (that is, using SetFont and not
1915 SetOwnFont) and if the corresponding attribute hadn't been
1916 explicitly set for this window itself, then this window takes the same
1917 value as used by the parent. In addition, if the window overrides
1918 ShouldInheritColours to return false, the colours will not be changed
1919 no matter what and only the font might.
1921 This rather complicated logic is necessary in order to accommodate the
1922 different usage scenarios. The most common one is when all default
1923 attributes are used and in this case, nothing should be inherited as
1924 in modern GUIs different controls use different fonts (and colours)
1925 than their siblings so they can't inherit the same value from the
1926 parent. However it was also deemed desirable to allow to simply change
1927 the attributes of all children at once by just changing the font or
1928 colour of their common parent, hence in this case we do inherit the
1933 // TODO: Virtualize this with directors
1935 virtual bool , ShouldInheritColours() const,
1936 "Return true from here to allow the colours of this window to be
1937 changed by InheritAttributes, returning false forbids inheriting them
1938 from the parent window.
1940 The base class version returns false, but this method is overridden in
1941 wxControl where it returns true.", "");
1946 def PostCreate(self, pre):
1948 Phase 3 of the 2-phase create <wink!>
1949 Call this method after precreating the window with the 2-phase create method.
1951 self.this = pre.this
1952 self.thisown = pre.thisown
1954 if hasattr(self, '_setOORInfo'):
1955 self._setOORInfo(self)
1956 if hasattr(self, '_setCallbackInfo'):
1957 self._setCallbackInfo(self, self.__class__)
1969 def DLG_PNT(win, point_or_x, y=None):
1971 Convenience function for converting a Point or (x,y) in
1972 dialog units to pixel units.
1975 return win.ConvertDialogPointToPixels(point_or_x)
1977 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
1979 def DLG_SZE(win, size_width, height=None):
1981 Convenience function for converting a Size or (w,h) in
1982 dialog units to pixel units.
1985 return win.ConvertDialogSizeToPixels(size_width)
1987 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
1993 // Unfortunatly the names of these new static methods clash with the
1994 // names wxPython has been using forever for the overloaded
1995 // wxWindow::FindWindow, so instead of swigging them as statics create
1996 // standalone functions for them.
1999 DocStr(wxFindWindowById,
2000 "Find the first window in the application with the given id. If parent
2001 is None, the search will start from all top-level frames and dialog
2002 boxes; if non-None, the search will be limited to the given window
2003 hierarchy. The search is recursive in both cases.", "");
2005 DocStr(wxFindWindowByName,
2006 "Find a window by its name (as given in a window constructor or Create
2007 function call). If parent is None, the search will start from all
2008 top-level frames and dialog boxes; if non-None, the search will be
2009 limited to the given window hierarchy. The search is recursive in both
2012 If no window with such name is found, wx.FindWindowByLabel is called.", "");
2014 DocStr(wxFindWindowByLabel,
2015 "Find a window by its label. Depending on the type of window, the label
2016 may be a window title or panel item label. If parent is None, the
2017 search will start from all top-level frames and dialog boxes; if
2018 non-None, the search will be limited to the given window
2019 hierarchy. The search is recursive in both cases.", "");
2022 MustHaveApp(wxFindWindowById);
2023 MustHaveApp(wxFindWindowByName);
2024 MustHaveApp(wxFindWindowByLabel);
2027 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
2028 return wxWindow::FindWindowById(id, parent);
2031 wxWindow* wxFindWindowByName( const wxString& name,
2032 const wxWindow *parent = NULL ) {
2033 return wxWindow::FindWindowByName(name, parent);
2036 wxWindow* wxFindWindowByLabel( const wxString& label,
2037 const wxWindow *parent = NULL ) {
2038 return wxWindow::FindWindowByLabel(label, parent);
2046 #include <wx/msw/private.h> // to get wxGetWindowId
2051 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
2053 WXHWND hWnd = (WXHWND)_hWnd;
2054 long id = wxGetWindowId(hWnd);
2055 wxWindow* win = new wxWindow;
2056 parent->AddChild(win);
2057 win->SetEventHandler(win);
2060 win->SubclassWin(hWnd);
2061 win->AdoptAttributesFromHWND();
2062 win->SetupColours();
2065 wxPyRaiseNotImplemented();
2071 //---------------------------------------------------------------------------
2073 DocStr(GetTopLevelWindows,
2074 "Returns a list of the the application's top-level windows, (frames,
2075 dialogs, etc.) NOTE: Currently this is a copy of the list maintained
2076 by wxWidgets, and so it is only valid as long as no top-level windows
2077 are closed or new top-level windows are created.
2080 PyObject* GetTopLevelWindows() {
2081 return wxPy_ConvertList(&wxTopLevelWindows);
2085 //---------------------------------------------------------------------------
2086 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob