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);
193 MustHaveApp(wxWindow::GetClassDefaultAttributes);
195 class wxWindow : public wxEvtHandler
198 %pythonAppend wxWindow "self._setOORInfo(self)"
199 %pythonAppend wxWindow() ""
202 wxWindow(wxWindow* parent, const wxWindowID id=-1,
203 const wxPoint& pos = wxDefaultPosition,
204 const wxSize& size = wxDefaultSize,
206 const wxString& name = wxPyPanelNameStr),
207 "Construct and show a generic Window.", "");
211 "Precreate a Window for 2-phase creation.", "",
216 bool , Create(wxWindow* parent, const wxWindowID id=-1,
217 const wxPoint& pos = wxDefaultPosition,
218 const wxSize& size = wxDefaultSize,
220 const wxString& name = wxPyPanelNameStr),
221 "Create the GUI part of the Window for 2-phase creation mode.", "");
224 // deleting the window
225 // -------------------
229 bool , Close( bool force = False ),
230 "This function simply generates a EVT_CLOSE event whose handler usually
231 tries to close the window. It doesn't close the window itself,
232 however. If force is False (the default) then the window's close
233 handler will be allowed to veto the destruction of the window.",
235 Usually Close is only used with the top level windows (wx.Frame and
236 wx.Dialog classes) as the others are not supposed to have any special
239 The close handler should check whether the window is being deleted
240 forcibly, using wx.CloseEvent.GetForce, in which case it should
241 destroy the window using wx.Window.Destroy.
243 Note that calling Close does not guarantee that the window will be
244 destroyed; but it provides a way to simulate a manual close of a
245 window, which may or may not be implemented by destroying the
246 window. The default EVT_CLOSE handler for wx.Dialog does not
247 necessarily delete the dialog, since it will simply simulate an
248 wxID_CANCEL event which is handled by the appropriate button event
249 handler and may do anything at all.
251 To guarantee that the window will be destroyed, call wx.Window.Destroy
257 virtual bool , Destroy(),
258 "Destroys the window safely. Frames and dialogs are not destroyed
259 immediately when this function is called -- they are added to a list
260 of windows to be deleted on idle time, when all the window's events
261 have been processed. This prevents problems with events being sent to
262 non-existent windows.
264 Returns True if the window has either been successfully deleted, or it
265 has been added to the list of windows pending real deletion.", "");
269 bool , DestroyChildren(),
270 "Destroys all children of a window. Called automatically by the
275 bool , IsBeingDeleted() const,
276 "Is the window in the process of being deleted?", "");
284 virtual void , SetTitle( const wxString& title),
285 "Sets the window's title. Applicable only to frames and dialogs.", "");
288 virtual wxString , GetTitle() const,
289 "Gets the window's title. Applicable only to frames and dialogs.", "");
293 virtual void , SetLabel(const wxString& label),
294 "Set the text which the window shows in its label if applicable.", "");
297 virtual wxString , GetLabel() const,
298 "Generic way of getting a label from any window, for identification
299 purposes. The interpretation of this function differs from class to
300 class. For frames and dialogs, the value returned is the title. For
301 buttons or static text controls, it is the button text. This function
302 can be useful for meta-programs such as testing tools or special-needs
303 access programs)which need to identify windows by name.", "");
307 virtual void , SetName( const wxString &name ),
308 "Sets the window's name. The window name is used for ressource setting
309 in X, it is not the same as the window title/label", "");
312 virtual wxString , GetName() const,
313 "Returns the windows name. This name is not guaranteed to be unique;
314 it is up to the programmer to supply an appropriate name in the window
315 constructor or via wx.Window.SetName.", "");
319 void , SetWindowVariant( wxWindowVariant variant ),
320 "Sets the variant of the window/font size to use for this window, if
321 the platform supports variants, for example, wxMac.",
325 ======================== =======================================
326 wx.WINDOW_VARIANT_NORMAL Normal size
327 wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
328 wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
329 wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
330 ======================== =======================================
334 wxWindowVariant , GetWindowVariant() const,
339 void , SetId( wxWindowID winid ),
340 "Sets the identifier of the window. Each window has an integer
341 identifier. If the application has not provided one, an identifier
342 will be generated. Normally, the identifier should be provided on
343 creation and should not be modified subsequently.", "");
346 wxWindowID , GetId() const,
347 "Returns the identifier of the window. Each window has an integer
348 identifier. If the application has not provided one (or the default Id
349 -1 is used) then an unique identifier with a negative value will be
354 static int , NewControlId(),
355 "Generate a control id for the controls which were not given one.", "");
359 static int , NextControlId(int winid),
360 "Get the id of the control following the one with the given
361 autogenerated) id", "");
365 static int , PrevControlId(int winid),
366 "Get the id of the control preceding the one with the given
367 autogenerated) id", "");
377 void , SetSize( const wxSize& size ),
378 "Sets the size of the window in pixels.", "");
382 void , SetSize( int x, int y, int width, int height,
383 int sizeFlags = wxSIZE_AUTO ),
384 "Sets the position and size of the window in pixels. The sizeFlags
385 parameter indicates the interpretation of the other params if they are
386 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
387 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
388 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
389 dimensions of -1 and less to be interpreted as real dimensions, not
390 default values.", "",
395 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
396 "Sets the position and size of the window in pixels using a wx.Rect.", "",
401 void , SetSize( int width, int height ),
402 "Sets the size of the window in pixels.", "",
407 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
408 "Moves the window to the given position.", "");
410 %pythoncode { SetPosition = Move }
414 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
415 "Moves the window to the given position.", "",
421 virtual void , Raise(),
422 "Raises the window to the top of the window hierarchy if it is a
423 managed window (dialog or frame).", "");
426 virtual void , Lower(),
427 "Lowers the window to the bottom of the window hierarchy if it is a
428 managed window (dialog or frame).", "");
432 // client size is the size of the area available for subwindows
433 DocStr(SetClientSize,
434 "This sets the size of the window client area in pixels. Using this
435 function to size a window tends to be more device-independent than
436 wx.Window.SetSize, since the application need not worry about what
437 dimensions the border or title bar have when trying to fit the window
438 around panel items, for example.", "");
439 void SetClientSize( const wxSize& size );
440 %name(SetClientSizeWH) void SetClientSize( int width, int height );
441 %name(SetClientRect) void SetClientSize(const wxRect& rect);
444 DocStr(GetPosition, // sets the docstring for both
445 "Get the window's position.", "");
446 wxPoint GetPosition();
449 void, GetPosition(int *OUTPUT, int *OUTPUT),
450 "GetPositionTuple() -> (x,y)",
454 DocStr(GetSize, "Get the window size.", "");
455 wxSize GetSize() const;
457 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
458 "GetSizeTuple() -> (width, height)",
464 wxRect , GetRect() const,
465 "Returns the size and position of the window as a wx.Rect object.", "");
468 DocStr(GetClientSize,
469 "This gets the size of the window's 'client area' in pixels. The client
470 area is the area which may be drawn on by the programmer, excluding
471 title bar, border, scrollbars, etc.", "");
472 wxSize GetClientSize() const;
474 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
475 "GetClientSizeTuple() -> (width, height)",
481 virtual wxPoint , GetClientAreaOrigin() const,
482 "Get the origin of the client area of the window relative to the
483 window's top left corner (the client area may be shifted because of
484 the borders, scrollbars, other decorations...)", "");
488 wxRect , GetClientRect() const,
489 "Get the client area position and size as a `wx.Rect` object.", "");
494 "This function returns the best acceptable minimal size for the
495 window, if applicable. For example, for a static text control, it will
496 be the minimal size such that the control label is not truncated. For
497 windows containing subwindows (suzh aswx.Panel), the size returned by
498 this function will be the same as the size the window would have had
499 after calling Fit.", "");
500 wxSize GetBestSize() const;
502 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
503 "GetBestSizeTuple() -> (width, height)",
508 wxSize , GetAdjustedBestSize() const,
509 "This method is similar to GetBestSize, except in one
510 thing. GetBestSize should return the minimum untruncated size of the
511 window, while this method will return the largest of BestSize and any
512 user specified minimum size. ie. it is the minimum size the window
513 should currently be drawn at, not the minimal size it can possibly
520 void , Center( int direction = wxBOTH ),
521 "Centers the window. The parameter specifies the direction for
522 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
523 also include wx.CENTER_ON_SCREEN flag if you want to center the window
524 on the entire screen and not on its parent window. If it is a
525 top-level window and has no parent then it will always be centered
526 relative to the screen.", "");
528 %pythoncode { Centre = Center }
532 void , CenterOnScreen(int dir = wxBOTH),
533 "Center on screen (only works for top level windows)", "");
534 %pythoncode { CentreOnScreen = CenterOnScreen }
538 void , CenterOnParent(int dir = wxBOTH),
539 "Center with respect to the the parent window", "");
540 %pythoncode { CentreOnParent = CenterOnParent }
545 virtual void , Fit(),
546 "Sizes the window so that it fits around its subwindows. This function
547 won't do anything if there are no subwindows and will only really work
548 correctly if sizers are used for the subwindows layout. Also, if the
549 window has exactly one subwindow it is better (faster and the result
550 is more precise as Fit adds some margin to account for fuzziness of
551 its calculations) to call window.SetClientSize(child.GetSize())
552 instead of calling Fit.", "");
556 virtual void , FitInside(),
557 "Similar to Fit, but sizes the interior (virtual) size of a
558 window. Mainly useful with scrolled windows to reset scrollbars after
559 sizing changes that do not trigger a size event, and/or scrolled
560 windows without an interior sizer. This function similarly won't do
561 anything if there are no subwindows.", "");
565 %nokwargs SetSizeHints;
567 "Allows specification of minimum and maximum window sizes, and window
568 size increments. If a pair of values is not set (or set to -1), the
569 default values will be used. If this function is called, the user
570 will not be able to size the window outside the given bounds (if it is
571 a top-level window.) Sizers will also inspect the minimum window size
572 and will use that value if set when calculating layout.
574 The resizing increments are only significant under Motif or Xt.", "
576 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
578 void SetSizeHints( const wxSize& minSize,
579 const wxSize& maxSize=wxDefaultSize,
580 const wxSize& incSize=wxDefaultSize);
581 virtual void SetSizeHints( int minW, int minH,
582 int maxW = -1, int maxH = -1,
583 int incW = -1, int incH = -1 );
586 %nokwargs SetVirtualSizeHints;
587 DocStr(SetVirtualSizeHints,
588 "Allows specification of minimum and maximum virtual window sizes. If a
589 pair of values is not set (or set to -1), the default values will be
590 used. If this function is called, the user will not be able to size
591 the virtual area of the window outside the given bounds.", "");
592 void SetVirtualSizeHints( const wxSize& minSize,
593 const wxSize& maxSize=wxDefaultSize);
594 virtual void SetVirtualSizeHints( int minW, int minH,
595 int maxW = -1, int maxH = -1 );
598 virtual wxSize , GetMaxSize() const,
602 virtual wxSize , GetMinSize() const,
606 void , SetMinSize(const wxSize& minSize),
607 "A more convenient method than `SetSizeHints` for setting just the
611 void , SetMaxSize(const wxSize& maxSize),
612 "A more convenient method than `SetSizeHints` for setting just the
618 virtual int , GetMinWidth() const,
622 virtual int , GetMinHeight() const,
626 int , GetMaxWidth() const,
630 int , GetMaxHeight() const,
635 DocStr(SetVirtualSize,
636 "Set the the virtual size of a window in pixels. For most windows this
637 is just the client area of the window, but for some like scrolled
638 windows it is more or less independent of the screen window size.", "");
639 void SetVirtualSize(const wxSize& size );
640 %name(SetVirtualSizeWH) void SetVirtualSize( int w, int h );
643 DocStr(GetVirtualSize,
644 "Get the the virtual size of the window in pixels. For most windows
645 this is just the client area of the window, but for some like scrolled
646 windows it is more or less independent of the screen window size.", "");
647 wxSize GetVirtualSize() const;
649 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
650 "GetVirtualSizeTuple() -> (width, height)",
651 GetVirtualSizeTuple);
654 // TODO: using directors?
655 // // Override these methods for windows that have a virtual size
656 // // independent of their client size. eg. the virtual area of a
657 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
658 // virtual void DoSetVirtualSize( int x, int y );
659 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
663 virtual wxSize , GetBestVirtualSize() const,
664 "Return the largest of ClientSize and BestSize (as determined by a
665 sizer, interior children, or other means)", "");
673 virtual bool , Show( bool show = True ),
674 "Shows or hides the window. You may need to call Raise for a top level
675 window if you want to bring it to top, although this is not needed if
676 Show is called immediately after the frame creation. Returns True if
677 the window has been shown or hidden or False if nothing was done
678 because it already was in the requested state.", "");
682 "Equivalent to calling Show(False).", "");
686 virtual bool , Enable( bool enable = True ),
687 "Enable or disable the window for user input. Note that when a parent
688 window is disabled, all of its children are disabled as well and they
689 are reenabled again when the parent is. Returns true if the window
690 has been enabled or disabled, false if nothing was done, i.e. if the
691 window had already been in the specified state.", "");
695 "Disables the window, same as Enable(false).", "");
699 bool , IsShown() const,
700 "Returns true if the window is shown, false if it has been hidden.", "");
703 bool , IsEnabled() const,
704 "Returns true if the window is enabled for input, false otherwise.", "");
710 virtual void , SetWindowStyleFlag( long style ),
711 "Sets the style of the window. Please note that some styles cannot be
712 changed after the window creation and that Refresh() might need to be
713 called after changing the others for the change to take place
717 virtual long , GetWindowStyleFlag() const,
718 "Gets the window style that was passed to the constructor or Create
721 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
725 bool , HasFlag(int flag) const,
726 "Test if the given style is set for this window.", "");
730 virtual bool , IsRetained() const,
731 "Returns true if the window is retained, false otherwise. Retained
732 windows are only available on X platforms.", "");
737 virtual void , SetExtraStyle(long exStyle),
738 "Sets the extra style bits for the window. Extra styles are the less
739 often used style bits which can't be set with the constructor or with
740 SetWindowStyleFlag()", "");
743 long , GetExtraStyle() const,
744 "Returns the extra style bits for the window.", "");
749 virtual void , MakeModal(bool modal = True),
750 "Disables all other windows in the application so that the user can
751 only interact with this window. Passing False will reverse this
757 virtual void , SetThemeEnabled(bool enableTheme),
758 "This function tells a window if it should use the system's \"theme\"
759 code to draw the windows' background instead if its own background
760 drawing code. This will only have an effect on platforms that support
761 the notion of themes in user defined windows. One such platform is
762 GTK+ where windows can have (very colourful) backgrounds defined by a
763 user's selected theme.
765 Dialogs, notebook pages and the status bar have this flag set to true
766 by default so that the default look and feel is simulated best.", "");
769 virtual bool , GetThemeEnabled() const,
770 "Return the themeEnabled flag.", "");
773 // TODO with directors
774 // // controls by default inherit the colours of their parents, if a
775 // // particular control class doesn't want to do it, it can override
776 // // ShouldInheritColours() to return False
777 // virtual bool ShouldInheritColours() const;
783 // focus and keyboard handling
784 // ---------------------------
788 virtual void , SetFocus(),
789 "Set's the focus to this window, allowing it to receive keyboard input.", "");
792 virtual void , SetFocusFromKbd(),
793 "Set focus to this window as the result of a keyboard action. Normally
794 only called internally.", "");
799 static wxWindow *, FindFocus(),
800 "Returns the window or control that currently has the keyboard focus,
805 virtual bool , AcceptsFocus() const,
806 "Can this window have focus?", "");
810 virtual bool , AcceptsFocusFromKeyboard() const,
811 "Can this window be given focus by keyboard navigation? if not, the
812 only way to give it focus (provided it accepts it at all) is to click
819 virtual wxWindow *, GetDefaultItem() const,
820 "Get the default child of this parent, i.e. the one which is activated
821 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
824 virtual wxWindow *, SetDefaultItem(wxWindow * child),
825 "Set this child as default, return the old default.", "");
828 virtual void , SetTmpDefaultItem(wxWindow * win),
829 "Set this child as temporary default", "");
832 // Navigates in the specified direction by sending a wxNavigationKeyEvent
834 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
835 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
836 "Does keyboard navigation from this window to another, by sending a
837 `wx.NavigationKeyEvent`.", "
839 :param flags: A combination of the ``IsForward`` and ``WinChange``
840 values in the `wx.NavigationKeyEvent` class, which
841 determine if the navigation should be in forward or
842 reverse order, and if it should be able to cross
843 parent window boundaries, such as between notebook
844 pages or MDI child frames. Typically the status of
845 the Shift key (for forward or reverse) or the
846 Control key (for WinChange) would be used to
847 determine how to set the flags.
849 One situation in which you may wish to call this method is from a text
850 control custom keypress handler to do the default navigation behaviour
851 for the tab key, since the standard default behaviour for a multiline
852 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
853 not navigate to the next control.");
859 // parent/children relations
860 // -------------------------
863 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
866 "Returns a list of the window's children. NOTE: Currently this is a
867 copy of the child window list maintained by the window, so the return
868 value of this function is only valid as long as the window's children
869 do not change.", "");
870 PyObject* GetChildren() {
871 wxWindowList& list = self->GetChildren();
872 return wxPy_ConvertList(&list);
877 wxWindow *, GetParent() const,
878 "Returns the parent window of this window, or None if there isn't one.", "");
881 wxWindow *, GetGrandParent() const,
882 "Returns the parent of the parent of this window, or None if there
888 virtual bool , IsTopLevel() const,
889 "Returns true if the given window is a top-level one. Currently all
890 frames and dialogs are always considered to be top-level windows (even
891 if they have a parent window).", "");
894 // change the real parent of this window, return True if the parent
895 // was changed, False otherwise (error or newParent == oldParent)
897 virtual bool , Reparent( wxWindow *newParent ),
898 "Reparents the window, i.e the window will be removed from its current
899 parent window (e.g. a non-standard toolbar in a wxFrame) and then
900 re-inserted into another. Available on Windows and GTK. Returns True
901 if the parent was changed, False otherwise (error or newParent ==
906 virtual void , AddChild( wxWindow *child ),
907 "Adds a child window. This is called automatically by window creation
908 functions so should not be required by the application programmer.", "");
911 virtual void , RemoveChild( wxWindow *child ),
912 "Removes a child window. This is called automatically by window
913 deletion functions so should not be required by the application
919 // looking for windows
920 // -------------------
923 wxWindow *, FindWindow( long winid ),
924 "Find a chld of this window by window ID", "",
928 wxWindow *, FindWindow( const wxString& name ),
929 "Find a child of this window by name", "",
934 // event handler stuff
935 // -------------------
938 wxEvtHandler *, GetEventHandler() const,
939 "Returns the event handler for this window. By default, the window is
940 its own event handler.", "");
944 void , SetEventHandler( wxEvtHandler *handler ),
945 "Sets the event handler for this window. An event handler is an object
946 that is capable of processing the events sent to a window. By default,
947 the window is its own event handler, but an application may wish to
948 substitute another, for example to allow central implementation of
949 event-handling for a variety of different window classes.
951 It is usually better to use `wx.Window.PushEventHandler` since this sets
952 up a chain of event handlers, where an event not handled by one event
953 handler is handed to the next one in the chain.", "");
957 void , PushEventHandler( wxEvtHandler *handler ),
958 "Pushes this event handler onto the event handler stack for the window.
959 An event handler is an object that is capable of processing the events
960 sent to a window. By default, the window is its own event handler, but
961 an application may wish to substitute another, for example to allow
962 central implementation of event-handling for a variety of different
965 wx.Window.PushEventHandler allows an application to set up a chain of
966 event handlers, where an event not handled by one event handler is
967 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
968 remove the event handler.", "");
972 wxEvtHandler *, PopEventHandler( bool deleteHandler = False ),
973 "Removes and returns the top-most event handler on the event handler
974 stack. If deleteHandler is True then the wx.EvtHandler object will be
975 destroyed after it is popped.", "");
979 bool , RemoveEventHandler(wxEvtHandler *handler),
980 "Find the given handler in the event handler chain and remove (but not
981 delete) it from the event handler chain, return True if it was found
982 and False otherwise (this also results in an assert failure so this
983 function should only be called when the handler is supposed to be
992 // a window may have an associated validator which is used to control
995 virtual void , SetValidator( const wxValidator &validator ),
996 "Deletes the current validator (if any) and sets the window validator,
997 having called wx.Validator.Clone to create a new validator of this
1001 virtual wxValidator *, GetValidator(),
1002 "Returns a pointer to the current validator for the window, or None if
1003 there is none.", "");
1007 virtual bool , Validate(),
1008 "Validates the current values of the child controls using their
1009 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1010 style flag set, the method will also call Validate() of all child
1011 windows. Returns false if any of the validations failed.", "");
1015 virtual bool , TransferDataToWindow(),
1016 "Transfers values to child controls from data areas specified by their
1017 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1018 style flag set, the method will also call TransferDataToWindow() of
1019 all child windows.", "");
1022 virtual bool , TransferDataFromWindow(),
1023 "Transfers values from child controls to data areas specified by their
1024 validators. Returns false if a transfer failed. If the window has
1025 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1026 also call TransferDataFromWindow() of all child windows.", "");
1030 virtual void , InitDialog(),
1031 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1032 to the dialog via validators.", "");
1041 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1042 "Sets the accelerator table for this window.", "");
1045 wxAcceleratorTable *, GetAcceleratorTable(),
1046 "Gets the accelerator table for this window.", "");
1052 // hot keys (system wide accelerators)
1053 // -----------------------------------
1055 DocStr(RegisterHotKey,
1056 "Registers a system wide hotkey. Every time the user presses the hotkey
1057 registered here, this window will receive a hotkey event. It will
1058 receive the event even if the application is in the background and
1059 does not have the input focus because the user is working with some
1060 other application. To bind an event handler function to this hotkey
1061 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1062 hotkey was registered successfully.", "");
1063 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1065 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1072 DocStr(UnregisterHotKey,
1073 "Unregisters a system wide hotkey.", "");
1074 bool UnregisterHotKey(int hotkeyId) {
1076 return self->UnregisterHotKey(hotkeyId);
1085 // "dialog units" translations
1086 // ---------------------------
1088 DocStr(ConvertDialogToPixels,
1089 "Converts a point or size from dialog units to pixels. Dialog units
1090 are used for maintaining a dialog's proportions even if the font
1091 changes. For the x dimension, the dialog units are multiplied by the
1092 average character width and then divided by 4. For the y dimension,
1093 the dialog units are multiplied by the average character height and
1094 then divided by 8.", "");
1095 %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
1096 %name(ConvertDialogSizeToPixels) wxSize ConvertDialogToPixels(const wxSize& sz);
1097 %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
1098 %name(DLG_SZE) wxSize ConvertDialogToPixels(const wxSize& sz);
1101 DocStr(ConvertPixelPointToDialog,
1102 "Converts a point or size from pixels to dialog units. Dialog units
1103 are used for maintaining a dialog's proportions even if the font
1104 changes. For the x dimension, the dialog units are multiplied by the
1105 average character width and then divided by 4. For the y dimension,
1106 the dialog units are multiplied by the average character height and
1107 then divided by 8.", "");
1108 %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
1109 %name(ConvertPixelSizeToDialog) wxSize ConvertPixelsToDialog(const wxSize& sz);
1117 virtual void , WarpPointer(int x, int y),
1118 "Moves the pointer to the given position on the window.
1120 NOTE: This function is not supported under Mac because Apple Human
1121 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1125 void , CaptureMouse(),
1126 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1127 release the capture.
1129 Note that wxWindows maintains the stack of windows having captured the
1130 mouse and when the mouse is released the capture returns to the window
1131 which had had captured it previously and it is only really released if
1132 there were no previous window. In particular, this means that you must
1133 release the mouse as many times as you capture it.", "");
1136 void , ReleaseMouse(),
1137 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1141 static wxWindow *, GetCapture(),
1142 "Returns the window which currently captures the mouse or None", "");
1146 virtual bool , HasCapture() const,
1147 "Returns true if this window has the current mouse capture.", "");
1153 // painting the window
1154 // -------------------
1157 virtual void , Refresh( bool eraseBackground = True,
1158 const wxRect *rect = NULL ),
1159 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1160 will be repainted. Causes an EVT_PAINT event to be generated and sent
1161 to the window.", "");
1165 void , RefreshRect(const wxRect& rect),
1166 "Redraws the contents of the given rectangle: the area inside it will
1167 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1171 virtual void , Update(),
1172 "Calling this method immediately repaints the invalidated area of the
1173 window instead of waiting for the EVT_PAINT event to happen, (normally
1174 this would usually only happen when the flow of control returns to the
1175 event loop.) Notice that this function doesn't refresh the window and
1176 does nothing if the window has been already repainted. Use Refresh
1177 first if you want to immediately redraw the window (or some portion of
1178 it) unconditionally.", "");
1182 virtual void , ClearBackground(),
1183 "Clears the window by filling it with the current background
1184 colour. Does not cause an erase background event to be generated.", "");
1189 virtual void , Freeze(),
1190 "Freezes the window or, in other words, prevents any updates from
1191 taking place on screen, the window is not redrawn at all. Thaw must be
1192 called to reenable window redrawing. Calls to Freeze/Thaw may be
1193 nested, with the actual Thaw being delayed until all the nesting has
1196 This method is useful for visual appearance optimization (for example,
1197 it is a good idea to use it before inserting large amount of text into
1198 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1199 for all controls so it is mostly just a hint to wxWindows and not a
1200 mandatory directive.", "");
1204 virtual void , Thaw(),
1205 "Reenables window updating after a previous call to Freeze. Calls to
1206 Freeze/Thaw may be nested, so Thaw must be called the same number of
1207 times that Freeze was before the window will be updated.", "");
1211 virtual void , PrepareDC( wxDC & dc ),
1212 "Call this function to prepare the device context for drawing a
1213 scrolled image. It sets the device origin according to the current
1214 scroll position.", "");
1218 wxRegion& , GetUpdateRegion(),
1219 "Returns the region specifying which parts of the window have been
1220 damaged. Should only be called within an EVT_PAINT handler.", "");
1224 wxRect , GetUpdateClientRect() const,
1225 "Get the update rectangle region bounding box in client coords.", "");
1229 "Returns true if the given point or rectangle area has been exposed
1230 since the last repaint. Call this in an paint event handler to
1231 optimize redrawing by only redrawing those areas, which have been
1233 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1234 %name(IsExposedPoint) bool IsExposed( const wxPoint& pt ) const;
1235 %name(IsExposedRect) bool IsExposed( const wxRect& rect ) const;
1239 // colours, fonts and cursors
1240 // --------------------------
1244 virtual wxVisualAttributes , GetDefaultAttributes() const,
1245 "Get the default attributes for an instance of this class. This is
1246 useful if you want to use the same font or colour in your own control
1247 as in a standard control -- which is a much better idea than hard
1248 coding specific colours or fonts which might look completely out of
1249 place on the user's system, especially if it uses themes.", "");
1253 static wxVisualAttributes ,
1254 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1255 "Get the default attributes for this class. This is useful if you want
1256 to use the same font or colour in your own control as in a standard
1257 control -- which is a much better idea than hard coding specific
1258 colours or fonts which might look completely out of place on the
1259 user's system, especially if it uses themes.
1261 The variant parameter is only relevant under Mac currently and is
1262 ignore under other platforms. Under Mac, it will change the size of
1263 the returned font. See `wx.Window.SetWindowVariant` for more about
1268 virtual bool , SetBackgroundColour( const wxColour &colour ),
1269 "Sets the background colour of the window. Returns True if the colour
1270 was changed. The background colour is usually painted by the default
1271 EVT_ERASE_BACKGROUND event handler function under Windows and
1272 automatically under GTK.
1274 Note that setting the background colour may not cause an immediate
1275 refresh, so you may wish to call ClearBackground or Refresh after
1276 calling this function.
1278 Use this function with care under GTK+ as the new appearance of the
1279 window might not look equally well when used with themes, i.e GTK+'s
1280 ability to change its look as the user wishes with run-time loadable
1284 void , SetDefaultBackgroundColour(const wxColour& colour),
1290 virtual bool , SetForegroundColour( const wxColour &colour ),
1291 "Sets the foreground colour of the window. Returns True is the colour
1292 was changed. The interpretation of foreground colour is dependent on
1293 the window class; it may be the text colour or other colour, or it may
1294 not be used at all.", "");
1297 void , SetDefaultForegroundColour(const wxColour& colour),
1303 wxColour , GetBackgroundColour() const,
1304 "Returns the background colour of the window.", "");
1307 wxColour , GetForegroundColour() const,
1308 "Returns the foreground colour of the window. The interpretation of
1309 foreground colour is dependent on the window class; it may be the text
1310 colour or other colour, or it may not be used at all.", "");
1316 virtual bool , SetCursor( const wxCursor &cursor ),
1317 "Sets the window's cursor. Notice that the window cursor also sets it
1318 for the children of the window implicitly.
1320 The cursor may be wx.NullCursor in which case the window cursor will
1321 be reset back to default.", "");
1324 wxCursor& , GetCursor(),
1325 "Return the cursor associated with this window.", "");
1330 virtual bool , SetFont( const wxFont &font ),
1331 "Sets the font for this window.", "");
1334 void , SetDefaultFont(const wxFont& font),
1340 wxFont& , GetFont(),
1341 "Returns the default font used for this window.", "");
1346 void , SetCaret(wxCaret *caret),
1347 "Sets the caret associated with the window.", "");
1350 wxCaret *, GetCaret() const,
1351 "Returns the caret associated with the window.", "");
1356 virtual int , GetCharHeight() const,
1357 "Get the (average) character size for the current font.", "");
1360 virtual int , GetCharWidth() const,
1361 "Get the (average) character size for the current font.", "");
1366 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1367 "GetTextExtent(String string) -> (width, height)",
1368 "Get the width and height of the text using the current font.", "");
1370 void, GetTextExtent(const wxString& string,
1371 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1372 const wxFont* font = NULL),
1373 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1374 "Get the width, height, decent and leading of the text using the
1375 current or specified font.", "",
1380 // client <-> screen coords
1381 // ------------------------
1383 %apply int * INOUT { int* x, int* y };
1385 // translate to/from screen/client coordinates
1387 void , ClientToScreen( int *x, int *y ) const,
1388 "ClientToScreenXY(int x, int y) -> (x,y)",
1389 "Converts to screen coordinates from coordinates relative to this window.", "",
1393 void , ScreenToClient( int *x, int *y ) const,
1394 "ScreenToClientXY(int x, int y) -> (x,y)",
1395 "Converts from screen to client window coordinates.", "",
1400 wxPoint , ClientToScreen(const wxPoint& pt) const,
1401 "Converts to screen coordinates from coordinates relative to this window.", "");
1404 wxPoint , ScreenToClient(const wxPoint& pt) const,
1405 "Converts from screen to client window coordinates.", "");
1410 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1411 "Test where the given (in client coords) point lies", "",
1415 wxHitTest , HitTest(const wxPoint& pt) const,
1416 "Test where the given (in client coords) point lies", "");
1424 %nokwargs GetBorder;
1426 wxBorder , GetBorder(long flags) const,
1427 "Get the window border style from the given flags: this is different
1428 from simply doing flags & wxBORDER_MASK because it uses
1429 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1434 wxBorder , GetBorder() const,
1435 "Get border for the flags of this window", "");
1441 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1442 "This function sends EVT_UPDATE_UI events to the window. The particular
1443 implementation depends on the window; for example a wx.ToolBar will
1444 send an update UI event for each toolbar button, and a wx.Frame will
1445 send an update UI event for each menubar menu item. You can call this
1446 function from your application to ensure that your UI is up-to-date at
1447 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1448 concerned). This may be necessary if you have called
1449 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
1450 limit the overhead that wxWindows incurs by sending update UI events
1453 The flags should be a bitlist of one or more of the following values:
1455 ===================== ==============================
1456 wx.UPDATE_UI_NONE No particular value
1457 wx.UPDATE_UI_RECURSE Call the function for descendants
1458 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1459 ===================== ==============================
1461 If you are calling this function from an OnIdle function, make sure
1462 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1463 to only update the UI elements that need to be updated in idle
1464 time. Some windows update their elements only when necessary, for
1465 example when a menu is about to be shown. The following is an example
1466 of how to call UpdateWindowUI from an idle function::
1468 def OnIdle(self, evt):
1469 if wx.UpdateUIEvent.CanUpdate(self):
1470 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1474 // TODO: using directors?
1475 // // do the window-specific processing after processing the update event
1476 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1480 "Pops up the given menu at the specified coordinates, relative to this window,
1481 and returns control when the user has dismissed the menu. If a menu item is
1482 selected, the corresponding menu event is generated and will be processed as
1483 usual. If the default position is given then the current position of the
1484 mouse cursor will be used.", "");
1485 %name(PopupMenuXY) bool PopupMenu(wxMenu *menu, int x=-1, int y=-1);
1486 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1493 "Returns the platform-specific handle (as a long integer) of the
1494 physical window. Currently on wxMac it returns the handle of the
1495 toplevel parent of the window.", "");
1497 return wxPyGetWinHandle(self);
1504 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1505 void OnPaint(wxPaintEvent& event);
1515 bool , HasScrollbar(int orient) const,
1516 "Does the window have the scrollbar for this orientation?", "");
1519 // configure the window scrollbars
1521 virtual void , SetScrollbar( int orientation,
1525 bool refresh = True ),
1526 "Sets the scrollbar properties of a built-in scrollbar.",
1528 :param orientation: Determines the scrollbar whose page size is to
1529 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1531 :param position: The position of the scrollbar in scroll units.
1533 :param thumbSize: The size of the thumb, or visible portion of the
1534 scrollbar, in scroll units.
1536 :param range: The maximum position of the scrollbar.
1538 :param refresh: True to redraw the scrollbar, false otherwise.
1542 virtual void , SetScrollPos( int orientation, int pos, bool refresh = True ),
1543 "Sets the position of one of the built-in scrollbars.", "");
1546 virtual int , GetScrollPos( int orientation ) const,
1547 "Returns the built-in scrollbar position.", "");
1550 virtual int , GetScrollThumb( int orientation ) const,
1551 "Returns the built-in scrollbar thumb size.", "");
1554 virtual int , GetScrollRange( int orientation ) const,
1555 "Returns the built-in scrollbar range.", "");
1561 virtual void , ScrollWindow( int dx, int dy,
1562 const wxRect* rect = NULL ),
1563 "Physically scrolls the pixels in the window and move child windows
1564 accordingly. Use this function to optimise your scrolling
1565 implementations, to minimise the area that must be redrawn. Note that
1566 it is rarely required to call this function from a user program.",
1568 :param dx: Amount to scroll horizontally.
1570 :param dy: Amount to scroll vertically.
1572 :param rect: Rectangle to invalidate. If this is None, the whole
1573 window is invalidated. If you pass a rectangle corresponding
1574 to the area of the window exposed by the scroll, your
1575 painting handler can optimize painting by checking for the
1576 invalidated region.");
1580 virtual bool , ScrollLines(int lines),
1581 "If the platform and window class supports it, scrolls the window by
1582 the given number of lines down, if lines is positive, or up if lines
1583 is negative. Returns True if the window was scrolled, False if it was
1584 already on top/bottom and nothing was done.", "");
1587 virtual bool , ScrollPages(int pages),
1588 "If the platform and window class supports it, scrolls the window by
1589 the given number of pages down, if pages is positive, or up if pages
1590 is negative. Returns True if the window was scrolled, False if it was
1591 already on top/bottom and nothing was done.", "");
1596 "This is just a wrapper for ScrollLines(-1).", "");
1600 "This is just a wrapper for ScrollLines(1).", "");
1604 "This is just a wrapper for ScrollPages(-1).", "");
1608 "This is just a wrapper for ScrollPages(1).", "");
1613 // context-sensitive help
1614 // ----------------------
1617 void , SetHelpText(const wxString& text),
1618 "Sets the help text to be used as context-sensitive help for this
1619 window. Note that the text is actually stored by the current
1620 wxHelpProvider implementation, and not in the window object itself.", "");
1624 void , SetHelpTextForId(const wxString& text),
1625 "Associate this help text with all windows with the same id as this
1630 wxString , GetHelpText() const,
1631 "Gets the help text to be used as context-sensitive help for this
1632 window. Note that the text is actually stored by the current
1633 wxHelpProvider implementation, and not in the window object itself.", "");
1642 "Attach a tooltip to the window.", "");
1643 %name(SetToolTipString) void SetToolTip( const wxString &tip );
1644 void SetToolTip( wxToolTip *tip );
1647 wxToolTip* , GetToolTip() const,
1648 "get the associated tooltip or None if none", "");
1650 // LINK ERROR --> wxString GetToolTipText() const;
1659 // set/retrieve the drop target associated with this window (may be
1660 // NULL; it's owned by the window and will be deleted by it)
1661 %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
1664 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1665 "Associates a drop target with this window. If the window already has
1666 a drop target, it is deleted.", "");
1668 %clear wxPyDropTarget *dropTarget;
1672 virtual wxPyDropTarget *, GetDropTarget() const,
1673 "Returns the associated drop target, which may be None.", "");
1676 #ifdef __WXMSW__ // TODO: should I drop-kick this?
1678 void , DragAcceptFiles(bool accept),
1679 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1680 Only available on Windows.", "");
1685 // constraints and sizers
1686 // ----------------------
1688 // set the constraints for this window or retrieve them (may be NULL)
1690 void , SetConstraints( wxLayoutConstraints *constraints ),
1691 "Sets the window to have the given layout constraints. If an existing
1692 layout constraints object is already owned by the window, it will be
1693 deleted. Pass None to disassociate and delete the window's current
1696 You must call SetAutoLayout to tell a window to use the constraints
1697 automatically in its default EVT_SIZE handler; otherwise, you must
1698 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1699 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1703 wxLayoutConstraints *, GetConstraints() const,
1704 "Returns a pointer to the window's layout constraints, or None if there
1709 void , SetAutoLayout( bool autoLayout ),
1710 "Determines whether the Layout function will be called automatically
1711 when the window is resized. It is called implicitly by SetSizer but
1712 if you use SetConstraints you should call it manually or otherwise the
1713 window layout won't be correctly updated when its size changes.", "");
1716 bool , GetAutoLayout() const,
1717 "Returns the current autoLayout setting", "");
1721 virtual bool , Layout(),
1722 "Invokes the constraint-based layout algorithm or the sizer-based
1723 algorithm for this window. See SetAutoLayout: when auto layout is on,
1724 this function gets called automatically by the default EVT_SIZE
1725 handler when the window is resized.", "");
1729 void , SetSizer(wxSizer *sizer, bool deleteOld = True ),
1730 "Sets the window to have the given layout sizer. The window will then
1731 own the object, and will take care of its deletion. If an existing
1732 layout sizer object is already owned by the window, it will be deleted
1733 if the deleteOld parameter is true. Note that this function will also
1734 call SetAutoLayout implicitly with a True parameter if the sizer is
1735 non-NoneL and False otherwise.", "");
1738 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = True ),
1739 "The same as SetSizer, except it also sets the size hints for the
1740 window based on the sizer's minimum size.", "");
1744 wxSizer *, GetSizer() const,
1745 "Return the sizer associated with the window by a previous call to
1746 SetSizer or None if there isn't one.", "");
1749 // Track if this window is a member of a sizer
1751 void , SetContainingSizer(wxSizer* sizer),
1752 "This normally does not need to be called by application code. It is
1753 called internally when a window is added to a sizer, and is used so
1754 the window can remove itself from the sizer when it is destroyed.", "");
1757 wxSizer *, GetContainingSizer() const,
1758 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1764 // ----------------------
1765 #if wxUSE_ACCESSIBILITY
1766 // Override to create a specific accessible object.
1767 virtual wxAccessible* CreateAccessible();
1769 // Sets the accessible object.
1770 void SetAccessible(wxAccessible* accessible) ;
1772 // Returns the accessible object.
1773 wxAccessible* GetAccessible() { return m_accessible; };
1775 // Returns the accessible object, creating if necessary.
1776 wxAccessible* GetOrCreateAccessible() ;
1783 virtual void , InheritAttributes(),
1784 "This function is (or should be, in case of custom controls) called
1785 during window creation to intelligently set up the window visual
1786 attributes, that is the font and the foreground and background
1789 By 'intelligently' the following is meant: by default, all windows use
1790 their own default attributes. However if some of the parent's
1791 attributes are explicitly changed (that is, using SetFont and not
1792 SetDefaultFont) and if the corresponding attribute hadn't been
1793 explicitly set for this window itself, then this window takes the same
1794 value as used by the parent. In addition, if the window overrides
1795 ShouldInheritColours to return false, the colours will not be changed
1796 no matter what and only the font might.
1798 This rather complicated logic is necessary in order to accomodate the
1799 different usage scenarius. The most common one is when all default
1800 attributes are used and in this case, nothing should be inherited as
1801 in modern GUIs different controls use different fonts (and colours)
1802 than their siblings so they can't inherit the same value from the
1803 parent. However it was also deemed desirable to allow to simply change
1804 the attributes of all children at once by just changing the font or
1805 colour of their common parent, hence in this case we do inherit the
1810 // TODO: Virtualize this with directors
1812 virtual bool , ShouldInheritColours() const,
1813 "Return true from here to allow the colours of this window to be
1814 changed by InheritAttributes, returning false forbids inheriting them
1815 from the parent window.
1817 The base class version returns false, but this method is overridden in
1818 wxControl where it returns true.", "");
1823 def PostCreate(self, pre):
1825 Phase 3 of the 2-phase create <wink!>
1826 Call this method after precreating the window with the 2-phase create method.
1828 self.this = pre.this
1829 self.thisown = pre.thisown
1831 if hasattr(self, '_setOORInfo'):
1832 self._setOORInfo(self)
1833 if hasattr(self, '_setCallbackInfo'):
1834 self._setCallbackInfo(self, self.__class__)
1846 def DLG_PNT(win, point_or_x, y=None):
1848 Convenience function for converting a Point or (x,y) in
1849 dialog units to pixel units.
1852 return win.ConvertDialogPointToPixels(point_or_x)
1854 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
1856 def DLG_SZE(win, size_width, height=None):
1858 Convenience function for converting a Size or (w,h) in
1859 dialog units to pixel units.
1862 return win.ConvertDialogSizeToPixels(size_width)
1864 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
1870 // Unfortunatly the names of these new static methods clash with the
1871 // names wxPython has been using forever for the overloaded
1872 // wxWindow::FindWindow, so instead of swigging them as statics create
1873 // standalone functions for them.
1876 DocStr(wxFindWindowById,
1877 "Find the first window in the application with the given id. If parent
1878 is None, the search will start from all top-level frames and dialog
1879 boxes; if non-None, the search will be limited to the given window
1880 hierarchy. The search is recursive in both cases.", "");
1882 DocStr(wxFindWindowByName,
1883 "Find a window by its name (as given in a window constructor or Create
1884 function call). If parent is None, the search will start from all
1885 top-level frames and dialog boxes; if non-None, the search will be
1886 limited to the given window hierarchy. The search is recursive in both
1889 If no window with such name is found, wx.FindWindowByLabel is called.", "");
1891 DocStr(wxFindWindowByLabel,
1892 "Find a window by its label. Depending on the type of window, the label
1893 may be a window title or panel item label. If parent is None, the
1894 search will start from all top-level frames and dialog boxes; if
1895 non-None, the search will be limited to the given window
1896 hierarchy. The search is recursive in both cases.", "");
1899 MustHaveApp(wxFindWindowById);
1900 MustHaveApp(wxFindWindowByName);
1901 MustHaveApp(wxFindWindowByLabel);
1904 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
1905 return wxWindow::FindWindowById(id, parent);
1908 wxWindow* wxFindWindowByName( const wxString& name,
1909 const wxWindow *parent = NULL ) {
1910 return wxWindow::FindWindowByName(name, parent);
1913 wxWindow* wxFindWindowByLabel( const wxString& label,
1914 const wxWindow *parent = NULL ) {
1915 return wxWindow::FindWindowByLabel(label, parent);
1923 #include <wx/msw/private.h> // to get wxGetWindowId
1928 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
1930 WXHWND hWnd = (WXHWND)_hWnd;
1931 long id = wxGetWindowId(hWnd);
1932 wxWindow* win = new wxWindow;
1933 parent->AddChild(win);
1934 win->SetEventHandler(win);
1937 win->SubclassWin(hWnd);
1938 win->AdoptAttributesFromHWND();
1939 win->SetupColours();
1942 wxPyRaiseNotImplemented();
1948 //---------------------------------------------------------------------------
1949 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob