1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: SWIG interface for wxWindow
7 // Created: 24-June-1997
9 // Copyright: (c) 2003 by Total Control Software
10 // Licence: wxWindows license
11 /////////////////////////////////////////////////////////////////////////////
16 //---------------------------------------------------------------------------
21 MAKE_CONST_WXSTRING(PanelNameStr);
23 //---------------------------------------------------------------------------
27 DocStr(wxVisualAttributes,
28 "struct containing all the visual attributes of a control", "");
30 struct wxVisualAttributes
33 wxVisualAttributes() { return new wxVisualAttributes; }
34 ~wxVisualAttributes() { delete self; }
37 // the font used for control label/text inside it
40 // the foreground colour
43 // the background colour, may be wxNullColour if the controls background
44 // colour is not solid
53 wxWINDOW_VARIANT_NORMAL, // Normal size
54 wxWINDOW_VARIANT_SMALL, // Smaller size (about 25 % smaller than normal )
55 wxWINDOW_VARIANT_MINI, // Mini size (about 33 % smaller than normal )
56 wxWINDOW_VARIANT_LARGE, // Large size (about 25 % larger than normal )
62 "wx.Window is the base class for all windows and represents any visible
63 object on the screen. All controls, top level windows and so on are
64 wx.Windows. Sizers and device contexts are not however, as they don't
65 appear on screen themselves.
70 ============================= =====================================
71 wx.SIMPLE_BORDER Displays a thin border around the window.
73 wx.DOUBLE_BORDER Displays a double border. Windows and Mac only.
75 wx.SUNKEN_BORDER Displays a sunken border.
77 wx.RAISED_BORDER Displays a raised border.
79 wx.STATIC_BORDER Displays a border suitable for a static
80 control. Windows only.
82 wx.NO_BORDER Displays no border, overriding the default
83 border style for the window.
85 wx.TRANSPARENT_WINDOW The window is transparent, that is, it
86 will not receive paint events. Windows only.
88 wx.TAB_TRAVERSAL Use this to enable tab traversal for
91 wx.WANTS_CHARS Use this to indicate that the window
92 wants to get all char/key events for
93 all keys - even for keys like TAB or
94 ENTER which are usually used for
95 dialog navigation and which wouldn't
96 be generated without this style. If
97 you need to use this style in order to
98 get the arrows or etc., but would
99 still like to have normal keyboard
100 navigation take place, you should
101 create and send a wxNavigationKeyEvent
102 in response to the key events for Tab
105 wx.NO_FULL_REPAINT_ON_RESIZE Disables repainting the window
106 completely when its size is changed.
107 You will have to repaint the new
108 window area manually if you use this
109 style. As of version 2.5.1 this
110 style is on by default. Use
111 wx.FULL_REPAINT_ON_RESIZE to
114 wx.VSCROLL Use this style to enable a vertical scrollbar.
116 wx.HSCROLL Use this style to enable a horizontal scrollbar.
118 wx.ALWAYS_SHOW_SB If a window has scrollbars, disable them
119 instead of hiding them when they are
120 not needed (i.e. when the size of the
121 window is big enough to not require
122 the scrollbars to navigate it). This
123 style is currently only implemented
124 for wxMSW and wxUniversal and does
125 nothing on the other platforms.
127 wx.CLIP_CHILDREN Use this style to eliminate flicker caused by
128 the background being repainted, then
129 children being painted over
132 wx.FULL_REPAINT_ON_RESIZE Use this style to force a complete
133 redraw of the window whenever it is
134 resized instead of redrawing just the
135 part of the window affected by
136 resizing. Note that this was the
137 behaviour by default before 2.5.1
138 release and that if you experience
139 redraw problems with the code which
140 previously used to work you may want
142 ============================= =====================================
147 ============================= =====================================
148 wx.WS_EX_VALIDATE_RECURSIVELY By default,
149 Validate/TransferDataTo/FromWindow()
150 only work on direct children of
151 the window (compatible
152 behaviour). Set this flag to make
153 them recursively descend into all
156 wx.WS_EX_BLOCK_EVENTS wx.CommandEvents and the objects of the
157 derived classes are forwarded to
158 the parent window and so on
159 recursively by default. Using this
160 flag for the given window allows
161 to block this propagation at this
162 window, i.e. prevent the events
163 from being propagated further
164 upwards. Dialogs have this flag on
167 wx.WS_EX_TRANSIENT Don't use this window as an implicit parent for
168 the other windows: this must be
169 used with transient windows as
170 otherwise there is the risk of
171 creating a dialog/frame with this
172 window as a parent which would
173 lead to a crash if the parent is
174 destroyed before the child.
176 wx.WS_EX_PROCESS_IDLE This window should always process idle
177 events, even if the mode set by
178 wx.IdleEvent.SetMode is
179 wx.IDLE_PROCESS_SPECIFIED.
181 wx.WS_EX_PROCESS_UI_UPDATES This window should always process UI
182 update events, even if the mode
183 set by wxUpdateUIEvent::SetMode is
184 wxUPDATE_UI_PROCESS_SPECIFIED.
185 ============================= =====================================
190 MustHaveApp(wxWindow);
191 MustHaveApp(wxWindow::FindFocus);
192 MustHaveApp(wxWindow::GetCapture);
194 // This one is not restricted to wxWindow
195 MustHaveApp(GetClassDefaultAttributes);
197 class wxWindow : public wxEvtHandler
200 %pythonAppend wxWindow "self._setOORInfo(self)"
201 %pythonAppend wxWindow() ""
202 %typemap(out) wxWindow*; // turn off this typemap
205 wxWindow(wxWindow* parent, const wxWindowID id=-1,
206 const wxPoint& pos = wxDefaultPosition,
207 const wxSize& size = wxDefaultSize,
209 const wxString& name = wxPyPanelNameStr),
210 "Construct and show a generic Window.", "");
214 "Precreate a Window for 2-phase creation.", "",
217 // Turn it back on again
218 %typemap(out) wxWindow* { $result = wxPyMake_wxObject($1, $owner); }
222 bool , Create(wxWindow* parent, const wxWindowID id=-1,
223 const wxPoint& pos = wxDefaultPosition,
224 const wxSize& size = wxDefaultSize,
226 const wxString& name = wxPyPanelNameStr),
227 "Create the GUI part of the Window for 2-phase creation mode.", "");
230 // deleting the window
231 // -------------------
235 bool , Close( bool force = false ),
236 "This function simply generates a EVT_CLOSE event whose handler usually
237 tries to close the window. It doesn't close the window itself,
238 however. If force is False (the default) then the window's close
239 handler will be allowed to veto the destruction of the window.",
241 Usually Close is only used with the top level windows (wx.Frame and
242 wx.Dialog classes) as the others are not supposed to have any special
245 The close handler should check whether the window is being deleted
246 forcibly, using wx.CloseEvent.GetForce, in which case it should
247 destroy the window using wx.Window.Destroy.
249 Note that calling Close does not guarantee that the window will be
250 destroyed; but it provides a way to simulate a manual close of a
251 window, which may or may not be implemented by destroying the
252 window. The default EVT_CLOSE handler for wx.Dialog does not
253 necessarily delete the dialog, since it will simply simulate an
254 wxID_CANCEL event which is handled by the appropriate button event
255 handler and may do anything at all.
257 To guarantee that the window will be destroyed, call wx.Window.Destroy
263 virtual bool , Destroy(),
264 "Destroys the window safely. Frames and dialogs are not destroyed
265 immediately when this function is called -- they are added to a list
266 of windows to be deleted on idle time, when all the window's events
267 have been processed. This prevents problems with events being sent to
268 non-existent windows.
270 Returns True if the window has either been successfully deleted, or it
271 has been added to the list of windows pending real deletion.", "");
275 bool , DestroyChildren(),
276 "Destroys all children of a window. Called automatically by the
281 bool , IsBeingDeleted() const,
282 "Is the window in the process of being deleted?", "");
290 virtual void , SetTitle( const wxString& title),
291 "Sets the window's title. Applicable only to frames and dialogs.", "");
294 virtual wxString , GetTitle() const,
295 "Gets the window's title. Applicable only to frames and dialogs.", "");
299 virtual void , SetLabel(const wxString& label),
300 "Set the text which the window shows in its label if applicable.", "");
303 virtual wxString , GetLabel() const,
304 "Generic way of getting a label from any window, for identification
305 purposes. The interpretation of this function differs from class to
306 class. For frames and dialogs, the value returned is the title. For
307 buttons or static text controls, it is the button text. This function
308 can be useful for meta-programs such as testing tools or special-needs
309 access programs)which need to identify windows by name.", "");
313 virtual void , SetName( const wxString &name ),
314 "Sets the window's name. The window name is used for ressource setting
315 in X, it is not the same as the window title/label", "");
318 virtual wxString , GetName() const,
319 "Returns the windows name. This name is not guaranteed to be unique;
320 it is up to the programmer to supply an appropriate name in the window
321 constructor or via wx.Window.SetName.", "");
325 void , SetWindowVariant( wxWindowVariant variant ),
326 "Sets the variant of the window/font size to use for this window, if
327 the platform supports variants, for example, wxMac.",
331 ======================== =======================================
332 wx.WINDOW_VARIANT_NORMAL Normal size
333 wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
334 wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
335 wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
336 ======================== =======================================
340 wxWindowVariant , GetWindowVariant() const,
345 void , SetId( wxWindowID winid ),
346 "Sets the identifier of the window. Each window has an integer
347 identifier. If the application has not provided one, an identifier
348 will be generated. Normally, the identifier should be provided on
349 creation and should not be modified subsequently.", "");
352 wxWindowID , GetId() const,
353 "Returns the identifier of the window. Each window has an integer
354 identifier. If the application has not provided one (or the default Id
355 -1 is used) then an unique identifier with a negative value will be
360 static int , NewControlId(),
361 "Generate a control id for the controls which were not given one.", "");
365 static int , NextControlId(int winid),
366 "Get the id of the control following the one with the given
367 autogenerated) id", "");
371 static int , PrevControlId(int winid),
372 "Get the id of the control preceding the one with the given
373 autogenerated) id", "");
383 void , SetSize( const wxSize& size ),
384 "Sets the size of the window in pixels.", "");
388 void , SetSize( int x, int y, int width, int height,
389 int sizeFlags = wxSIZE_AUTO ),
390 "Sets the position and size of the window in pixels. The sizeFlags
391 parameter indicates the interpretation of the other params if they are
392 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
393 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
394 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
395 dimensions of -1 and less to be interpreted as real dimensions, not
396 default values.", "",
401 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
402 "Sets the position and size of the window in pixels using a wx.Rect.", "",
407 void , SetSize( int width, int height ),
408 "Sets the size of the window in pixels.", "",
413 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
414 "Moves the window to the given position.", "");
416 %pythoncode { SetPosition = Move }
420 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
421 "Moves the window to the given position.", "",
425 void , SetBestFittingSize(const wxSize& size=wxDefaultSize),
426 "A 'Smart' SetSize that will fill in default size components with the
427 window's *best size* values. Also set's the minsize for use with sizers.", "");
432 virtual void , Raise(),
433 "Raises the window to the top of the window hierarchy if it is a
434 managed window (dialog or frame).", "");
437 virtual void , Lower(),
438 "Lowers the window to the bottom of the window hierarchy if it is a
439 managed window (dialog or frame).", "");
443 // client size is the size of the area available for subwindows
444 DocStr(SetClientSize,
445 "This sets the size of the window client area in pixels. Using this
446 function to size a window tends to be more device-independent than
447 wx.Window.SetSize, since the application need not worry about what
448 dimensions the border or title bar have when trying to fit the window
449 around panel items, for example.", "");
450 void SetClientSize( const wxSize& size );
451 %Rename(SetClientSizeWH, void, SetClientSize( int width, int height ));
452 %Rename(SetClientRect, void, SetClientSize(const wxRect& rect));
455 DocStr(GetPosition, // sets the docstring for both
456 "Get the window's position.", "");
457 wxPoint GetPosition();
460 void, GetPosition(int *OUTPUT, int *OUTPUT),
461 "GetPositionTuple() -> (x,y)",
465 DocStr(GetSize, "Get the window size.", "");
466 wxSize GetSize() const;
468 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
469 "GetSizeTuple() -> (width, height)",
475 wxRect , GetRect() const,
476 "Returns the size and position of the window as a wx.Rect object.", "");
479 DocStr(GetClientSize,
480 "This gets the size of the window's 'client area' in pixels. The client
481 area is the area which may be drawn on by the programmer, excluding
482 title bar, border, scrollbars, etc.", "");
483 wxSize GetClientSize() const;
485 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
486 "GetClientSizeTuple() -> (width, height)",
492 virtual wxPoint , GetClientAreaOrigin() const,
493 "Get the origin of the client area of the window relative to the
494 window's top left corner (the client area may be shifted because of
495 the borders, scrollbars, other decorations...)", "");
499 wxRect , GetClientRect() const,
500 "Get the client area position and size as a `wx.Rect` object.", "");
505 "This function returns the best acceptable minimal size for the
506 window, if applicable. For example, for a static text control, it will
507 be the minimal size such that the control label is not truncated. For
508 windows containing subwindows (suzh aswx.Panel), the size returned by
509 this function will be the same as the size the window would have had
510 after calling Fit.", "");
511 wxSize GetBestSize() const;
513 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
514 "GetBestSizeTuple() -> (width, height)",
519 void , InvalidateBestSize(),
520 "Reset the cached best size value so it will be recalculated the next
521 time it is needed.", "");
526 wxSize , GetBestFittingSize() const,
527 "This function will merge the window's best size into the window's
528 minimum size, giving priority to the min size components, and returns
534 wxSize , GetAdjustedBestSize() const,
535 "This method is similar to GetBestSize, except in one
536 thing. GetBestSize should return the minimum untruncated size of the
537 window, while this method will return the largest of BestSize and any
538 user specified minimum size. ie. it is the minimum size the window
539 should currently be drawn at, not the minimal size it can possibly
546 void , Center( int direction = wxBOTH ),
547 "Centers the window. The parameter specifies the direction for
548 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
549 also include wx.CENTER_ON_SCREEN flag if you want to center the window
550 on the entire screen and not on its parent window. If it is a
551 top-level window and has no parent then it will always be centered
552 relative to the screen.", "");
554 %pythoncode { Centre = Center }
558 void , CenterOnScreen(int dir = wxBOTH),
559 "Center on screen (only works for top level windows)", "");
560 %pythoncode { CentreOnScreen = CenterOnScreen }
564 void , CenterOnParent(int dir = wxBOTH),
565 "Center with respect to the the parent window", "");
566 %pythoncode { CentreOnParent = CenterOnParent }
571 virtual void , Fit(),
572 "Sizes the window so that it fits around its subwindows. This function
573 won't do anything if there are no subwindows and will only really work
574 correctly if sizers are used for the subwindows layout. Also, if the
575 window has exactly one subwindow it is better (faster and the result
576 is more precise as Fit adds some margin to account for fuzziness of
577 its calculations) to call window.SetClientSize(child.GetSize())
578 instead of calling Fit.", "");
582 virtual void , FitInside(),
583 "Similar to Fit, but sizes the interior (virtual) size of a
584 window. Mainly useful with scrolled windows to reset scrollbars after
585 sizing changes that do not trigger a size event, and/or scrolled
586 windows without an interior sizer. This function similarly won't do
587 anything if there are no subwindows.", "");
592 "Allows specification of minimum and maximum window sizes, and window
593 size increments. If a pair of values is not set (or set to -1), the
594 default values will be used. If this function is called, the user
595 will not be able to size the window outside the given bounds (if it is
596 a top-level window.) Sizers will also inspect the minimum window size
597 and will use that value if set when calculating layout.
599 The resizing increments are only significant under Motif or Xt.", "
601 :see: `GetMinSize`, `GetMaxSize`, `SetMinSize`, `SetMaxSize`
603 virtual void SetSizeHints( int minW, int minH,
604 int maxW = -1, int maxH = -1,
605 int incW = -1, int incH = -1 );
606 %Rename(SetSizeHintsSz, void, SetSizeHints( const wxSize& minSize,
607 const wxSize& maxSize=wxDefaultSize,
608 const wxSize& incSize=wxDefaultSize));
611 DocStr(SetVirtualSizeHints,
612 "Allows specification of minimum and maximum virtual window sizes. If a
613 pair of values is not set (or set to -1), the default values will be
614 used. If this function is called, the user will not be able to size
615 the virtual area of the window outside the given bounds.", "");
616 virtual void SetVirtualSizeHints( int minW, int minH,
617 int maxW = -1, int maxH = -1 );
618 %Rename(SetVirtualSizeHintsSz, void, SetVirtualSizeHints(
619 const wxSize& minSize, const wxSize& maxSize=wxDefaultSize));
624 virtual wxSize , GetMaxSize() const,
628 virtual wxSize , GetMinSize() const,
632 void , SetMinSize(const wxSize& minSize),
633 "A more convenient method than `SetSizeHints` for setting just the
637 void , SetMaxSize(const wxSize& maxSize),
638 "A more convenient method than `SetSizeHints` for setting just the
644 virtual int , GetMinWidth() const,
648 virtual int , GetMinHeight() const,
652 int , GetMaxWidth() const,
656 int , GetMaxHeight() const,
661 DocStr(SetVirtualSize,
662 "Set the the virtual size of a window in pixels. For most windows this
663 is just the client area of the window, but for some like scrolled
664 windows it is more or less independent of the screen window size.", "");
665 void SetVirtualSize(const wxSize& size );
666 %Rename(SetVirtualSizeWH, void, SetVirtualSize( int w, int h ));
669 DocStr(GetVirtualSize,
670 "Get the the virtual size of the window in pixels. For most windows
671 this is just the client area of the window, but for some like scrolled
672 windows it is more or less independent of the screen window size.", "");
673 wxSize GetVirtualSize() const;
675 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
676 "GetVirtualSizeTuple() -> (width, height)",
677 GetVirtualSizeTuple);
680 // TODO: using directors?
681 // // Override these methods for windows that have a virtual size
682 // // independent of their client size. eg. the virtual area of a
683 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
684 // virtual void DoSetVirtualSize( int x, int y );
685 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
689 virtual wxSize , GetBestVirtualSize() const,
690 "Return the largest of ClientSize and BestSize (as determined by a
691 sizer, interior children, or other means)", "");
699 virtual bool , Show( bool show = true ),
700 "Shows or hides the window. You may need to call Raise for a top level
701 window if you want to bring it to top, although this is not needed if
702 Show is called immediately after the frame creation. Returns True if
703 the window has been shown or hidden or False if nothing was done
704 because it already was in the requested state.", "");
708 "Equivalent to calling Show(False).", "");
712 virtual bool , Enable( bool enable = true ),
713 "Enable or disable the window for user input. Note that when a parent
714 window is disabled, all of its children are disabled as well and they
715 are reenabled again when the parent is. Returns true if the window
716 has been enabled or disabled, false if nothing was done, i.e. if the
717 window had already been in the specified state.", "");
721 "Disables the window, same as Enable(false).", "");
725 bool , IsShown() const,
726 "Returns true if the window is shown, false if it has been hidden.", "");
729 bool , IsEnabled() const,
730 "Returns true if the window is enabled for input, false otherwise.", "");
736 virtual void , SetWindowStyleFlag( long style ),
737 "Sets the style of the window. Please note that some styles cannot be
738 changed after the window creation and that Refresh() might need to be
739 called after changing the others for the change to take place
743 virtual long , GetWindowStyleFlag() const,
744 "Gets the window style that was passed to the constructor or Create
747 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
751 bool , HasFlag(int flag) const,
752 "Test if the given style is set for this window.", "");
756 virtual bool , IsRetained() const,
757 "Returns true if the window is retained, false otherwise. Retained
758 windows are only available on X platforms.", "");
763 virtual void , SetExtraStyle(long exStyle),
764 "Sets the extra style bits for the window. Extra styles are the less
765 often used style bits which can't be set with the constructor or with
766 SetWindowStyleFlag()", "");
769 long , GetExtraStyle() const,
770 "Returns the extra style bits for the window.", "");
775 virtual void , MakeModal(bool modal = true),
776 "Disables all other windows in the application so that the user can
777 only interact with this window. Passing False will reverse this
783 virtual void , SetThemeEnabled(bool enableTheme),
784 "This function tells a window if it should use the system's \"theme\"
785 code to draw the windows' background instead if its own background
786 drawing code. This will only have an effect on platforms that support
787 the notion of themes in user defined windows. One such platform is
788 GTK+ where windows can have (very colourful) backgrounds defined by a
789 user's selected theme.
791 Dialogs, notebook pages and the status bar have this flag set to true
792 by default so that the default look and feel is simulated best.", "");
795 virtual bool , GetThemeEnabled() const,
796 "Return the themeEnabled flag.", "");
799 // TODO with directors
800 // // controls by default inherit the colours of their parents, if a
801 // // particular control class doesn't want to do it, it can override
802 // // ShouldInheritColours() to return False
803 // virtual bool ShouldInheritColours() const;
809 // focus and keyboard handling
810 // ---------------------------
814 virtual void , SetFocus(),
815 "Set's the focus to this window, allowing it to receive keyboard input.", "");
818 virtual void , SetFocusFromKbd(),
819 "Set focus to this window as the result of a keyboard action. Normally
820 only called internally.", "");
825 static wxWindow *, FindFocus(),
826 "Returns the window or control that currently has the keyboard focus,
831 virtual bool , AcceptsFocus() const,
832 "Can this window have focus?", "");
836 virtual bool , AcceptsFocusFromKeyboard() const,
837 "Can this window be given focus by keyboard navigation? if not, the
838 only way to give it focus (provided it accepts it at all) is to click
845 virtual wxWindow *, GetDefaultItem() const,
846 "Get the default child of this parent, i.e. the one which is activated
847 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
850 virtual wxWindow *, SetDefaultItem(wxWindow * child),
851 "Set this child as default, return the old default.", "");
854 virtual void , SetTmpDefaultItem(wxWindow * win),
855 "Set this child as temporary default", "");
859 virtual bool , Navigate(int flags = wxNavigationKeyEvent::IsForward),
860 "Navigate(self, int flags=NavigationKeyEvent.IsForward) -> bool",
861 "Does keyboard navigation from this window to another, by sending a
862 `wx.NavigationKeyEvent`.", "
864 :param flags: A combination of the ``IsForward`` or ``IsBackward``
865 and the ``WinChange`` values in the `wx.NavigationKeyEvent`
866 class, which determine if the navigation should be in forward
867 or reverse order, and if it should be able to cross parent
868 window boundaries, such as between notebook pages or MDI child
869 frames. Typically the status of the Shift key (for forward or
870 backward) or the Control key (for WinChange) would be used to
871 determine how to set the flags.
873 One situation in which you may wish to call this method is from a text
874 control custom keypress handler to do the default navigation behaviour
875 for the tab key, since the standard default behaviour for a multiline
876 text control with the wx.TE_PROCESS_TAB style is to insert a tab and
877 not navigate to the next control.");
882 void , MoveAfterInTabOrder(wxWindow *win),
883 "Moves this window in the tab navigation order after the specified
884 sibling window. This means that when the user presses the TAB key on
885 that other window, the focus switches to this window.
887 The default tab order is the same as creation order. This function
888 and `MoveBeforeInTabOrder` allow to change it after creating all the
894 void , MoveBeforeInTabOrder(wxWindow *win),
895 "Same as `MoveAfterInTabOrder` except that it inserts this window just
896 before win instead of putting it right after it.", "");
905 // parent/children relations
906 // -------------------------
909 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
912 "Returns a list of the window's children. NOTE: Currently this is a
913 copy of the child window list maintained by the window, so the return
914 value of this function is only valid as long as the window's children
915 do not change.", "");
916 PyObject* GetChildren() {
917 wxWindowList& list = self->GetChildren();
918 return wxPy_ConvertList(&list);
923 wxWindow *, GetParent() const,
924 "Returns the parent window of this window, or None if there isn't one.", "");
927 wxWindow *, GetGrandParent() const,
928 "Returns the parent of the parent of this window, or None if there
934 virtual bool , IsTopLevel() const,
935 "Returns true if the given window is a top-level one. Currently all
936 frames and dialogs are always considered to be top-level windows (even
937 if they have a parent window).", "");
940 // change the real parent of this window, return True if the parent
941 // was changed, False otherwise (error or newParent == oldParent)
943 virtual bool , Reparent( wxWindow *newParent ),
944 "Reparents the window, i.e the window will be removed from its current
945 parent window (e.g. a non-standard toolbar in a wxFrame) and then
946 re-inserted into another. Available on Windows and GTK. Returns True
947 if the parent was changed, False otherwise (error or newParent ==
952 virtual void , AddChild( wxWindow *child ),
953 "Adds a child window. This is called automatically by window creation
954 functions so should not be required by the application programmer.", "");
957 virtual void , RemoveChild( wxWindow *child ),
958 "Removes a child window. This is called automatically by window
959 deletion functions so should not be required by the application
965 // looking for windows
966 // -------------------
969 wxWindow *, FindWindow( long winid ),
970 "Find a chld of this window by window ID", "",
974 wxWindow *, FindWindow( const wxString& name ),
975 "Find a child of this window by name", "",
980 // event handler stuff
981 // -------------------
984 wxEvtHandler *, GetEventHandler() const,
985 "Returns the event handler for this window. By default, the window is
986 its own event handler.", "");
990 void , SetEventHandler( wxEvtHandler *handler ),
991 "Sets the event handler for this window. An event handler is an object
992 that is capable of processing the events sent to a window. By default,
993 the window is its own event handler, but an application may wish to
994 substitute another, for example to allow central implementation of
995 event-handling for a variety of different window classes.
997 It is usually better to use `wx.Window.PushEventHandler` since this sets
998 up a chain of event handlers, where an event not handled by one event
999 handler is handed to the next one in the chain.", "");
1003 void , PushEventHandler( wxEvtHandler *handler ),
1004 "Pushes this event handler onto the event handler stack for the window.
1005 An event handler is an object that is capable of processing the events
1006 sent to a window. By default, the window is its own event handler, but
1007 an application may wish to substitute another, for example to allow
1008 central implementation of event-handling for a variety of different
1011 wx.Window.PushEventHandler allows an application to set up a chain of
1012 event handlers, where an event not handled by one event handler is
1013 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
1014 remove the event handler.", "");
1018 wxEvtHandler *, PopEventHandler( bool deleteHandler = false ),
1019 "Removes and returns the top-most event handler on the event handler
1020 stack. If deleteHandler is True then the wx.EvtHandler object will be
1021 destroyed after it is popped.", "");
1025 bool , RemoveEventHandler(wxEvtHandler *handler),
1026 "Find the given handler in the event handler chain and remove (but not
1027 delete) it from the event handler chain, return True if it was found
1028 and False otherwise (this also results in an assert failure so this
1029 function should only be called when the handler is supposed to be
1038 // a window may have an associated validator which is used to control
1041 virtual void , SetValidator( const wxValidator &validator ),
1042 "Deletes the current validator (if any) and sets the window validator,
1043 having called wx.Validator.Clone to create a new validator of this
1047 virtual wxValidator *, GetValidator(),
1048 "Returns a pointer to the current validator for the window, or None if
1049 there is none.", "");
1053 virtual bool , Validate(),
1054 "Validates the current values of the child controls using their
1055 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1056 style flag set, the method will also call Validate() of all child
1057 windows. Returns false if any of the validations failed.", "");
1061 virtual bool , TransferDataToWindow(),
1062 "Transfers values to child controls from data areas specified by their
1063 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
1064 style flag set, the method will also call TransferDataToWindow() of
1065 all child windows.", "");
1068 virtual bool , TransferDataFromWindow(),
1069 "Transfers values from child controls to data areas specified by their
1070 validators. Returns false if a transfer failed. If the window has
1071 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
1072 also call TransferDataFromWindow() of all child windows.", "");
1076 virtual void , InitDialog(),
1077 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
1078 to the dialog via validators.", "");
1087 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
1088 "Sets the accelerator table for this window.", "");
1091 wxAcceleratorTable *, GetAcceleratorTable(),
1092 "Gets the accelerator table for this window.", "");
1098 // hot keys (system wide accelerators)
1099 // -----------------------------------
1101 DocStr(RegisterHotKey,
1102 "Registers a system wide hotkey. Every time the user presses the hotkey
1103 registered here, this window will receive a hotkey event. It will
1104 receive the event even if the application is in the background and
1105 does not have the input focus because the user is working with some
1106 other application. To bind an event handler function to this hotkey
1107 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1108 hotkey was registered successfully.", "");
1109 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1111 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1118 DocStr(UnregisterHotKey,
1119 "Unregisters a system wide hotkey.", "");
1120 bool UnregisterHotKey(int hotkeyId) {
1122 return self->UnregisterHotKey(hotkeyId);
1131 // "dialog units" translations
1132 // ---------------------------
1134 DocStr(ConvertDialogToPixels,
1135 "Converts a point or size from dialog units to pixels. Dialog units
1136 are used for maintaining a dialog's proportions even if the font
1137 changes. For the x dimension, the dialog units are multiplied by the
1138 average character width and then divided by 4. For the y dimension,
1139 the dialog units are multiplied by the average character height and
1140 then divided by 8.", "");
1141 %Rename(ConvertDialogPointToPixels, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1142 %Rename(ConvertDialogSizeToPixels, wxSize, ConvertDialogToPixels(const wxSize& sz));
1143 %Rename(DLG_PNT, wxPoint, ConvertDialogToPixels(const wxPoint& pt));
1144 %Rename(DLG_SZE, wxSize, ConvertDialogToPixels(const wxSize& sz));
1147 DocStr(ConvertPixelPointToDialog,
1148 "Converts a point or size from pixels to dialog units. Dialog units
1149 are used for maintaining a dialog's proportions even if the font
1150 changes. For the x dimension, the dialog units are multiplied by the
1151 average character width and then divided by 4. For the y dimension,
1152 the dialog units are multiplied by the average character height and
1153 then divided by 8.", "");
1154 %Rename(ConvertPixelPointToDialog, wxPoint, ConvertPixelsToDialog(const wxPoint& pt));
1155 %Rename(ConvertPixelSizeToDialog, wxSize, ConvertPixelsToDialog(const wxSize& sz));
1163 virtual void , WarpPointer(int x, int y),
1164 "Moves the pointer to the given position on the window.
1166 NOTE: This function is not supported under Mac because Apple Human
1167 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1171 void , CaptureMouse(),
1172 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1173 release the capture.
1175 Note that wxWindows maintains the stack of windows having captured the
1176 mouse and when the mouse is released the capture returns to the window
1177 which had had captured it previously and it is only really released if
1178 there were no previous window. In particular, this means that you must
1179 release the mouse as many times as you capture it.", "");
1182 void , ReleaseMouse(),
1183 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1187 static wxWindow *, GetCapture(),
1188 "Returns the window which currently captures the mouse or None", "");
1192 virtual bool , HasCapture() const,
1193 "Returns true if this window has the current mouse capture.", "");
1199 // painting the window
1200 // -------------------
1203 virtual void , Refresh( bool eraseBackground = true,
1204 const wxRect *rect = NULL ),
1205 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1206 will be repainted. Causes an EVT_PAINT event to be generated and sent
1207 to the window.", "");
1211 void , RefreshRect(const wxRect& rect),
1212 "Redraws the contents of the given rectangle: the area inside it will
1213 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1217 virtual void , Update(),
1218 "Calling this method immediately repaints the invalidated area of the
1219 window instead of waiting for the EVT_PAINT event to happen, (normally
1220 this would usually only happen when the flow of control returns to the
1221 event loop.) Notice that this function doesn't refresh the window and
1222 does nothing if the window has been already repainted. Use Refresh
1223 first if you want to immediately redraw the window (or some portion of
1224 it) unconditionally.", "");
1228 virtual void , ClearBackground(),
1229 "Clears the window by filling it with the current background
1230 colour. Does not cause an erase background event to be generated.", "");
1235 virtual void , Freeze(),
1236 "Freezes the window or, in other words, prevents any updates from
1237 taking place on screen, the window is not redrawn at all. Thaw must be
1238 called to reenable window redrawing. Calls to Freeze/Thaw may be
1239 nested, with the actual Thaw being delayed until all the nesting has
1242 This method is useful for visual appearance optimization (for example,
1243 it is a good idea to use it before inserting large amount of text into
1244 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1245 for all controls so it is mostly just a hint to wxWindows and not a
1246 mandatory directive.", "");
1250 virtual void , Thaw(),
1251 "Reenables window updating after a previous call to Freeze. Calls to
1252 Freeze/Thaw may be nested, so Thaw must be called the same number of
1253 times that Freeze was before the window will be updated.", "");
1257 virtual void , PrepareDC( wxDC & dc ),
1258 "Call this function to prepare the device context for drawing a
1259 scrolled image. It sets the device origin according to the current
1260 scroll position.", "");
1264 wxRegion& , GetUpdateRegion(),
1265 "Returns the region specifying which parts of the window have been
1266 damaged. Should only be called within an EVT_PAINT handler.", "");
1270 wxRect , GetUpdateClientRect() const,
1271 "Get the update rectangle region bounding box in client coords.", "");
1275 "Returns true if the given point or rectangle area has been exposed
1276 since the last repaint. Call this in an paint event handler to
1277 optimize redrawing by only redrawing those areas, which have been
1279 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1280 %Rename(IsExposedPoint, bool, IsExposed( const wxPoint& pt ) const);
1281 %Rename(IsExposedRect, bool, IsExposed( const wxRect& rect ) const);
1285 // colours, fonts and cursors
1286 // --------------------------
1290 virtual wxVisualAttributes , GetDefaultAttributes() const,
1291 "Get the default attributes for an instance of this class. This is
1292 useful if you want to use the same font or colour in your own control
1293 as in a standard control -- which is a much better idea than hard
1294 coding specific colours or fonts which might look completely out of
1295 place on the user's system, especially if it uses themes.", "");
1299 static wxVisualAttributes ,
1300 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1301 "Get the default attributes for this class. This is useful if you want
1302 to use the same font or colour in your own control as in a standard
1303 control -- which is a much better idea than hard coding specific
1304 colours or fonts which might look completely out of place on the
1305 user's system, especially if it uses themes.
1307 The variant parameter is only relevant under Mac currently and is
1308 ignore under other platforms. Under Mac, it will change the size of
1309 the returned font. See `wx.Window.SetWindowVariant` for more about
1314 virtual bool , SetBackgroundColour( const wxColour &colour ),
1315 "Sets the background colour of the window. Returns True if the colour
1316 was changed. The background colour is usually painted by the default
1317 EVT_ERASE_BACKGROUND event handler function under Windows and
1318 automatically under GTK. Using `wx.NullColour` will reset the window
1319 to the default background colour.
1321 Note that setting the background colour may not cause an immediate
1322 refresh, so you may wish to call `ClearBackground` or `Refresh` after
1323 calling this function.
1325 Using this function will disable attempts to use themes for this
1326 window, if the system supports them. Use with care since usually the
1327 themes represent the appearance chosen by the user to be used for all
1328 applications on the system.", "");
1331 void , SetOwnBackgroundColour(const wxColour& colour),
1337 virtual bool , SetForegroundColour( const wxColour &colour ),
1338 "Sets the foreground colour of the window. Returns True is the colour
1339 was changed. The interpretation of foreground colour is dependent on
1340 the window class; it may be the text colour or other colour, or it may
1341 not be used at all.", "");
1344 void , SetOwnForegroundColour(const wxColour& colour),
1350 wxColour , GetBackgroundColour() const,
1351 "Returns the background colour of the window.", "");
1354 wxColour , GetForegroundColour() const,
1355 "Returns the foreground colour of the window. The interpretation of
1356 foreground colour is dependent on the window class; it may be the text
1357 colour or other colour, or it may not be used at all.", "");
1360 // // if the window shouldn't inherit its colour from the parent, override
1361 // // this function to return true
1363 // // this is currently only used by wxMSW and wxUniv but should be useful for
1364 // // the other ports too
1365 // virtual bool ProvidesBackground() const;
1368 // Set/get the background style.
1369 // Pass one of wxBG_STYLE_SYSTEM, wxBG_STYLE_COLOUR, wxBG_STYLE_CUSTOM
1371 virtual bool , SetBackgroundStyle(wxBackgroundStyle style),
1372 "Returns the background style of the window. The background style
1373 indicates how the background of the window is drawn.
1375 ====================== ========================================
1376 wx.BG_STYLE_SYSTEM The background colour or pattern should
1377 be determined by the system
1378 wx.BG_STYLE_COLOUR The background should be a solid colour
1379 wx.BG_STYLE_CUSTOM The background will be implemented by the
1381 ====================== ========================================
1383 On GTK+, use of wx.BG_STYLE_CUSTOM allows the flicker-free drawing of
1384 a custom background, such as a tiled bitmap. Currently the style has
1385 no effect on other platforms.
1387 :see: `GetBackgroundStyle`, `SetBackgroundColour`", "");
1390 virtual wxBackgroundStyle , GetBackgroundStyle() const,
1391 "Returns the background style of the window.
1393 :see: `SetBackgroundStyle`", "");
1398 virtual bool , SetCursor( const wxCursor &cursor ),
1399 "Sets the window's cursor. Notice that the window cursor also sets it
1400 for the children of the window implicitly.
1402 The cursor may be wx.NullCursor in which case the window cursor will
1403 be reset back to default.", "");
1406 wxCursor , GetCursor(),
1407 "Return the cursor associated with this window.", "");
1412 virtual bool , SetFont( const wxFont &font ),
1413 "Sets the font for this window.", "");
1416 void , SetOwnFont(const wxFont& font),
1423 "Returns the default font used for this window.", "");
1428 void , SetCaret(wxCaret *caret),
1429 "Sets the caret associated with the window.", "");
1432 wxCaret *, GetCaret() const,
1433 "Returns the caret associated with the window.", "");
1438 virtual int , GetCharHeight() const,
1439 "Get the (average) character size for the current font.", "");
1442 virtual int , GetCharWidth() const,
1443 "Get the (average) character size for the current font.", "");
1448 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1449 "GetTextExtent(String string) -> (width, height)",
1450 "Get the width and height of the text using the current font.", "");
1452 void, GetTextExtent(const wxString& string,
1453 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1454 const wxFont* font = NULL),
1455 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1456 "Get the width, height, decent and leading of the text using the
1457 current or specified font.", "",
1462 // client <-> screen coords
1463 // ------------------------
1465 %apply int * INOUT { int* x, int* y };
1467 // translate to/from screen/client coordinates
1469 void , ClientToScreen( int *x, int *y ) const,
1470 "ClientToScreenXY(int x, int y) -> (x,y)",
1471 "Converts to screen coordinates from coordinates relative to this window.", "",
1475 void , ScreenToClient( int *x, int *y ) const,
1476 "ScreenToClientXY(int x, int y) -> (x,y)",
1477 "Converts from screen to client window coordinates.", "",
1482 wxPoint , ClientToScreen(const wxPoint& pt) const,
1483 "Converts to screen coordinates from coordinates relative to this window.", "");
1486 wxPoint , ScreenToClient(const wxPoint& pt) const,
1487 "Converts from screen to client window coordinates.", "");
1492 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1493 "Test where the given (in client coords) point lies", "",
1497 wxHitTest , HitTest(const wxPoint& pt) const,
1498 "Test where the given (in client coords) point lies", "");
1506 %nokwargs GetBorder;
1508 wxBorder , GetBorder(long flags) const,
1509 "Get the window border style from the given flags: this is different
1510 from simply doing flags & wxBORDER_MASK because it uses
1511 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1516 wxBorder , GetBorder() const,
1517 "Get border for the flags of this window", "");
1523 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1524 "This function sends EVT_UPDATE_UI events to the window. The particular
1525 implementation depends on the window; for example a wx.ToolBar will
1526 send an update UI event for each toolbar button, and a wx.Frame will
1527 send an update UI event for each menubar menu item. You can call this
1528 function from your application to ensure that your UI is up-to-date at
1529 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1530 concerned). This may be necessary if you have called
1531 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
1532 limit the overhead that wxWindows incurs by sending update UI events
1535 The flags should be a bitlist of one or more of the following values:
1537 ===================== ==============================
1538 wx.UPDATE_UI_NONE No particular value
1539 wx.UPDATE_UI_RECURSE Call the function for descendants
1540 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1541 ===================== ==============================
1543 If you are calling this function from an OnIdle function, make sure
1544 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1545 to only update the UI elements that need to be updated in idle
1546 time. Some windows update their elements only when necessary, for
1547 example when a menu is about to be shown. The following is an example
1548 of how to call UpdateWindowUI from an idle function::
1550 def OnIdle(self, evt):
1551 if wx.UpdateUIEvent.CanUpdate(self):
1552 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1556 // TODO: using directors?
1557 // // do the window-specific processing after processing the update event
1558 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1562 "Pops up the given menu at the specified coordinates, relative to this window,
1563 and returns control when the user has dismissed the menu. If a menu item is
1564 selected, the corresponding menu event is generated and will be processed as
1565 usual. If the default position is given then the current position of the
1566 mouse cursor will be used.", "");
1567 %Rename(PopupMenuXY, bool, PopupMenu(wxMenu *menu, int x=-1, int y=-1));
1568 bool PopupMenu(wxMenu *menu, const wxPoint& pos=wxDefaultPosition);
1575 "Returns the platform-specific handle (as a long integer) of the
1576 physical window. Currently on wxMac it returns the handle of the
1577 toplevel parent of the window.", "");
1579 return wxPyGetWinHandle(self);
1585 "Associate the window with a new native handle", "");
1587 void AssociateHandle(long handle) {
1588 self->AssociateHandle((WXWidget)handle);
1594 virtual void , DissociateHandle(),
1595 "Dissociate the current native handle from the window", "");
1600 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1601 void OnPaint(wxPaintEvent& event);
1611 bool , HasScrollbar(int orient) const,
1612 "Does the window have the scrollbar for this orientation?", "");
1615 // configure the window scrollbars
1617 virtual void , SetScrollbar( int orientation,
1621 bool refresh = true ),
1622 "Sets the scrollbar properties of a built-in scrollbar.",
1624 :param orientation: Determines the scrollbar whose page size is to
1625 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1627 :param position: The position of the scrollbar in scroll units.
1629 :param thumbSize: The size of the thumb, or visible portion of the
1630 scrollbar, in scroll units.
1632 :param range: The maximum position of the scrollbar.
1634 :param refresh: True to redraw the scrollbar, false otherwise.
1638 virtual void , SetScrollPos( int orientation, int pos, bool refresh = true ),
1639 "Sets the position of one of the built-in scrollbars.", "");
1642 virtual int , GetScrollPos( int orientation ) const,
1643 "Returns the built-in scrollbar position.", "");
1646 virtual int , GetScrollThumb( int orientation ) const,
1647 "Returns the built-in scrollbar thumb size.", "");
1650 virtual int , GetScrollRange( int orientation ) const,
1651 "Returns the built-in scrollbar range.", "");
1657 virtual void , ScrollWindow( int dx, int dy,
1658 const wxRect* rect = NULL ),
1659 "Physically scrolls the pixels in the window and move child windows
1660 accordingly. Use this function to optimise your scrolling
1661 implementations, to minimise the area that must be redrawn. Note that
1662 it is rarely required to call this function from a user program.",
1664 :param dx: Amount to scroll horizontally.
1666 :param dy: Amount to scroll vertically.
1668 :param rect: Rectangle to invalidate. If this is None, the whole
1669 window is invalidated. If you pass a rectangle corresponding
1670 to the area of the window exposed by the scroll, your
1671 painting handler can optimize painting by checking for the
1672 invalidated region.");
1676 virtual bool , ScrollLines(int lines),
1677 "If the platform and window class supports it, scrolls the window by
1678 the given number of lines down, if lines is positive, or up if lines
1679 is negative. Returns True if the window was scrolled, False if it was
1680 already on top/bottom and nothing was done.", "");
1683 virtual bool , ScrollPages(int pages),
1684 "If the platform and window class supports it, scrolls the window by
1685 the given number of pages down, if pages is positive, or up if pages
1686 is negative. Returns True if the window was scrolled, False if it was
1687 already on top/bottom and nothing was done.", "");
1692 "This is just a wrapper for ScrollLines(-1).", "");
1696 "This is just a wrapper for ScrollLines(1).", "");
1700 "This is just a wrapper for ScrollPages(-1).", "");
1704 "This is just a wrapper for ScrollPages(1).", "");
1709 // context-sensitive help
1710 // ----------------------
1713 void , SetHelpText(const wxString& text),
1714 "Sets the help text to be used as context-sensitive help for this
1715 window. Note that the text is actually stored by the current
1716 wxHelpProvider implementation, and not in the window object itself.", "");
1720 void , SetHelpTextForId(const wxString& text),
1721 "Associate this help text with all windows with the same id as this
1726 wxString , GetHelpText() const,
1727 "Gets the help text to be used as context-sensitive help for this
1728 window. Note that the text is actually stored by the current
1729 wxHelpProvider implementation, and not in the window object itself.", "");
1738 "Attach a tooltip to the window.", "");
1739 %Rename(SetToolTipString, void, SetToolTip( const wxString &tip ));
1740 void SetToolTip( wxToolTip *tip );
1743 wxToolTip* , GetToolTip() const,
1744 "get the associated tooltip or None if none", "");
1746 // LINK ERROR --> wxString GetToolTipText() const;
1755 // set/retrieve the drop target associated with this window (may be
1756 // NULL; it's owned by the window and will be deleted by it)
1757 %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
1760 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1761 "Associates a drop target with this window. If the window already has
1762 a drop target, it is deleted.", "");
1764 %clear wxPyDropTarget *dropTarget;
1768 virtual wxPyDropTarget *, GetDropTarget() const,
1769 "Returns the associated drop target, which may be None.", "");
1772 #ifdef __WXMSW__ // TODO: should I drop-kick this?
1774 void , DragAcceptFiles(bool accept),
1775 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1776 Only available on Windows.", "");
1781 // constraints and sizers
1782 // ----------------------
1784 // set the constraints for this window or retrieve them (may be NULL)
1786 void , SetConstraints( wxLayoutConstraints *constraints ),
1787 "Sets the window to have the given layout constraints. If an existing
1788 layout constraints object is already owned by the window, it will be
1789 deleted. Pass None to disassociate and delete the window's current
1792 You must call SetAutoLayout to tell a window to use the constraints
1793 automatically in its default EVT_SIZE handler; otherwise, you must
1794 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1795 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1799 wxLayoutConstraints *, GetConstraints() const,
1800 "Returns a pointer to the window's layout constraints, or None if there
1805 void , SetAutoLayout( bool autoLayout ),
1806 "Determines whether the Layout function will be called automatically
1807 when the window is resized. It is called implicitly by SetSizer but
1808 if you use SetConstraints you should call it manually or otherwise the
1809 window layout won't be correctly updated when its size changes.", "");
1812 bool , GetAutoLayout() const,
1813 "Returns the current autoLayout setting", "");
1817 virtual bool , Layout(),
1818 "Invokes the constraint-based layout algorithm or the sizer-based
1819 algorithm for this window. See SetAutoLayout: when auto layout is on,
1820 this function gets called automatically by the default EVT_SIZE
1821 handler when the window is resized.", "");
1825 void , SetSizer(wxSizer *sizer, bool deleteOld = true ),
1826 "Sets the window to have the given layout sizer. The window will then
1827 own the object, and will take care of its deletion. If an existing
1828 layout sizer object is already owned by the window, it will be deleted
1829 if the deleteOld parameter is true. Note that this function will also
1830 call SetAutoLayout implicitly with a True parameter if the sizer is
1831 non-None, and False otherwise.", "");
1834 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = true ),
1835 "The same as SetSizer, except it also sets the size hints for the
1836 window based on the sizer's minimum size.", "");
1840 wxSizer *, GetSizer() const,
1841 "Return the sizer associated with the window by a previous call to
1842 SetSizer or None if there isn't one.", "");
1845 // Track if this window is a member of a sizer
1847 void , SetContainingSizer(wxSizer* sizer),
1848 "This normally does not need to be called by application code. It is
1849 called internally when a window is added to a sizer, and is used so
1850 the window can remove itself from the sizer when it is destroyed.", "");
1853 wxSizer *, GetContainingSizer() const,
1854 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1860 // ----------------------
1861 #if wxUSE_ACCESSIBILITY
1862 // Override to create a specific accessible object.
1863 virtual wxAccessible* CreateAccessible();
1865 // Sets the accessible object.
1866 void SetAccessible(wxAccessible* accessible) ;
1868 // Returns the accessible object.
1869 wxAccessible* GetAccessible() { return m_accessible; };
1871 // Returns the accessible object, creating if necessary.
1872 wxAccessible* GetOrCreateAccessible() ;
1879 virtual void , InheritAttributes(),
1880 "This function is (or should be, in case of custom controls) called
1881 during window creation to intelligently set up the window visual
1882 attributes, that is the font and the foreground and background
1885 By 'intelligently' the following is meant: by default, all windows use
1886 their own default attributes. However if some of the parent's
1887 attributes are explicitly changed (that is, using SetFont and not
1888 SetOwnFont) and if the corresponding attribute hadn't been
1889 explicitly set for this window itself, then this window takes the same
1890 value as used by the parent. In addition, if the window overrides
1891 ShouldInheritColours to return false, the colours will not be changed
1892 no matter what and only the font might.
1894 This rather complicated logic is necessary in order to accommodate the
1895 different usage scenarios. The most common one is when all default
1896 attributes are used and in this case, nothing should be inherited as
1897 in modern GUIs different controls use different fonts (and colours)
1898 than their siblings so they can't inherit the same value from the
1899 parent. However it was also deemed desirable to allow to simply change
1900 the attributes of all children at once by just changing the font or
1901 colour of their common parent, hence in this case we do inherit the
1906 // TODO: Virtualize this with directors
1908 virtual bool , ShouldInheritColours() const,
1909 "Return true from here to allow the colours of this window to be
1910 changed by InheritAttributes, returning false forbids inheriting them
1911 from the parent window.
1913 The base class version returns false, but this method is overridden in
1914 wxControl where it returns true.", "");
1919 def PostCreate(self, pre):
1921 Phase 3 of the 2-phase create <wink!>
1922 Call this method after precreating the window with the 2-phase create method.
1924 self.this = pre.this
1925 self.thisown = pre.thisown
1927 if hasattr(self, '_setOORInfo'):
1928 self._setOORInfo(self)
1929 if hasattr(self, '_setCallbackInfo'):
1930 self._setCallbackInfo(self, self.__class__)
1942 def DLG_PNT(win, point_or_x, y=None):
1944 Convenience function for converting a Point or (x,y) in
1945 dialog units to pixel units.
1948 return win.ConvertDialogPointToPixels(point_or_x)
1950 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
1952 def DLG_SZE(win, size_width, height=None):
1954 Convenience function for converting a Size or (w,h) in
1955 dialog units to pixel units.
1958 return win.ConvertDialogSizeToPixels(size_width)
1960 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
1966 // Unfortunatly the names of these new static methods clash with the
1967 // names wxPython has been using forever for the overloaded
1968 // wxWindow::FindWindow, so instead of swigging them as statics create
1969 // standalone functions for them.
1972 DocStr(wxFindWindowById,
1973 "Find the first window in the application with the given id. If parent
1974 is None, the search will start from all top-level frames and dialog
1975 boxes; if non-None, the search will be limited to the given window
1976 hierarchy. The search is recursive in both cases.", "");
1978 DocStr(wxFindWindowByName,
1979 "Find a window by its name (as given in a window constructor or Create
1980 function call). If parent is None, the search will start from all
1981 top-level frames and dialog boxes; if non-None, the search will be
1982 limited to the given window hierarchy. The search is recursive in both
1985 If no window with such name is found, wx.FindWindowByLabel is called.", "");
1987 DocStr(wxFindWindowByLabel,
1988 "Find a window by its label. Depending on the type of window, the label
1989 may be a window title or panel item label. If parent is None, the
1990 search will start from all top-level frames and dialog boxes; if
1991 non-None, the search will be limited to the given window
1992 hierarchy. The search is recursive in both cases.", "");
1995 MustHaveApp(wxFindWindowById);
1996 MustHaveApp(wxFindWindowByName);
1997 MustHaveApp(wxFindWindowByLabel);
2000 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
2001 return wxWindow::FindWindowById(id, parent);
2004 wxWindow* wxFindWindowByName( const wxString& name,
2005 const wxWindow *parent = NULL ) {
2006 return wxWindow::FindWindowByName(name, parent);
2009 wxWindow* wxFindWindowByLabel( const wxString& label,
2010 const wxWindow *parent = NULL ) {
2011 return wxWindow::FindWindowByLabel(label, parent);
2019 #include <wx/msw/private.h> // to get wxGetWindowId
2024 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
2026 WXHWND hWnd = (WXHWND)_hWnd;
2027 long id = wxGetWindowId(hWnd);
2028 wxWindow* win = new wxWindow;
2029 parent->AddChild(win);
2030 win->SetEventHandler(win);
2033 win->SubclassWin(hWnd);
2034 win->AdoptAttributesFromHWND();
2035 win->SetupColours();
2038 wxPyRaiseNotImplemented();
2044 //---------------------------------------------------------------------------
2045 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob