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() ""
204 wxWindow(wxWindow* parent, const wxWindowID id=-1,
205 const wxPoint& pos = wxDefaultPosition,
206 const wxSize& size = wxDefaultSize,
208 const wxString& name = wxPyPanelNameStr),
209 "Construct and show a generic Window.", "");
213 "Precreate a Window for 2-phase creation.", "",
218 bool , Create(wxWindow* parent, const wxWindowID id=-1,
219 const wxPoint& pos = wxDefaultPosition,
220 const wxSize& size = wxDefaultSize,
222 const wxString& name = wxPyPanelNameStr),
223 "Create the GUI part of the Window for 2-phase creation mode.", "");
226 // deleting the window
227 // -------------------
231 bool , Close( bool force = False ),
232 "This function simply generates a EVT_CLOSE event whose handler usually
233 tries to close the window. It doesn't close the window itself,
234 however. If force is False (the default) then the window's close
235 handler will be allowed to veto the destruction of the window.",
237 Usually Close is only used with the top level windows (wx.Frame and
238 wx.Dialog classes) as the others are not supposed to have any special
241 The close handler should check whether the window is being deleted
242 forcibly, using wx.CloseEvent.GetForce, in which case it should
243 destroy the window using wx.Window.Destroy.
245 Note that calling Close does not guarantee that the window will be
246 destroyed; but it provides a way to simulate a manual close of a
247 window, which may or may not be implemented by destroying the
248 window. The default EVT_CLOSE handler for wx.Dialog does not
249 necessarily delete the dialog, since it will simply simulate an
250 wxID_CANCEL event which is handled by the appropriate button event
251 handler and may do anything at all.
253 To guarantee that the window will be destroyed, call wx.Window.Destroy
259 virtual bool , Destroy(),
260 "Destroys the window safely. Frames and dialogs are not destroyed
261 immediately when this function is called -- they are added to a list
262 of windows to be deleted on idle time, when all the window's events
263 have been processed. This prevents problems with events being sent to
264 non-existent windows.
266 Returns True if the window has either been successfully deleted, or it
267 has been added to the list of windows pending real deletion.", "");
271 bool , DestroyChildren(),
272 "Destroys all children of a window. Called automatically by the
277 bool , IsBeingDeleted() const,
278 "Is the window in the process of being deleted?", "");
286 virtual void , SetTitle( const wxString& title),
287 "Sets the window's title. Applicable only to frames and dialogs.", "");
290 virtual wxString , GetTitle() const,
291 "Gets the window's title. Applicable only to frames and dialogs.", "");
295 virtual void , SetLabel(const wxString& label),
296 "Set the text which the window shows in its label if applicable.", "");
299 virtual wxString , GetLabel() const,
300 "Generic way of getting a label from any window, for identification
301 purposes. The interpretation of this function differs from class to
302 class. For frames and dialogs, the value returned is the title. For
303 buttons or static text controls, it is the button text. This function
304 can be useful for meta-programs such as testing tools or special-needs
305 access programs)which need to identify windows by name.", "");
309 virtual void , SetName( const wxString &name ),
310 "Sets the window's name. The window name is used for ressource setting
311 in X, it is not the same as the window title/label", "");
314 virtual wxString , GetName() const,
315 "Returns the windows name. This name is not guaranteed to be unique;
316 it is up to the programmer to supply an appropriate name in the window
317 constructor or via wx.Window.SetName.", "");
321 void , SetWindowVariant( wxWindowVariant variant ),
322 "Sets the variant of the window/font size to use for this window, if
323 the platform supports variants, for example, wxMac.",
327 ======================== =======================================
328 wx.WINDOW_VARIANT_NORMAL Normal size
329 wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
330 wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
331 wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
332 ======================== =======================================
336 wxWindowVariant , GetWindowVariant() const,
341 void , SetId( wxWindowID winid ),
342 "Sets the identifier of the window. Each window has an integer
343 identifier. If the application has not provided one, an identifier
344 will be generated. Normally, the identifier should be provided on
345 creation and should not be modified subsequently.", "");
348 wxWindowID , GetId() const,
349 "Returns the identifier of the window. Each window has an integer
350 identifier. If the application has not provided one (or the default Id
351 -1 is used) then an unique identifier with a negative value will be
356 static int , NewControlId(),
357 "Generate a control id for the controls which were not given one.", "");
361 static int , NextControlId(int winid),
362 "Get the id of the control following the one with the given
363 autogenerated) id", "");
367 static int , PrevControlId(int winid),
368 "Get the id of the control preceding the one with the given
369 autogenerated) id", "");
379 void , SetSize( const wxSize& size ),
380 "Sets the size of the window in pixels.", "");
384 void , SetSize( int x, int y, int width, int height,
385 int sizeFlags = wxSIZE_AUTO ),
386 "Sets the position and size of the window in pixels. The sizeFlags
387 parameter indicates the interpretation of the other params if they are
388 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
389 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
390 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
391 dimensions of -1 and less to be interpreted as real dimensions, not
392 default values.", "",
397 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
398 "Sets the position and size of the window in pixels using a wx.Rect.", "",
403 void , SetSize( int width, int height ),
404 "Sets the size of the window in pixels.", "",
409 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
410 "Moves the window to the given position.", "");
412 %pythoncode { SetPosition = Move }
416 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
417 "Moves the window to the given position.", "",
421 void , SetBestFittingSize(const wxSize& size=wxDefaultSize),
422 "A 'Smart' SetSize that will fill in default size components with the
423 window's *best size* values. Also set's the minsize for use with sizers.", "");
428 virtual void , Raise(),
429 "Raises the window to the top of the window hierarchy if it is a
430 managed window (dialog or frame).", "");
433 virtual void , Lower(),
434 "Lowers the window to the bottom of the window hierarchy if it is a
435 managed window (dialog or frame).", "");
439 // client size is the size of the area available for subwindows
440 DocStr(SetClientSize,
441 "This sets the size of the window client area in pixels. Using this
442 function to size a window tends to be more device-independent than
443 wx.Window.SetSize, since the application need not worry about what
444 dimensions the border or title bar have when trying to fit the window
445 around panel items, for example.", "");
446 void SetClientSize( const wxSize& size );
447 %name(SetClientSizeWH) void SetClientSize( int width, int height );
448 %name(SetClientRect) void SetClientSize(const wxRect& rect);
451 DocStr(GetPosition, // sets the docstring for both
452 "Get the window's position.", "");
453 wxPoint GetPosition();
456 void, GetPosition(int *OUTPUT, int *OUTPUT),
457 "GetPositionTuple() -> (x,y)",
461 DocStr(GetSize, "Get the window size.", "");
462 wxSize GetSize() const;
464 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
465 "GetSizeTuple() -> (width, height)",
471 wxRect , GetRect() const,
472 "Returns the size and position of the window as a wx.Rect object.", "");
475 DocStr(GetClientSize,
476 "This gets the size of the window's 'client area' in pixels. The client
477 area is the area which may be drawn on by the programmer, excluding
478 title bar, border, scrollbars, etc.", "");
479 wxSize GetClientSize() const;
481 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
482 "GetClientSizeTuple() -> (width, height)",
488 virtual wxPoint , GetClientAreaOrigin() const,
489 "Get the origin of the client area of the window relative to the
490 window's top left corner (the client area may be shifted because of
491 the borders, scrollbars, other decorations...)", "");
495 wxRect , GetClientRect() const,
496 "Get the client area position and size as a `wx.Rect` object.", "");
501 "This function returns the best acceptable minimal size for the
502 window, if applicable. For example, for a static text control, it will
503 be the minimal size such that the control label is not truncated. For
504 windows containing subwindows (suzh aswx.Panel), the size returned by
505 this function will be the same as the size the window would have had
506 after calling Fit.", "");
507 wxSize GetBestSize() const;
509 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
510 "GetBestSizeTuple() -> (width, height)",
515 void , InvalidateBestSize(),
516 "Reset the cached best size value so it will be recalculated the next
517 time it is needed.", "");
522 wxSize , GetBestFittingSize() const,
523 "This function will merge the window's best size into the window's
524 minimum size, giving priority to the min size components, and returns
530 wxSize , GetAdjustedBestSize() const,
531 "This method is similar to GetBestSize, except in one
532 thing. GetBestSize should return the minimum untruncated size of the
533 window, while this method will return the largest of BestSize and any
534 user specified minimum size. ie. it is the minimum size the window
535 should currently be drawn at, not the minimal size it can possibly
542 void , Center( int direction = wxBOTH ),
543 "Centers the window. The parameter specifies the direction for
544 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
545 also include wx.CENTER_ON_SCREEN flag if you want to center the window
546 on the entire screen and not on its parent window. If it is a
547 top-level window and has no parent then it will always be centered
548 relative to the screen.", "");
550 %pythoncode { Centre = Center }
554 void , CenterOnScreen(int dir = wxBOTH),
555 "Center on screen (only works for top level windows)", "");
556 %pythoncode { CentreOnScreen = CenterOnScreen }
560 void , CenterOnParent(int dir = wxBOTH),
561 "Center with respect to the the parent window", "");
562 %pythoncode { CentreOnParent = CenterOnParent }
567 virtual void , Fit(),
568 "Sizes the window so that it fits around its subwindows. This function
569 won't do anything if there are no subwindows and will only really work
570 correctly if sizers are used for the subwindows layout. Also, if the
571 window has exactly one subwindow it is better (faster and the result
572 is more precise as Fit adds some margin to account for fuzziness of
573 its calculations) to call window.SetClientSize(child.GetSize())
574 instead of calling Fit.", "");
578 virtual void , FitInside(),
579 "Similar to Fit, but sizes the interior (virtual) size of a
580 window. Mainly useful with scrolled windows to reset scrollbars after
581 sizing changes that do not trigger a size event, and/or scrolled
582 windows without an interior sizer. This function similarly won't do
583 anything if there are no subwindows.", "");
587 %nokwargs SetSizeHints;
589 "Allows specification of minimum and maximum window sizes, and window
590 size increments. If a pair of values is not set (or set to -1), the
591 default values will be used. If this function is called, the user
592 will not be able to size the window outside the given bounds (if it is
593 a top-level window.) Sizers will also inspect the minimum window size
594 and will use that value if set when calculating layout.
596 The resizing increments are only significant under Motif or Xt.", "
598 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
600 void SetSizeHints( const wxSize& minSize,
601 const wxSize& maxSize=wxDefaultSize,
602 const wxSize& incSize=wxDefaultSize);
603 virtual void SetSizeHints( int minW, int minH,
604 int maxW = -1, int maxH = -1,
605 int incW = -1, int incH = -1 );
608 %nokwargs SetVirtualSizeHints;
609 DocStr(SetVirtualSizeHints,
610 "Allows specification of minimum and maximum virtual window sizes. If a
611 pair of values is not set (or set to -1), the default values will be
612 used. If this function is called, the user will not be able to size
613 the virtual area of the window outside the given bounds.", "");
614 void SetVirtualSizeHints( const wxSize& minSize,
615 const wxSize& maxSize=wxDefaultSize);
616 virtual void SetVirtualSizeHints( int minW, int minH,
617 int maxW = -1, int maxH = -1 );
620 virtual wxSize , GetMaxSize() const,
624 virtual wxSize , GetMinSize() const,
628 void , SetMinSize(const wxSize& minSize),
629 "A more convenient method than `SetSizeHints` for setting just the
633 void , SetMaxSize(const wxSize& maxSize),
634 "A more convenient method than `SetSizeHints` for setting just the
640 virtual int , GetMinWidth() const,
644 virtual int , GetMinHeight() const,
648 int , GetMaxWidth() const,
652 int , GetMaxHeight() const,
657 DocStr(SetVirtualSize,
658 "Set the the virtual size of a window in pixels. For most windows this
659 is just the client area of the window, but for some like scrolled
660 windows it is more or less independent of the screen window size.", "");
661 void SetVirtualSize(const wxSize& size );
662 %name(SetVirtualSizeWH) void SetVirtualSize( int w, int h );
665 DocStr(GetVirtualSize,
666 "Get the the virtual size of the window in pixels. For most windows
667 this is just the client area of the window, but for some like scrolled
668 windows it is more or less independent of the screen window size.", "");
669 wxSize GetVirtualSize() const;
671 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
672 "GetVirtualSizeTuple() -> (width, height)",
673 GetVirtualSizeTuple);
676 // TODO: using directors?
677 // // Override these methods for windows that have a virtual size
678 // // independent of their client size. eg. the virtual area of a
679 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
680 // virtual void DoSetVirtualSize( int x, int y );
681 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
685 virtual wxSize , GetBestVirtualSize() const,
686 "Return the largest of ClientSize and BestSize (as determined by a
687 sizer, interior children, or other means)", "");
695 virtual bool , Show( bool show = True ),
696 "Shows or hides the window. You may need to call Raise for a top level
697 window if you want to bring it to top, although this is not needed if
698 Show is called immediately after the frame creation. Returns True if
699 the window has been shown or hidden or False if nothing was done
700 because it already was in the requested state.", "");
704 "Equivalent to calling Show(False).", "");
708 virtual bool , Enable( bool enable = True ),
709 "Enable or disable the window for user input. Note that when a parent
710 window is disabled, all of its children are disabled as well and they
711 are reenabled again when the parent is. Returns true if the window
712 has been enabled or disabled, false if nothing was done, i.e. if the
713 window had already been in the specified state.", "");
717 "Disables the window, same as Enable(false).", "");
721 bool , IsShown() const,
722 "Returns true if the window is shown, false if it has been hidden.", "");
725 bool , IsEnabled() const,
726 "Returns true if the window is enabled for input, false otherwise.", "");
732 virtual void , SetWindowStyleFlag( long style ),
733 "Sets the style of the window. Please note that some styles cannot be
734 changed after the window creation and that Refresh() might need to be
735 called after changing the others for the change to take place
739 virtual long , GetWindowStyleFlag() const,
740 "Gets the window style that was passed to the constructor or Create
743 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
747 bool , HasFlag(int flag) const,
748 "Test if the given style is set for this window.", "");
752 virtual bool , IsRetained() const,
753 "Returns true if the window is retained, false otherwise. Retained
754 windows are only available on X platforms.", "");
759 virtual void , SetExtraStyle(long exStyle),
760 "Sets the extra style bits for the window. Extra styles are the less
761 often used style bits which can't be set with the constructor or with
762 SetWindowStyleFlag()", "");
765 long , GetExtraStyle() const,
766 "Returns the extra style bits for the window.", "");
771 virtual void , MakeModal(bool modal = True),
772 "Disables all other windows in the application so that the user can
773 only interact with this window. Passing False will reverse this
779 virtual void , SetThemeEnabled(bool enableTheme),
780 "This function tells a window if it should use the system's \"theme\"
781 code to draw the windows' background instead if its own background
782 drawing code. This will only have an effect on platforms that support
783 the notion of themes in user defined windows. One such platform is
784 GTK+ where windows can have (very colourful) backgrounds defined by a
785 user's selected theme.
787 Dialogs, notebook pages and the status bar have this flag set to true
788 by default so that the default look and feel is simulated best.", "");
791 virtual bool , GetThemeEnabled() const,
792 "Return the themeEnabled flag.", "");
795 // TODO with directors
796 // // controls by default inherit the colours of their parents, if a
797 // // particular control class doesn't want to do it, it can override
798 // // ShouldInheritColours() to return False
799 // virtual bool ShouldInheritColours() const;
805 // focus and keyboard handling
806 // ---------------------------
810 virtual void , SetFocus(),
811 "Set's the focus to this window, allowing it to receive keyboard input.", "");
814 virtual void , SetFocusFromKbd(),
815 "Set focus to this window as the result of a keyboard action. Normally
816 only called internally.", "");
821 static wxWindow *, FindFocus(),
822 "Returns the window or control that currently has the keyboard focus,
827 virtual bool , AcceptsFocus() const,
828 "Can this window have focus?", "");
832 virtual bool , AcceptsFocusFromKeyboard() const,
833 "Can this window be given focus by keyboard navigation? if not, the
834 only way to give it focus (provided it accepts it at all) is to click
841 virtual wxWindow *, GetDefaultItem() const,
842 "Get the default child of this parent, i.e. the one which is activated
843 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
846 virtual wxWindow *, SetDefaultItem(wxWindow * child),
847 "Set this child as default, return the old default.", "");
850 virtual void , SetTmpDefaultItem(wxWindow * win),
851 "Set this child as temporary default", "");
855 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
856 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
857 "Does keyboard navigation from this window to another, by sending a
858 `wx.NavigationKeyEvent`.", "
860 :param flags: A combination of the ``IsForward`` and ``WinChange``
861 values in the `wx.NavigationKeyEvent` class, which determine
862 if the navigation should be in forward or reverse order, and
863 if it should be able to cross parent window boundaries, such
864 as between notebook pages or MDI child frames. Typically the
865 status of the Shift key (for forward or reverse) or the
866 Control key (for WinChange) would be used to determine how to
869 One situation in which you may wish to call this method is from a text
870 control custom keypress handler to do the default navigation behaviour
871 for the tab key, since the standard default behaviour for a multiline
872 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
873 not navigate to the next control.");
879 // parent/children relations
880 // -------------------------
883 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
886 "Returns a list of the window's children. NOTE: Currently this is a
887 copy of the child window list maintained by the window, so the return
888 value of this function is only valid as long as the window's children
889 do not change.", "");
890 PyObject* GetChildren() {
891 wxWindowList& list = self->GetChildren();
892 return wxPy_ConvertList(&list);
897 wxWindow *, GetParent() const,
898 "Returns the parent window of this window, or None if there isn't one.", "");
901 wxWindow *, GetGrandParent() const,
902 "Returns the parent of the parent of this window, or None if there
908 virtual bool , IsTopLevel() const,
909 "Returns true if the given window is a top-level one. Currently all
910 frames and dialogs are always considered to be top-level windows (even
911 if they have a parent window).", "");
914 // change the real parent of this window, return True if the parent
915 // was changed, False otherwise (error or newParent == oldParent)
917 virtual bool , Reparent( wxWindow *newParent ),
918 "Reparents the window, i.e the window will be removed from its current
919 parent window (e.g. a non-standard toolbar in a wxFrame) and then
920 re-inserted into another. Available on Windows and GTK. Returns True
921 if the parent was changed, False otherwise (error or newParent ==
926 virtual void , AddChild( wxWindow *child ),
927 "Adds a child window. This is called automatically by window creation
928 functions so should not be required by the application programmer.", "");
931 virtual void , RemoveChild( wxWindow *child ),
932 "Removes a child window. This is called automatically by window
933 deletion functions so should not be required by the application
939 // looking for windows
940 // -------------------
943 wxWindow *, FindWindow( long winid ),
944 "Find a chld of this window by window ID", "",
948 wxWindow *, FindWindow( const wxString& name ),
949 "Find a child of this window by name", "",
954 // event handler stuff
955 // -------------------
958 wxEvtHandler *, GetEventHandler() const,
959 "Returns the event handler for this window. By default, the window is
960 its own event handler.", "");
964 void , SetEventHandler( wxEvtHandler *handler ),
965 "Sets the event handler for this window. An event handler is an object
966 that is capable of processing the events sent to a window. By default,
967 the window is its own event handler, but an application may wish to
968 substitute another, for example to allow central implementation of
969 event-handling for a variety of different window classes.
971 It is usually better to use `wx.Window.PushEventHandler` since this sets
972 up a chain of event handlers, where an event not handled by one event
973 handler is handed to the next one in the chain.", "");
977 void , PushEventHandler( wxEvtHandler *handler ),
978 "Pushes this event handler onto the event handler stack for the window.
979 An event handler is an object that is capable of processing the events
980 sent to a window. By default, the window is its own event handler, but
981 an application may wish to substitute another, for example to allow
982 central implementation of event-handling for a variety of different
985 wx.Window.PushEventHandler allows an application to set up a chain of
986 event handlers, where an event not handled by one event handler is
987 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
988 remove the event handler.", "");
992 wxEvtHandler *, PopEventHandler( bool deleteHandler = False ),
993 "Removes and returns the top-most event handler on the event handler
994 stack. If deleteHandler is True then the wx.EvtHandler object will be
995 destroyed after it is popped.", "");
999 bool , RemoveEventHandler(wxEvtHandler *handler),
1000 "Find the given handler in the event handler chain and remove (but not
1001 delete) it from the event handler chain, return True if it was found
1002 and False otherwise (this also results in an assert failure so this
1003 function should only be called when the handler is supposed to be
1012 // a window may have an associated validator which is used to control
1015 virtual void , SetValidator( const wxValidator &validator ),
1016 "Deletes the current validator (if any) and sets the window validator,
1017 having called wx.Validator.Clone to create a new validator of this
1021 virtual wxValidator *, GetValidator(),
1022 "Returns a pointer to the current validator for the window, or None if
1023 there is none.", "");
1027 virtual bool , Validate(),
1028 "Validates the current values of the child controls using their
1029 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1030 style flag set, the method will also call Validate() of all child
1031 windows. Returns false if any of the validations failed.", "");
1035 virtual bool , TransferDataToWindow(),
1036 "Transfers values to child controls from data areas specified by their
1037 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1038 style flag set, the method will also call TransferDataToWindow() of
1039 all child windows.", "");
1042 virtual bool , TransferDataFromWindow(),
1043 "Transfers values from child controls to data areas specified by their
1044 validators. Returns false if a transfer failed. If the window has
1045 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1046 also call TransferDataFromWindow() of all child windows.", "");
1050 virtual void , InitDialog(),
1051 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1052 to the dialog via validators.", "");
1061 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1062 "Sets the accelerator table for this window.", "");
1065 wxAcceleratorTable *, GetAcceleratorTable(),
1066 "Gets the accelerator table for this window.", "");
1072 // hot keys (system wide accelerators)
1073 // -----------------------------------
1075 DocStr(RegisterHotKey,
1076 "Registers a system wide hotkey. Every time the user presses the hotkey
1077 registered here, this window will receive a hotkey event. It will
1078 receive the event even if the application is in the background and
1079 does not have the input focus because the user is working with some
1080 other application. To bind an event handler function to this hotkey
1081 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1082 hotkey was registered successfully.", "");
1083 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1085 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1092 DocStr(UnregisterHotKey,
1093 "Unregisters a system wide hotkey.", "");
1094 bool UnregisterHotKey(int hotkeyId) {
1096 return self->UnregisterHotKey(hotkeyId);
1105 // "dialog units" translations
1106 // ---------------------------
1108 DocStr(ConvertDialogToPixels,
1109 "Converts a point or size from dialog units to pixels. Dialog units
1110 are used for maintaining a dialog's proportions even if the font
1111 changes. For the x dimension, the dialog units are multiplied by the
1112 average character width and then divided by 4. For the y dimension,
1113 the dialog units are multiplied by the average character height and
1114 then divided by 8.", "");
1115 %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
1116 %name(ConvertDialogSizeToPixels) wxSize ConvertDialogToPixels(const wxSize& sz);
1117 %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
1118 %name(DLG_SZE) wxSize ConvertDialogToPixels(const wxSize& sz);
1121 DocStr(ConvertPixelPointToDialog,
1122 "Converts a point or size from pixels to dialog units. Dialog units
1123 are used for maintaining a dialog's proportions even if the font
1124 changes. For the x dimension, the dialog units are multiplied by the
1125 average character width and then divided by 4. For the y dimension,
1126 the dialog units are multiplied by the average character height and
1127 then divided by 8.", "");
1128 %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
1129 %name(ConvertPixelSizeToDialog) wxSize ConvertPixelsToDialog(const wxSize& sz);
1137 virtual void , WarpPointer(int x, int y),
1138 "Moves the pointer to the given position on the window.
1140 NOTE: This function is not supported under Mac because Apple Human
1141 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1145 void , CaptureMouse(),
1146 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1147 release the capture.
1149 Note that wxWindows maintains the stack of windows having captured the
1150 mouse and when the mouse is released the capture returns to the window
1151 which had had captured it previously and it is only really released if
1152 there were no previous window. In particular, this means that you must
1153 release the mouse as many times as you capture it.", "");
1156 void , ReleaseMouse(),
1157 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1161 static wxWindow *, GetCapture(),
1162 "Returns the window which currently captures the mouse or None", "");
1166 virtual bool , HasCapture() const,
1167 "Returns true if this window has the current mouse capture.", "");
1173 // painting the window
1174 // -------------------
1177 virtual void , Refresh( bool eraseBackground = True,
1178 const wxRect *rect = NULL ),
1179 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1180 will be repainted. Causes an EVT_PAINT event to be generated and sent
1181 to the window.", "");
1185 void , RefreshRect(const wxRect& rect),
1186 "Redraws the contents of the given rectangle: the area inside it will
1187 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1191 virtual void , Update(),
1192 "Calling this method immediately repaints the invalidated area of the
1193 window instead of waiting for the EVT_PAINT event to happen, (normally
1194 this would usually only happen when the flow of control returns to the
1195 event loop.) Notice that this function doesn't refresh the window and
1196 does nothing if the window has been already repainted. Use Refresh
1197 first if you want to immediately redraw the window (or some portion of
1198 it) unconditionally.", "");
1202 virtual void , ClearBackground(),
1203 "Clears the window by filling it with the current background
1204 colour. Does not cause an erase background event to be generated.", "");
1209 virtual void , Freeze(),
1210 "Freezes the window or, in other words, prevents any updates from
1211 taking place on screen, the window is not redrawn at all. Thaw must be
1212 called to reenable window redrawing. Calls to Freeze/Thaw may be
1213 nested, with the actual Thaw being delayed until all the nesting has
1216 This method is useful for visual appearance optimization (for example,
1217 it is a good idea to use it before inserting large amount of text into
1218 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1219 for all controls so it is mostly just a hint to wxWindows and not a
1220 mandatory directive.", "");
1224 virtual void , Thaw(),
1225 "Reenables window updating after a previous call to Freeze. Calls to
1226 Freeze/Thaw may be nested, so Thaw must be called the same number of
1227 times that Freeze was before the window will be updated.", "");
1231 virtual void , PrepareDC( wxDC & dc ),
1232 "Call this function to prepare the device context for drawing a
1233 scrolled image. It sets the device origin according to the current
1234 scroll position.", "");
1238 wxRegion& , GetUpdateRegion(),
1239 "Returns the region specifying which parts of the window have been
1240 damaged. Should only be called within an EVT_PAINT handler.", "");
1244 wxRect , GetUpdateClientRect() const,
1245 "Get the update rectangle region bounding box in client coords.", "");
1249 "Returns true if the given point or rectangle area has been exposed
1250 since the last repaint. Call this in an paint event handler to
1251 optimize redrawing by only redrawing those areas, which have been
1253 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1254 %name(IsExposedPoint) bool IsExposed( const wxPoint& pt ) const;
1255 %name(IsExposedRect) bool IsExposed( const wxRect& rect ) const;
1259 // colours, fonts and cursors
1260 // --------------------------
1264 virtual wxVisualAttributes , GetDefaultAttributes() const,
1265 "Get the default attributes for an instance of this class. This is
1266 useful if you want to use the same font or colour in your own control
1267 as in a standard control -- which is a much better idea than hard
1268 coding specific colours or fonts which might look completely out of
1269 place on the user's system, especially if it uses themes.", "");
1273 static wxVisualAttributes ,
1274 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1275 "Get the default attributes for this class. This is useful if you want
1276 to use the same font or colour in your own control as in a standard
1277 control -- which is a much better idea than hard coding specific
1278 colours or fonts which might look completely out of place on the
1279 user's system, especially if it uses themes.
1281 The variant parameter is only relevant under Mac currently and is
1282 ignore under other platforms. Under Mac, it will change the size of
1283 the returned font. See `wx.Window.SetWindowVariant` for more about
1288 virtual bool , SetBackgroundColour( const wxColour &colour ),
1289 "Sets the background colour of the window. Returns True if the colour
1290 was changed. The background colour is usually painted by the default
1291 EVT_ERASE_BACKGROUND event handler function under Windows and
1292 automatically under GTK. Using `wx.NullColour` will reset the window
1293 to the default background colour.
1295 Note that setting the background colour may not cause an immediate
1296 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1297 calling this function.
1299 Using this function will disable attempts to use themes for this
1300 window, if the system supports them. Use with care since usually the
1301 themes represent the appearance chosen by the user to be used for all
1302 applications on the system.", "");
1305 void , SetOwnBackgroundColour(const wxColour& colour),
1311 virtual bool , SetForegroundColour( const wxColour &colour ),
1312 "Sets the foreground colour of the window. Returns True is the colour
1313 was changed. The interpretation of foreground colour is dependent on
1314 the window class; it may be the text colour or other colour, or it may
1315 not be used at all.", "");
1318 void , SetOwnForegroundColour(const wxColour& colour),
1324 wxColour , GetBackgroundColour() const,
1325 "Returns the background colour of the window.", "");
1328 wxColour , GetForegroundColour() const,
1329 "Returns the foreground colour of the window. The interpretation of
1330 foreground colour is dependent on the window class; it may be the text
1331 colour or other colour, or it may not be used at all.", "");
1337 virtual bool , SetCursor( const wxCursor &cursor ),
1338 "Sets the window's cursor. Notice that the window cursor also sets it
1339 for the children of the window implicitly.
1341 The cursor may be wx.NullCursor in which case the window cursor will
1342 be reset back to default.", "");
1345 wxCursor , GetCursor(),
1346 "Return the cursor associated with this window.", "");
1351 virtual bool , SetFont( const wxFont &font ),
1352 "Sets the font for this window.", "");
1355 void , SetOwnFont(const wxFont& font),
1362 "Returns the default font used for this window.", "");
1367 void , SetCaret(wxCaret *caret),
1368 "Sets the caret associated with the window.", "");
1371 wxCaret *, GetCaret() const,
1372 "Returns the caret associated with the window.", "");
1377 virtual int , GetCharHeight() const,
1378 "Get the (average) character size for the current font.", "");
1381 virtual int , GetCharWidth() const,
1382 "Get the (average) character size for the current font.", "");
1387 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1388 "GetTextExtent(String string) -> (width, height)",
1389 "Get the width and height of the text using the current font.", "");
1391 void, GetTextExtent(const wxString& string,
1392 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1393 const wxFont* font = NULL),
1394 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1395 "Get the width, height, decent and leading of the text using the
1396 current or specified font.", "",
1401 // client <-> screen coords
1402 // ------------------------
1404 %apply int * INOUT { int* x, int* y };
1406 // translate to/from screen/client coordinates
1408 void , ClientToScreen( int *x, int *y ) const,
1409 "ClientToScreenXY(int x, int y) -> (x,y)",
1410 "Converts to screen coordinates from coordinates relative to this window.", "",
1414 void , ScreenToClient( int *x, int *y ) const,
1415 "ScreenToClientXY(int x, int y) -> (x,y)",
1416 "Converts from screen to client window coordinates.", "",
1421 wxPoint , ClientToScreen(const wxPoint& pt) const,
1422 "Converts to screen coordinates from coordinates relative to this window.", "");
1425 wxPoint , ScreenToClient(const wxPoint& pt) const,
1426 "Converts from screen to client window coordinates.", "");
1431 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1432 "Test where the given (in client coords) point lies", "",
1436 wxHitTest , HitTest(const wxPoint& pt) const,
1437 "Test where the given (in client coords) point lies", "");
1445 %nokwargs GetBorder;
1447 wxBorder , GetBorder(long flags) const,
1448 "Get the window border style from the given flags: this is different
1449 from simply doing flags & wxBORDER_MASK because it uses
1450 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1455 wxBorder , GetBorder() const,
1456 "Get border for the flags of this window", "");
1462 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1463 "This function sends EVT_UPDATE_UI events to the window. The particular
1464 implementation depends on the window; for example a wx.ToolBar will
1465 send an update UI event for each toolbar button, and a wx.Frame will
1466 send an update UI event for each menubar menu item. You can call this
1467 function from your application to ensure that your UI is up-to-date at
1468 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1469 concerned). This may be necessary if you have called
1470 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
1471 limit the overhead that wxWindows incurs by sending update UI events
1474 The flags should be a bitlist of one or more of the following values:
1476 ===================== ==============================
1477 wx.UPDATE_UI_NONE No particular value
1478 wx.UPDATE_UI_RECURSE Call the function for descendants
1479 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1480 ===================== ==============================
1482 If you are calling this function from an OnIdle function, make sure
1483 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1484 to only update the UI elements that need to be updated in idle
1485 time. Some windows update their elements only when necessary, for
1486 example when a menu is about to be shown. The following is an example
1487 of how to call UpdateWindowUI from an idle function::
1489 def OnIdle(self, evt):
1490 if wx.UpdateUIEvent.CanUpdate(self):
1491 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1495 // TODO: using directors?
1496 // // do the window-specific processing after processing the update event
1497 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1501 "Pops up the given menu at the specified coordinates, relative to this window,
1502 and returns control when the user has dismissed the menu. If a menu item is
1503 selected, the corresponding menu event is generated and will be processed as
1504 usual. If the default position is given then the current position of the
1505 mouse cursor will be used.", "");
1506 %name(PopupMenuXY) bool PopupMenu(wxMenu *menu, int x=-1, int y=-1);
1507 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1514 "Returns the platform-specific handle (as a long integer) of the
1515 physical window. Currently on wxMac it returns the handle of the
1516 toplevel parent of the window.", "");
1518 return wxPyGetWinHandle(self);
1525 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1526 void OnPaint(wxPaintEvent& event);
1536 bool , HasScrollbar(int orient) const,
1537 "Does the window have the scrollbar for this orientation?", "");
1540 // configure the window scrollbars
1542 virtual void , SetScrollbar( int orientation,
1546 bool refresh = True ),
1547 "Sets the scrollbar properties of a built-in scrollbar.",
1549 :param orientation: Determines the scrollbar whose page size is to
1550 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1552 :param position: The position of the scrollbar in scroll units.
1554 :param thumbSize: The size of the thumb, or visible portion of the
1555 scrollbar, in scroll units.
1557 :param range: The maximum position of the scrollbar.
1559 :param refresh: True to redraw the scrollbar, false otherwise.
1563 virtual void , SetScrollPos( int orientation, int pos, bool refresh = True ),
1564 "Sets the position of one of the built-in scrollbars.", "");
1567 virtual int , GetScrollPos( int orientation ) const,
1568 "Returns the built-in scrollbar position.", "");
1571 virtual int , GetScrollThumb( int orientation ) const,
1572 "Returns the built-in scrollbar thumb size.", "");
1575 virtual int , GetScrollRange( int orientation ) const,
1576 "Returns the built-in scrollbar range.", "");
1582 virtual void , ScrollWindow( int dx, int dy,
1583 const wxRect* rect = NULL ),
1584 "Physically scrolls the pixels in the window and move child windows
1585 accordingly. Use this function to optimise your scrolling
1586 implementations, to minimise the area that must be redrawn. Note that
1587 it is rarely required to call this function from a user program.",
1589 :param dx: Amount to scroll horizontally.
1591 :param dy: Amount to scroll vertically.
1593 :param rect: Rectangle to invalidate. If this is None, the whole
1594 window is invalidated. If you pass a rectangle corresponding
1595 to the area of the window exposed by the scroll, your
1596 painting handler can optimize painting by checking for the
1597 invalidated region.");
1601 virtual bool , ScrollLines(int lines),
1602 "If the platform and window class supports it, scrolls the window by
1603 the given number of lines down, if lines is positive, or up if lines
1604 is negative. Returns True if the window was scrolled, False if it was
1605 already on top/bottom and nothing was done.", "");
1608 virtual bool , ScrollPages(int pages),
1609 "If the platform and window class supports it, scrolls the window by
1610 the given number of pages down, if pages is positive, or up if pages
1611 is negative. Returns True if the window was scrolled, False if it was
1612 already on top/bottom and nothing was done.", "");
1617 "This is just a wrapper for ScrollLines(-1).", "");
1621 "This is just a wrapper for ScrollLines(1).", "");
1625 "This is just a wrapper for ScrollPages(-1).", "");
1629 "This is just a wrapper for ScrollPages(1).", "");
1634 // context-sensitive help
1635 // ----------------------
1638 void , SetHelpText(const wxString& text),
1639 "Sets the help text to be used as context-sensitive help for this
1640 window. Note that the text is actually stored by the current
1641 wxHelpProvider implementation, and not in the window object itself.", "");
1645 void , SetHelpTextForId(const wxString& text),
1646 "Associate this help text with all windows with the same id as this
1651 wxString , GetHelpText() const,
1652 "Gets the help text to be used as context-sensitive help for this
1653 window. Note that the text is actually stored by the current
1654 wxHelpProvider implementation, and not in the window object itself.", "");
1663 "Attach a tooltip to the window.", "");
1664 %name(SetToolTipString) void SetToolTip( const wxString &tip );
1665 void SetToolTip( wxToolTip *tip );
1668 wxToolTip* , GetToolTip() const,
1669 "get the associated tooltip or None if none", "");
1671 // LINK ERROR --> wxString GetToolTipText() const;
1680 // set/retrieve the drop target associated with this window (may be
1681 // NULL; it's owned by the window and will be deleted by it)
1682 %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
1685 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1686 "Associates a drop target with this window. If the window already has
1687 a drop target, it is deleted.", "");
1689 %clear wxPyDropTarget *dropTarget;
1693 virtual wxPyDropTarget *, GetDropTarget() const,
1694 "Returns the associated drop target, which may be None.", "");
1697 #ifdef __WXMSW__ // TODO: should I drop-kick this?
1699 void , DragAcceptFiles(bool accept),
1700 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1701 Only available on Windows.", "");
1706 // constraints and sizers
1707 // ----------------------
1709 // set the constraints for this window or retrieve them (may be NULL)
1711 void , SetConstraints( wxLayoutConstraints *constraints ),
1712 "Sets the window to have the given layout constraints. If an existing
1713 layout constraints object is already owned by the window, it will be
1714 deleted. Pass None to disassociate and delete the window's current
1717 You must call SetAutoLayout to tell a window to use the constraints
1718 automatically in its default EVT_SIZE handler; otherwise, you must
1719 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1720 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1724 wxLayoutConstraints *, GetConstraints() const,
1725 "Returns a pointer to the window's layout constraints, or None if there
1730 void , SetAutoLayout( bool autoLayout ),
1731 "Determines whether the Layout function will be called automatically
1732 when the window is resized. It is called implicitly by SetSizer but
1733 if you use SetConstraints you should call it manually or otherwise the
1734 window layout won't be correctly updated when its size changes.", "");
1737 bool , GetAutoLayout() const,
1738 "Returns the current autoLayout setting", "");
1742 virtual bool , Layout(),
1743 "Invokes the constraint-based layout algorithm or the sizer-based
1744 algorithm for this window. See SetAutoLayout: when auto layout is on,
1745 this function gets called automatically by the default EVT_SIZE
1746 handler when the window is resized.", "");
1750 void , SetSizer(wxSizer *sizer, bool deleteOld = True ),
1751 "Sets the window to have the given layout sizer. The window will then
1752 own the object, and will take care of its deletion. If an existing
1753 layout sizer object is already owned by the window, it will be deleted
1754 if the deleteOld parameter is true. Note that this function will also
1755 call SetAutoLayout implicitly with a True parameter if the sizer is
1756 non-NoneL and False otherwise.", "");
1759 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = True ),
1760 "The same as SetSizer, except it also sets the size hints for the
1761 window based on the sizer's minimum size.", "");
1765 wxSizer *, GetSizer() const,
1766 "Return the sizer associated with the window by a previous call to
1767 SetSizer or None if there isn't one.", "");
1770 // Track if this window is a member of a sizer
1772 void , SetContainingSizer(wxSizer* sizer),
1773 "This normally does not need to be called by application code. It is
1774 called internally when a window is added to a sizer, and is used so
1775 the window can remove itself from the sizer when it is destroyed.", "");
1778 wxSizer *, GetContainingSizer() const,
1779 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1785 // ----------------------
1786 #if wxUSE_ACCESSIBILITY
1787 // Override to create a specific accessible object.
1788 virtual wxAccessible* CreateAccessible();
1790 // Sets the accessible object.
1791 void SetAccessible(wxAccessible* accessible) ;
1793 // Returns the accessible object.
1794 wxAccessible* GetAccessible() { return m_accessible; };
1796 // Returns the accessible object, creating if necessary.
1797 wxAccessible* GetOrCreateAccessible() ;
1804 virtual void , InheritAttributes(),
1805 "This function is (or should be, in case of custom controls) called
1806 during window creation to intelligently set up the window visual
1807 attributes, that is the font and the foreground and background
1810 By 'intelligently' the following is meant: by default, all windows use
1811 their own default attributes. However if some of the parent's
1812 attributes are explicitly changed (that is, using SetFont and not
1813 SetOwnFont) and if the corresponding attribute hadn't been
1814 explicitly set for this window itself, then this window takes the same
1815 value as used by the parent. In addition, if the window overrides
1816 ShouldInheritColours to return false, the colours will not be changed
1817 no matter what and only the font might.
1819 This rather complicated logic is necessary in order to accomodate the
1820 different usage scenarius. The most common one is when all default
1821 attributes are used and in this case, nothing should be inherited as
1822 in modern GUIs different controls use different fonts (and colours)
1823 than their siblings so they can't inherit the same value from the
1824 parent. However it was also deemed desirable to allow to simply change
1825 the attributes of all children at once by just changing the font or
1826 colour of their common parent, hence in this case we do inherit the
1831 // TODO: Virtualize this with directors
1833 virtual bool , ShouldInheritColours() const,
1834 "Return true from here to allow the colours of this window to be
1835 changed by InheritAttributes, returning false forbids inheriting them
1836 from the parent window.
1838 The base class version returns false, but this method is overridden in
1839 wxControl where it returns true.", "");
1844 def PostCreate(self, pre):
1846 Phase 3 of the 2-phase create <wink!>
1847 Call this method after precreating the window with the 2-phase create method.
1849 self.this = pre.this
1850 self.thisown = pre.thisown
1852 if hasattr(self, '_setOORInfo'):
1853 self._setOORInfo(self)
1854 if hasattr(self, '_setCallbackInfo'):
1855 self._setCallbackInfo(self, self.__class__)
1867 def DLG_PNT(win, point_or_x, y=None):
1869 Convenience function for converting a Point or (x,y) in
1870 dialog units to pixel units.
1873 return win.ConvertDialogPointToPixels(point_or_x)
1875 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
1877 def DLG_SZE(win, size_width, height=None):
1879 Convenience function for converting a Size or (w,h) in
1880 dialog units to pixel units.
1883 return win.ConvertDialogSizeToPixels(size_width)
1885 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
1891 // Unfortunatly the names of these new static methods clash with the
1892 // names wxPython has been using forever for the overloaded
1893 // wxWindow::FindWindow, so instead of swigging them as statics create
1894 // standalone functions for them.
1897 DocStr(wxFindWindowById,
1898 "Find the first window in the application with the given id. If parent
1899 is None, the search will start from all top-level frames and dialog
1900 boxes; if non-None, the search will be limited to the given window
1901 hierarchy. The search is recursive in both cases.", "");
1903 DocStr(wxFindWindowByName,
1904 "Find a window by its name (as given in a window constructor or Create
1905 function call). If parent is None, the search will start from all
1906 top-level frames and dialog boxes; if non-None, the search will be
1907 limited to the given window hierarchy. The search is recursive in both
1910 If no window with such name is found, wx.FindWindowByLabel is called.", "");
1912 DocStr(wxFindWindowByLabel,
1913 "Find a window by its label. Depending on the type of window, the label
1914 may be a window title or panel item label. If parent is None, the
1915 search will start from all top-level frames and dialog boxes; if
1916 non-None, the search will be limited to the given window
1917 hierarchy. The search is recursive in both cases.", "");
1920 MustHaveApp(wxFindWindowById);
1921 MustHaveApp(wxFindWindowByName);
1922 MustHaveApp(wxFindWindowByLabel);
1925 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
1926 return wxWindow::FindWindowById(id, parent);
1929 wxWindow* wxFindWindowByName( const wxString& name,
1930 const wxWindow *parent = NULL ) {
1931 return wxWindow::FindWindowByName(name, parent);
1934 wxWindow* wxFindWindowByLabel( const wxString& label,
1935 const wxWindow *parent = NULL ) {
1936 return wxWindow::FindWindowByLabel(label, parent);
1944 #include <wx/msw/private.h> // to get wxGetWindowId
1949 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
1951 WXHWND hWnd = (WXHWND)_hWnd;
1952 long id = wxGetWindowId(hWnd);
1953 wxWindow* win = new wxWindow;
1954 parent->AddChild(win);
1955 win->SetEventHandler(win);
1958 win->SubclassWin(hWnd);
1959 win->AdoptAttributesFromHWND();
1960 win->SetupColours();
1963 wxPyRaiseNotImplemented();
1969 //---------------------------------------------------------------------------
1970 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob