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 ============================= =====================================
191 class wxWindow : public wxEvtHandler
194 %pythonAppend wxWindow "self._setOORInfo(self)"
195 %pythonAppend wxWindow() ""
198 wxWindow(wxWindow* parent, const wxWindowID id=-1,
199 const wxPoint& pos = wxDefaultPosition,
200 const wxSize& size = wxDefaultSize,
202 const wxString& name = wxPyPanelNameStr),
203 "Construct and show a generic Window.", "");
207 "Precreate a Window for 2-phase creation.", "",
212 bool , Create(wxWindow* parent, const wxWindowID id=-1,
213 const wxPoint& pos = wxDefaultPosition,
214 const wxSize& size = wxDefaultSize,
216 const wxString& name = wxPyPanelNameStr),
217 "Create the GUI part of the Window for 2-phase creation mode.", "");
220 // deleting the window
221 // -------------------
225 bool , Close( bool force = False ),
226 "This function simply generates a EVT_CLOSE event whose handler usually
227 tries to close the window. It doesn't close the window itself,
228 however. If force is False (the default) then the window's close
229 handler will be allowed to veto the destruction of the window.",
231 Usually Close is only used with the top level windows (wx.Frame and
232 wx.Dialog classes) as the others are not supposed to have any special
235 The close handler should check whether the window is being deleted
236 forcibly, using wx.CloseEvent.GetForce, in which case it should
237 destroy the window using wx.Window.Destroy.
239 Note that calling Close does not guarantee that the window will be
240 destroyed; but it provides a way to simulate a manual close of a
241 window, which may or may not be implemented by destroying the
242 window. The default EVT_CLOSE handler for wx.Dialog does not
243 necessarily delete the dialog, since it will simply simulate an
244 wxID_CANCEL event which is handled by the appropriate button event
245 handler and may do anything at all.
247 To guarantee that the window will be destroyed, call wx.Window.Destroy
253 virtual bool , Destroy(),
254 "Destroys the window safely. Frames and dialogs are not destroyed
255 immediately when this function is called -- they are added to a list
256 of windows to be deleted on idle time, when all the window's events
257 have been processed. This prevents problems with events being sent to
258 non-existent windows.
260 Returns True if the window has either been successfully deleted, or it
261 has been added to the list of windows pending real deletion.", "");
265 bool , DestroyChildren(),
266 "Destroys all children of a window. Called automatically by the
271 bool , IsBeingDeleted() const,
272 "Is the window in the process of being deleted?", "");
280 virtual void , SetTitle( const wxString& title),
281 "Sets the window's title. Applicable only to frames and dialogs.", "");
284 virtual wxString , GetTitle() const,
285 "Gets the window's title. Applicable only to frames and dialogs.", "");
289 virtual void , SetLabel(const wxString& label),
290 "Set the text which the window shows in its label if applicable.", "");
293 virtual wxString , GetLabel() const,
294 "Generic way of getting a label from any window, for identification
295 purposes. The interpretation of this function differs from class to
296 class. For frames and dialogs, the value returned is the title. For
297 buttons or static text controls, it is the button text. This function
298 can be useful for meta-programs such as testing tools or special-needs
299 access programs)which need to identify windows by name.", "");
303 virtual void , SetName( const wxString &name ),
304 "Sets the window's name. The window name is used for ressource setting
305 in X, it is not the same as the window title/label", "");
308 virtual wxString , GetName() const,
309 "Returns the windows name. This name is not guaranteed to be unique;
310 it is up to the programmer to supply an appropriate name in the window
311 constructor or via wx.Window.SetName.", "");
315 void , SetWindowVariant( wxWindowVariant variant ),
316 "Sets the variant of the window/font size to use for this window, if
317 the platform supports variants, for example, wxMac.",
321 ======================== =======================================
322 wx.WINDOW_VARIANT_NORMAL Normal size
323 wx.WINDOW_VARIANT_SMALL Smaller size (about 25 % smaller than normal)
324 wx.WINDOW_VARIANT_MINI Mini size (about 33 % smaller than normal)
325 wx.WINDOW_VARIANT_LARGE Large size (about 25 % larger than normal)
326 ======================== =======================================
330 wxWindowVariant , GetWindowVariant() const,
335 void , SetId( wxWindowID winid ),
336 "Sets the identifier of the window. Each window has an integer
337 identifier. If the application has not provided one, an identifier
338 will be generated. Normally, the identifier should be provided on
339 creation and should not be modified subsequently.", "");
342 wxWindowID , GetId() const,
343 "Returns the identifier of the window. Each window has an integer
344 identifier. If the application has not provided one (or the default Id
345 -1 is used) then an unique identifier with a negative value will be
350 static int , NewControlId(),
351 "Generate a control id for the controls which were not given one.", "");
355 static int , NextControlId(int winid),
356 "Get the id of the control following the one with the given
357 autogenerated) id", "");
361 static int , PrevControlId(int winid),
362 "Get the id of the control preceding the one with the given
363 autogenerated) id", "");
373 void , SetSize( const wxSize& size ),
374 "Sets the size of the window in pixels.", "");
378 void , SetSize( int x, int y, int width, int height,
379 int sizeFlags = wxSIZE_AUTO ),
380 "Sets the position and size of the window in pixels. The sizeFlags
381 parameter indicates the interpretation of the other params if they are
382 -1. wx.SIZE_AUTO*: a -1 indicates that a class-specific default
383 shoudl be used. wx.SIZE_USE_EXISTING: existing dimensions should be
384 used if -1 values are supplied. wxSIZE_ALLOW_MINUS_ONE: allow
385 dimensions of -1 and less to be interpreted as real dimensions, not
386 default values.", "",
391 void , SetSize(const wxRect& rect, int sizeFlags = wxSIZE_AUTO),
392 "Sets the position and size of the window in pixels using a wx.Rect.", "",
397 void , SetSize( int width, int height ),
398 "Sets the size of the window in pixels.", "",
403 void , Move(const wxPoint& pt, int flags = wxSIZE_USE_EXISTING),
404 "Moves the window to the given position.", "");
406 %pythoncode { SetPosition = Move }
410 void , Move(int x, int y, int flags = wxSIZE_USE_EXISTING),
411 "Moves the window to the given position.", "",
417 virtual void , Raise(),
418 "Raises the window to the top of the window hierarchy if it is a
419 managed window (dialog or frame).", "");
422 virtual void , Lower(),
423 "Lowers the window to the bottom of the window hierarchy if it is a
424 managed window (dialog or frame).", "");
428 // client size is the size of the area available for subwindows
429 DocStr(SetClientSize,
430 "This sets the size of the window client area in pixels. Using this
431 function to size a window tends to be more device-independent than
432 wx.Window.SetSize, since the application need not worry about what
433 dimensions the border or title bar have when trying to fit the window
434 around panel items, for example.", "");
435 void SetClientSize( const wxSize& size );
436 %name(SetClientSizeWH) void SetClientSize( int width, int height );
437 %name(SetClientRect) void SetClientSize(const wxRect& rect);
440 DocStr(GetPosition, // sets the docstring for both
441 "Get the window's position.", "");
442 wxPoint GetPosition();
445 void, GetPosition(int *OUTPUT, int *OUTPUT),
446 "GetPositionTuple() -> (x,y)",
450 DocStr(GetSize, "Get the window size.", "");
451 wxSize GetSize() const;
453 void, GetSize( int *OUTPUT, int *OUTPUT ) const,
454 "GetSizeTuple() -> (width, height)",
460 wxRect , GetRect() const,
461 "Returns the size and position of the window as a wx.Rect object.", "");
464 DocStr(GetClientSize,
465 "This gets the size of the window's 'client area' in pixels. The client
466 area is the area which may be drawn on by the programmer, excluding
467 title bar, border, scrollbars, etc.", "");
468 wxSize GetClientSize() const;
470 void, GetClientSize( int *OUTPUT, int *OUTPUT ) const,
471 "GetClientSizeTuple() -> (width, height)",
477 virtual wxPoint , GetClientAreaOrigin() const,
478 "Get the origin of the client area of the window relative to the
479 window's top left corner (the client area may be shifted because of
480 the borders, scrollbars, other decorations...)", "");
484 wxRect , GetClientRect() const,
485 "Get the client area position and size as a wx.Rect object.", "");
490 "This functions returns the best acceptable minimal size for the
491 window, if applicable. For example, for a static text control, it will
492 be the minimal size such that the control label is not truncated. For
493 windows containing subwindows (suzh aswx.Panel), the size returned by
494 this function will be the same as the size the window would have had
495 after calling Fit.", "");
496 wxSize GetBestSize() const;
498 void, GetBestSize(int *OUTPUT, int *OUTPUT) const,
499 "GetBestSizeTuple() -> (width, height)",
504 wxSize , GetAdjustedBestSize() const,
505 "This method is similar to GetBestSize, except in one
506 thing. GetBestSize should return the minimum untruncated size of the
507 window, while this method will return the largest of BestSize and any
508 user specified minimum size. ie. it is the minimum size the window
509 should currently be drawn at, not the minimal size it can possibly
516 void , Center( int direction = wxBOTH ),
517 "Centers the window. The parameter specifies the direction for
518 cetering, and may be wx.HORIZONTAL, wx.VERTICAL or wx.BOTH. It may
519 also include wx.CENTER_ON_SCREEN flag if you want to center the window
520 on the entire screen and not on its parent window. If it is a
521 top-level window and has no parent then it will always be centered
522 relative to the screen.", "");
524 %pythoncode { Centre = Center }
528 void , CenterOnScreen(int dir = wxBOTH),
529 "Center on screen (only works for top level windows)", "");
530 %pythoncode { CentreOnScreen = CenterOnScreen }
534 void , CenterOnParent(int dir = wxBOTH),
535 "Center with respect to the the parent window", "");
536 %pythoncode { CentreOnParent = CenterOnParent }
541 virtual void , Fit(),
542 "Sizes the window so that it fits around its subwindows. This function
543 won't do anything if there are no subwindows and will only really work
544 correctly if sizers are used for the subwindows layout. Also, if the
545 window has exactly one subwindow it is better (faster and the result
546 is more precise as Fit adds some margin to account for fuzziness of
547 its calculations) to call window.SetClientSize(child.GetSize())
548 instead of calling Fit.", "");
552 virtual void , FitInside(),
553 "Similar to Fit, but sizes the interior (virtual) size of a
554 window. Mainly useful with scrolled windows to reset scrollbars after
555 sizing changes that do not trigger a size event, and/or scrolled
556 windows without an interior sizer. This function similarly won't do
557 anything if there are no subwindows.", "");
561 %nokwargs SetSizeHints;
563 "Allows specification of minimum and maximum window sizes, and window
564 size increments. If a pair of values is not set (or set to -1), the
565 default values will be used. If this function is called, the user
566 will not be able to size the window outside the given bounds. The
567 resizing increments are only significant under Motif or Xt.", "");
568 virtual void SetSizeHints( int minW, int minH,
569 int maxW = -1, int maxH = -1,
570 int incW = -1, int incH = -1 );
571 void SetSizeHints( const wxSize& minSize,
572 const wxSize& maxSize=wxDefaultSize,
573 const wxSize& incSize=wxDefaultSize);
576 %nokwargs SetVirtualSizeHints;
577 DocStr(SetVirtualSizeHints,
578 "Allows specification of minimum and maximum virtual window sizes. If a
579 pair of values is not set (or set to -1), the default values will be
580 used. If this function is called, the user will not be able to size
581 the virtual area of the window outside the given bounds.", "");
582 virtual void SetVirtualSizeHints( int minW, int minH,
583 int maxW = -1, int maxH = -1 );
584 void SetVirtualSizeHints( const wxSize& minSize,
585 const wxSize& maxSize=wxDefaultSize);
588 virtual int , GetMinWidth() const,
592 virtual int , GetMinHeight() const,
596 int , GetMaxWidth() const,
600 int , GetMaxHeight() const,
605 virtual wxSize , GetMaxSize() const,
610 virtual wxSize , GetMinSize() const,
614 DocStr(SetVirtualSize,
615 "Set the the virtual size of a window in pixels. For most windows this
616 is just the client area of the window, but for some like scrolled
617 windows it is more or less independent of the screen window size.", "");
618 void SetVirtualSize(const wxSize& size );
619 %name(SetVirtualSizeWH) void SetVirtualSize( int w, int h );
622 DocStr(GetVirtualSize,
623 "Get the the virtual size of the window in pixels. For most windows
624 this is just the client area of the window, but for some like scrolled
625 windows it is more or less independent of the screen window size.", "");
626 wxSize GetVirtualSize() const;
628 void, GetVirtualSize( int *OUTPUT, int *OUTPUT ) const,
629 "GetVirtualSizeTuple() -> (width, height)",
630 GetVirtualSizeTuple);
633 // TODO: using directors?
634 // // Override these methods for windows that have a virtual size
635 // // independent of their client size. eg. the virtual area of a
636 // // wxScrolledWindow. Default is to alias VirtualSize to ClientSize.
637 // virtual void DoSetVirtualSize( int x, int y );
638 // virtual wxSize DoGetVirtualSize() const; // { return m_virtualSize; }
642 virtual wxSize , GetBestVirtualSize() const,
643 "Return the largest of ClientSize and BestSize (as determined by a
644 sizer, interior children, or other means)", "");
652 virtual bool , Show( bool show = True ),
653 "Shows or hides the window. You may need to call Raise for a top level
654 window if you want to bring it to top, although this is not needed if
655 Show is called immediately after the frame creation. Returns True if
656 the window has been shown or hidden or False if nothing was done
657 because it already was in the requested state.", "");
661 "Equivalent to calling Show(False).", "");
665 virtual bool , Enable( bool enable = True ),
666 "Enable or disable the window for user input. Note that when a parent
667 window is disabled, all of its children are disabled as well and they
668 are reenabled again when the parent is. Returns true if the window
669 has been enabled or disabled, false if nothing was done, i.e. if the
670 window had already been in the specified state.", "");
674 "Disables the window, same as Enable(false).", "");
678 bool , IsShown() const,
679 "Returns true if the window is shown, false if it has been hidden.", "");
682 bool , IsEnabled() const,
683 "Returns true if the window is enabled for input, false otherwise.", "");
689 virtual void , SetWindowStyleFlag( long style ),
690 "Sets the style of the window. Please note that some styles cannot be
691 changed after the window creation and that Refresh() might need to be
692 called after changing the others for the change to take place
696 virtual long , GetWindowStyleFlag() const,
697 "Gets the window style that was passed to the constructor or Create
700 %pythoncode { SetWindowStyle = SetWindowStyleFlag; GetWindowStyle = GetWindowStyleFlag }
704 bool , HasFlag(int flag) const,
705 "Test if the given style is set for this window.", "");
709 virtual bool , IsRetained() const,
710 "Returns true if the window is retained, false otherwise. Retained
711 windows are only available on X platforms.", "");
716 virtual void , SetExtraStyle(long exStyle),
717 "Sets the extra style bits for the window. Extra styles are the less
718 often used style bits which can't be set with the constructor or with
719 SetWindowStyleFlag()", "");
722 long , GetExtraStyle() const,
723 "Returns the extra style bits for the window.", "");
728 virtual void , MakeModal(bool modal = True),
729 "Disables all other windows in the application so that the user can
730 only interact with this window. Passing False will reverse this
736 virtual void , SetThemeEnabled(bool enableTheme),
737 "This function tells a window if it should use the system's \"theme\"
738 code to draw the windows' background instead if its own background
739 drawing code. This will only have an effect on platforms that support
740 the notion of themes in user defined windows. One such platform is
741 GTK+ where windows can have (very colourful) backgrounds defined by a
742 user's selected theme.
744 Dialogs, notebook pages and the status bar have this flag set to true
745 by default so that the default look and feel is simulated best.", "");
748 virtual bool , GetThemeEnabled() const,
749 "Return the themeEnabled flag.", "");
752 // TODO with directors
753 // // controls by default inherit the colours of their parents, if a
754 // // particular control class doesn't want to do it, it can override
755 // // ShouldInheritColours() to return False
756 // virtual bool ShouldInheritColours() const;
762 // focus and keyboard handling
763 // ---------------------------
767 virtual void , SetFocus(),
768 "Set's the focus to this window, allowing it to receive keyboard input.", "");
771 virtual void , SetFocusFromKbd(),
772 "Set focus to this window as the result of a keyboard action. Normally
773 only called internally.", "");
778 static wxWindow *, FindFocus(),
779 "Returns the window or control that currently has the keyboard focus,
784 virtual bool , AcceptsFocus() const,
785 "Can this window have focus?", "");
789 virtual bool , AcceptsFocusFromKeyboard() const,
790 "Can this window be given focus by keyboard navigation? if not, the
791 only way to give it focus (provided it accepts it at all) is to click
798 virtual wxWindow *, GetDefaultItem() const,
799 "Get the default child of this parent, i.e. the one which is activated
800 by pressing <Enter> such as the OK button on a wx.Dialog.", "");
803 virtual wxWindow *, SetDefaultItem(wxWindow * child),
804 "Set this child as default, return the old default.", "");
807 virtual void , SetTmpDefaultItem(wxWindow * win),
808 "Set this child as temporary default", "");
814 // parent/children relations
815 // -------------------------
818 //wxWindowList& GetChildren(); // TODO: Do a typemap or a wrapper for wxWindowList
821 "Returns a list of the window's children. NOTE: Currently this is a
822 copy of the child window list maintained by the window, so the return
823 value of this function is only valid as long as the window's children
824 do not change.", "");
825 PyObject* GetChildren() {
826 wxWindowList& list = self->GetChildren();
827 return wxPy_ConvertList(&list);
832 wxWindow *, GetParent() const,
833 "Returns the parent window of this window, or None if there isn't one.", "");
836 wxWindow *, GetGrandParent() const,
837 "Returns the parent of the parent of this window, or None if there
843 virtual bool , IsTopLevel() const,
844 "Returns true if the given window is a top-level one. Currently all
845 frames and dialogs are always considered to be top-level windows (even
846 if they have a parent window).", "");
849 // change the real parent of this window, return True if the parent
850 // was changed, False otherwise (error or newParent == oldParent)
852 virtual bool , Reparent( wxWindow *newParent ),
853 "Reparents the window, i.e the window will be removed from its current
854 parent window (e.g. a non-standard toolbar in a wxFrame) and then
855 re-inserted into another. Available on Windows and GTK. Returns True
856 if the parent was changed, False otherwise (error or newParent ==
861 virtual void , AddChild( wxWindow *child ),
862 "Adds a child window. This is called automatically by window creation
863 functions so should not be required by the application programmer.", "");
866 virtual void , RemoveChild( wxWindow *child ),
867 "Removes a child window. This is called automatically by window
868 deletion functions so should not be required by the application
874 // looking for windows
875 // -------------------
878 wxWindow *, FindWindow( long winid ),
879 "Find a chld of this window by window ID", "",
883 wxWindow *, FindWindow( const wxString& name ),
884 "Find a child of this window by name", "",
889 // event handler stuff
890 // -------------------
893 wxEvtHandler *, GetEventHandler() const,
894 "Returns the event handler for this window. By default, the window is
895 its own event handler.", "");
899 void , SetEventHandler( wxEvtHandler *handler ),
900 "Sets the event handler for this window. An event handler is an object
901 that is capable of processing the events sent to a window. By default,
902 the window is its own event handler, but an application may wish to
903 substitute another, for example to allow central implementation of
904 event-handling for a variety of different window classes.
906 It is usually better to use `wx.Window.PushEventHandler` since this sets
907 up a chain of event handlers, where an event not handled by one event
908 handler is handed to the next one in the chain.", "");
912 void , PushEventHandler( wxEvtHandler *handler ),
913 "Pushes this event handler onto the event handler stack for the window.
914 An event handler is an object that is capable of processing the events
915 sent to a window. By default, the window is its own event handler, but
916 an application may wish to substitute another, for example to allow
917 central implementation of event-handling for a variety of different
920 wx.Window.PushEventHandler allows an application to set up a chain of
921 event handlers, where an event not handled by one event handler is
922 handed to the next one in the chain. Use `wx.Window.PopEventHandler` to
923 remove the event handler.", "");
927 wxEvtHandler *, PopEventHandler( bool deleteHandler = False ),
928 "Removes and returns the top-most event handler on the event handler
929 stack. If deleteHandler is True then the wx.EvtHandler object will be
930 destroyed after it is popped.", "");
934 bool , RemoveEventHandler(wxEvtHandler *handler),
935 "Find the given handler in the event handler chain and remove (but not
936 delete) it from the event handler chain, return True if it was found
937 and False otherwise (this also results in an assert failure so this
938 function should only be called when the handler is supposed to be
947 // a window may have an associated validator which is used to control
950 virtual void , SetValidator( const wxValidator &validator ),
951 "Deletes the current validator (if any) and sets the window validator,
952 having called wx.Validator.Clone to create a new validator of this
956 virtual wxValidator *, GetValidator(),
957 "Returns a pointer to the current validator for the window, or None if
958 there is none.", "");
962 virtual bool , Validate(),
963 "Validates the current values of the child controls using their
964 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
965 style flag set, the method will also call Validate() of all child
966 windows. Returns false if any of the validations failed.", "");
970 virtual bool , TransferDataToWindow(),
971 "Transfers values to child controls from data areas specified by their
972 validators. If the window has wx.WS_EX_VALIDATE_RECURSIVELY extra
973 style flag set, the method will also call TransferDataToWindow() of
974 all child windows.", "");
977 virtual bool , TransferDataFromWindow(),
978 "Transfers values from child controls to data areas specified by their
979 validators. Returns false if a transfer failed. If the window has
980 wx.WS_EX_VALIDATE_RECURSIVELY extra style flag set, the method will
981 also call TransferDataFromWindow() of all child windows.", "");
985 virtual void , InitDialog(),
986 "Sends an EVT_INIT_DIALOG event, whose handler usually transfers data
987 to the dialog via validators.", "");
996 virtual void , SetAcceleratorTable( const wxAcceleratorTable& accel ),
997 "Sets the accelerator table for this window.", "");
1000 wxAcceleratorTable *, GetAcceleratorTable(),
1001 "Gets the accelerator table for this window.", "");
1007 // hot keys (system wide accelerators)
1008 // -----------------------------------
1010 DocStr(RegisterHotKey,
1011 "Registers a system wide hotkey. Every time the user presses the hotkey
1012 registered here, this window will receive a hotkey event. It will
1013 receive the event even if the application is in the background and
1014 does not have the input focus because the user is working with some
1015 other application. To bind an event handler function to this hotkey
1016 use EVT_HOTKEY with an id equal to hotkeyId. Returns True if the
1017 hotkey was registered successfully.", "");
1018 bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) {
1020 return self->RegisterHotKey(hotkeyId, modifiers, keycode);
1027 DocStr(UnregisterHotKey,
1028 "Unregisters a system wide hotkey.", "");
1029 bool UnregisterHotKey(int hotkeyId) {
1031 return self->UnregisterHotKey(hotkeyId);
1040 // "dialog units" translations
1041 // ---------------------------
1043 DocStr(ConvertDialogToPixels,
1044 "Converts a point or size from dialog units to pixels. Dialog units
1045 are used for maintaining a dialog's proportions even if the font
1046 changes. For the x dimension, the dialog units are multiplied by the
1047 average character width and then divided by 4. For the y dimension,
1048 the dialog units are multiplied by the average character height and
1049 then divided by 8.", "");
1050 %name(ConvertDialogPointToPixels) wxPoint ConvertDialogToPixels(const wxPoint& pt);
1051 %name(ConvertDialogSizeToPixels) wxSize ConvertDialogToPixels(const wxSize& sz);
1052 %name(DLG_PNT) wxPoint ConvertDialogToPixels(const wxPoint& pt);
1053 %name(DLG_SZE) wxSize ConvertDialogToPixels(const wxSize& sz);
1056 DocStr(ConvertPixelPointToDialog,
1057 "Converts a point or size from pixels to dialog units. Dialog units
1058 are used for maintaining a dialog's proportions even if the font
1059 changes. For the x dimension, the dialog units are multiplied by the
1060 average character width and then divided by 4. For the y dimension,
1061 the dialog units are multiplied by the average character height and
1062 then divided by 8.", "");
1063 %name(ConvertPixelPointToDialog) wxPoint ConvertPixelsToDialog(const wxPoint& pt);
1064 %name(ConvertPixelSizeToDialog) wxSize ConvertPixelsToDialog(const wxSize& sz);
1072 virtual void , WarpPointer(int x, int y),
1073 "Moves the pointer to the given position on the window.
1075 NOTE: This function is not supported under Mac because Apple Human
1076 Interface Guidelines forbid moving the mouse cursor programmatically.", "");
1080 void , CaptureMouse(),
1081 "Directs all mouse input to this window. Call wx.Window.ReleaseMouse to
1082 release the capture.
1084 Note that wxWindows maintains the stack of windows having captured the
1085 mouse and when the mouse is released the capture returns to the window
1086 which had had captured it previously and it is only really released if
1087 there were no previous window. In particular, this means that you must
1088 release the mouse as many times as you capture it.", "");
1091 void , ReleaseMouse(),
1092 "Releases mouse input captured with wx.Window.CaptureMouse.", "");
1096 static wxWindow *, GetCapture(),
1097 "Returns the window which currently captures the mouse or None", "");
1101 virtual bool , HasCapture() const,
1102 "Returns true if this window has the current mouse capture.", "");
1108 // painting the window
1109 // -------------------
1112 virtual void , Refresh( bool eraseBackground = True,
1113 const wxRect *rect = NULL ),
1114 "Mark the specified rectangle (or the whole window) as \"dirty\" so it
1115 will be repainted. Causes an EVT_PAINT event to be generated and sent
1116 to the window.", "");
1120 void , RefreshRect(const wxRect& rect),
1121 "Redraws the contents of the given rectangle: the area inside it will
1122 be repainted. This is the same as Refresh but has a nicer syntax.", "");
1126 virtual void , Update(),
1127 "Calling this method immediately repaints the invalidated area of the
1128 window instead of waiting for the EVT_PAINT event to happen, (normally
1129 this would usually only happen when the flow of control returns to the
1130 event loop.) Notice that this function doesn't refresh the window and
1131 does nothing if the window has been already repainted. Use Refresh
1132 first if you want to immediately redraw the window (or some portion of
1133 it) unconditionally.", "");
1137 virtual void , ClearBackground(),
1138 "Clears the window by filling it with the current background
1139 colour. Does not cause an erase background event to be generated.", "");
1144 virtual void , Freeze(),
1145 "Freezes the window or, in other words, prevents any updates from
1146 taking place on screen, the window is not redrawn at all. Thaw must be
1147 called to reenable window redrawing. Calls to Freeze/Thaw may be
1148 nested, with the actual Thaw being delayed until all the nesting has
1151 This method is useful for visual appearance optimization (for example,
1152 it is a good idea to use it before inserting large amount of text into
1153 a wxTextCtrl under wxGTK) but is not implemented on all platforms nor
1154 for all controls so it is mostly just a hint to wxWindows and not a
1155 mandatory directive.", "");
1159 virtual void , Thaw(),
1160 "Reenables window updating after a previous call to Freeze. Calls to
1161 Freeze/Thaw may be nested, so Thaw must be called the same number of
1162 times that Freeze was before the window will be updated.", "");
1166 virtual void , PrepareDC( wxDC & dc ),
1167 "Call this function to prepare the device context for drawing a
1168 scrolled image. It sets the device origin according to the current
1169 scroll position.", "");
1173 wxRegion& , GetUpdateRegion(),
1174 "Returns the region specifying which parts of the window have been
1175 damaged. Should only be called within an EVT_PAINT handler.", "");
1179 wxRect , GetUpdateClientRect() const,
1180 "Get the update rectangle region bounding box in client coords.", "");
1184 "Returns true if the given point or rectangle area has been exposed
1185 since the last repaint. Call this in an paint event handler to
1186 optimize redrawing by only redrawing those areas, which have been
1188 bool IsExposed( int x, int y, int w=1, int h=1 ) const;
1189 %name(IsExposedPoint) bool IsExposed( const wxPoint& pt ) const;
1190 %name(IsExposedRect) bool IsExposed( const wxRect& rect ) const;
1194 // colours, fonts and cursors
1195 // --------------------------
1199 virtual wxVisualAttributes , GetDefaultAttributes() const,
1200 "Get the default attributes for an instance of this class. This is
1201 useful if you want to use the same font or colour in your own control
1202 as in a standard control -- which is a much better idea than hard
1203 coding specific colours or fonts which might look completely out of
1204 place on the user's system, especially if it uses themes.", "");
1208 static wxVisualAttributes ,
1209 GetClassDefaultAttributes(wxWindowVariant variant = wxWINDOW_VARIANT_NORMAL),
1210 "Get the default attributes for this class. This is useful if you want
1211 to use the same font or colour in your own control as in a standard
1212 control -- which is a much better idea than hard coding specific
1213 colours or fonts which might look completely out of place on the
1214 user's system, especially if it uses themes.
1216 The variant parameter is only relevant under Mac currently and is
1217 ignore under other platforms. Under Mac, it will change the size of
1218 the returned font. See `wx.Window.SetWindowVariant` for more about
1223 virtual bool , SetBackgroundColour( const wxColour &colour ),
1224 "Sets the background colour of the window. Returns True if the colour
1225 was changed. The background colour is usually painted by the default
1226 EVT_ERASE_BACKGROUND event handler function under Windows and
1227 automatically under GTK.
1229 Note that setting the background colour may not cause an immediate
1230 refresh, so you may wish to call ClearBackground or Refresh after
1231 calling this function.
1233 Use this function with care under GTK+ as the new appearance of the
1234 window might not look equally well when used with themes, i.e GTK+'s
1235 ability to change its look as the user wishes with run-time loadable
1239 void , SetDefaultBackgroundColour(const wxColour& colour),
1245 virtual bool , SetForegroundColour( const wxColour &colour ),
1246 "Sets the foreground colour of the window. Returns True is the colour
1247 was changed. The interpretation of foreground colour is dependent on
1248 the window class; it may be the text colour or other colour, or it may
1249 not be used at all.", "");
1252 void , SetDefaultForegroundColour(const wxColour& colour),
1258 wxColour , GetBackgroundColour() const,
1259 "Returns the background colour of the window.", "");
1262 wxColour , GetForegroundColour() const,
1263 "Returns the foreground colour of the window. The interpretation of
1264 foreground colour is dependent on the window class; it may be the text
1265 colour or other colour, or it may not be used at all.", "");
1271 virtual bool , SetCursor( const wxCursor &cursor ),
1272 "Sets the window's cursor. Notice that the window cursor also sets it
1273 for the children of the window implicitly.
1275 The cursor may be wx.NullCursor in which case the window cursor will
1276 be reset back to default.", "");
1279 wxCursor& , GetCursor(),
1280 "Return the cursor associated with this window.", "");
1285 virtual bool , SetFont( const wxFont &font ),
1286 "Sets the font for this window.", "");
1289 void , SetDefaultFont(const wxFont& font),
1295 wxFont& , GetFont(),
1296 "Returns the default font used for this window.", "");
1301 void , SetCaret(wxCaret *caret),
1302 "Sets the caret associated with the window.", "");
1305 wxCaret *, GetCaret() const,
1306 "Returns the caret associated with the window.", "");
1311 virtual int , GetCharHeight() const,
1312 "Get the (average) character size for the current font.", "");
1315 virtual int , GetCharWidth() const,
1316 "Get the (average) character size for the current font.", "");
1321 void, GetTextExtent(const wxString& string, int *OUTPUT, int *OUTPUT),
1322 "GetTextExtent(String string) -> (width, height)",
1323 "Get the width and height of the text using the current font.", "");
1325 void, GetTextExtent(const wxString& string,
1326 int *OUTPUT, int *OUTPUT, int *OUTPUT, int* OUTPUT,
1327 const wxFont* font = NULL),
1328 "GetFullTextExtent(String string, Font font=None) ->\n (width, height, descent, externalLeading)",
1329 "Get the width, height, decent and leading of the text using the
1330 current or specified font.", "",
1335 // client <-> screen coords
1336 // ------------------------
1338 %apply int * INOUT { int* x, int* y };
1340 // translate to/from screen/client coordinates
1342 void , ClientToScreen( int *x, int *y ) const,
1343 "ClientToScreenXY(int x, int y) -> (x,y)",
1344 "Converts to screen coordinates from coordinates relative to this window.", "",
1348 void , ScreenToClient( int *x, int *y ) const,
1349 "ScreenToClientXY(int x, int y) -> (x,y)",
1350 "Converts from screen to client window coordinates.", "",
1355 wxPoint , ClientToScreen(const wxPoint& pt) const,
1356 "Converts to screen coordinates from coordinates relative to this window.", "");
1359 wxPoint , ScreenToClient(const wxPoint& pt) const,
1360 "Converts from screen to client window coordinates.", "");
1365 wxHitTest , HitTest(wxCoord x, wxCoord y) const,
1366 "Test where the given (in client coords) point lies", "",
1370 wxHitTest , HitTest(const wxPoint& pt) const,
1371 "Test where the given (in client coords) point lies", "");
1379 %nokwargs GetBorder;
1381 wxBorder , GetBorder(long flags) const,
1382 "Get the window border style from the given flags: this is different
1383 from simply doing flags & wxBORDER_MASK because it uses
1384 GetDefaultBorder() to translate wxBORDER_DEFAULT to something
1389 wxBorder , GetBorder() const,
1390 "Get border for the flags of this window", "");
1396 virtual void , UpdateWindowUI(long flags = wxUPDATE_UI_NONE),
1397 "This function sends EVT_UPDATE_UI events to the window. The particular
1398 implementation depends on the window; for example a wx.ToolBar will
1399 send an update UI event for each toolbar button, and a wx.Frame will
1400 send an update UI event for each menubar menu item. You can call this
1401 function from your application to ensure that your UI is up-to-date at
1402 a particular point in time (as far as your EVT_UPDATE_UI handlers are
1403 concerned). This may be necessary if you have called
1404 wx.UpdateUIEvent.SetMode or wx.UpdateUIEvent.SetUpdateInterval to
1405 limit the overhead that wxWindows incurs by sending update UI events
1408 The flags should be a bitlist of one or more of the following values:
1410 ===================== ==============================
1411 wx.UPDATE_UI_NONE No particular value
1412 wx.UPDATE_UI_RECURSE Call the function for descendants
1413 wx.UPDATE_UI_FROMIDLE Invoked from OnIdle
1414 ===================== ==============================
1416 If you are calling this function from an OnIdle function, make sure
1417 you pass the wx.UPDATE_UI_FROMIDLE flag, since this tells the window
1418 to only update the UI elements that need to be updated in idle
1419 time. Some windows update their elements only when necessary, for
1420 example when a menu is about to be shown. The following is an example
1421 of how to call UpdateWindowUI from an idle function::
1423 def OnIdle(self, evt):
1424 if wx.UpdateUIEvent.CanUpdate(self):
1425 self.UpdateWindowUI(wx.UPDATE_UI_FROMIDLE);
1429 // TODO: using directors?
1430 // // do the window-specific processing after processing the update event
1431 // virtual void DoUpdateWindowUI(wxUpdateUIEvent& event) ;
1435 "Pops up the given menu at the specified coordinates, relative to this
1436 window, and returns control when the user has dismissed the menu. If a
1437 menu item is selected, the corresponding menu event is generated and
1438 will be processed as usual.", "");
1439 %name(PopupMenuXY) bool PopupMenu(wxMenu *menu, int x, int y);
1440 bool PopupMenu(wxMenu *menu, const wxPoint& pos);
1447 "Returns the platform-specific handle (as a long integer) of the
1448 physical window. Currently on wxMac it returns the handle of the
1449 toplevel parent of the window.", "");
1451 return wxPyGetWinHandle(self);
1458 // A way to do the native draw first... Too bad it isn't in wxGTK too.
1459 void OnPaint(wxPaintEvent& event);
1469 bool , HasScrollbar(int orient) const,
1470 "Does the window have the scrollbar for this orientation?", "");
1473 // configure the window scrollbars
1475 virtual void , SetScrollbar( int orientation,
1479 bool refresh = True ),
1480 "Sets the scrollbar properties of a built-in scrollbar.",
1482 :param orientation: Determines the scrollbar whose page size is to
1483 be set. May be wx.HORIZONTAL or wx.VERTICAL.
1485 :param position: The position of the scrollbar in scroll units.
1487 :param thumbSize: The size of the thumb, or visible portion of the
1488 scrollbar, in scroll units.
1490 :param range: The maximum position of the scrollbar.
1492 :param refresh: True to redraw the scrollbar, false otherwise.
1496 virtual void , SetScrollPos( int orientation, int pos, bool refresh = True ),
1497 "Sets the position of one of the built-in scrollbars.", "");
1500 virtual int , GetScrollPos( int orientation ) const,
1501 "Returns the built-in scrollbar position.", "");
1504 virtual int , GetScrollThumb( int orientation ) const,
1505 "Returns the built-in scrollbar thumb size.", "");
1508 virtual int , GetScrollRange( int orientation ) const,
1509 "Returns the built-in scrollbar range.", "");
1515 virtual void , ScrollWindow( int dx, int dy,
1516 const wxRect* rect = NULL ),
1517 "Physically scrolls the pixels in the window and move child windows
1518 accordingly. Use this function to optimise your scrolling
1519 implementations, to minimise the area that must be redrawn. Note that
1520 it is rarely required to call this function from a user program.",
1522 :param dx: Amount to scroll horizontally.
1524 :param dy: Amount to scroll vertically.
1526 :param rect: Rectangle to invalidate. If this is None, the whole
1527 window is invalidated. If you pass a rectangle corresponding
1528 to the area of the window exposed by the scroll, your
1529 painting handler can optimize painting by checking for the
1530 invalidated region.");
1534 virtual bool , ScrollLines(int lines),
1535 "If the platform and window class supports it, scrolls the window by
1536 the given number of lines down, if lines is positive, or up if lines
1537 is negative. Returns True if the window was scrolled, False if it was
1538 already on top/bottom and nothing was done.", "");
1541 virtual bool , ScrollPages(int pages),
1542 "If the platform and window class supports it, scrolls the window by
1543 the given number of pages down, if pages is positive, or up if pages
1544 is negative. Returns True if the window was scrolled, False if it was
1545 already on top/bottom and nothing was done.", "");
1550 "This is just a wrapper for ScrollLines(-1).", "");
1554 "This is just a wrapper for ScrollLines(1).", "");
1558 "This is just a wrapper for ScrollPages(-1).", "");
1562 "This is just a wrapper for ScrollPages(1).", "");
1567 // context-sensitive help
1568 // ----------------------
1571 void , SetHelpText(const wxString& text),
1572 "Sets the help text to be used as context-sensitive help for this
1573 window. Note that the text is actually stored by the current
1574 wxHelpProvider implementation, and not in the window object itself.", "");
1578 void , SetHelpTextForId(const wxString& text),
1579 "Associate this help text with all windows with the same id as this
1584 wxString , GetHelpText() const,
1585 "Gets the help text to be used as context-sensitive help for this
1586 window. Note that the text is actually stored by the current
1587 wxHelpProvider implementation, and not in the window object itself.", "");
1596 "Attach a tooltip to the window.", "");
1597 %name(SetToolTipString) void SetToolTip( const wxString &tip );
1598 void SetToolTip( wxToolTip *tip );
1601 wxToolTip* , GetToolTip() const,
1602 "get the associated tooltip or None if none", "");
1604 // LINK ERROR --> wxString GetToolTipText() const;
1613 // set/retrieve the drop target associated with this window (may be
1614 // NULL; it's owned by the window and will be deleted by it)
1615 %apply SWIGTYPE *DISOWN { wxPyDropTarget *dropTarget };
1618 virtual void , SetDropTarget( wxPyDropTarget *dropTarget ),
1619 "Associates a drop target with this window. If the window already has
1620 a drop target, it is deleted.", "");
1622 %clear wxPyDropTarget *dropTarget;
1626 virtual wxPyDropTarget *, GetDropTarget() const,
1627 "Returns the associated drop target, which may be None.", "");
1630 #ifdef __WXMSW__ // TODO: should I drop-kick this?
1632 void , DragAcceptFiles(bool accept),
1633 "Enables or disables eligibility for drop file events, EVT_DROP_FILES.
1634 Only available on Windows.", "");
1639 // constraints and sizers
1640 // ----------------------
1642 // set the constraints for this window or retrieve them (may be NULL)
1644 void , SetConstraints( wxLayoutConstraints *constraints ),
1645 "Sets the window to have the given layout constraints. If an existing
1646 layout constraints object is already owned by the window, it will be
1647 deleted. Pass None to disassociate and delete the window's current
1650 You must call SetAutoLayout to tell a window to use the constraints
1651 automatically in its default EVT_SIZE handler; otherwise, you must
1652 handle EVT_SIZE yourself and call Layout() explicitly. When setting
1653 both a wx.LayoutConstraints and a wx.Sizer, only the sizer will have
1657 wxLayoutConstraints *, GetConstraints() const,
1658 "Returns a pointer to the window's layout constraints, or None if there
1663 void , SetAutoLayout( bool autoLayout ),
1664 "Determines whether the Layout function will be called automatically
1665 when the window is resized. It is called implicitly by SetSizer but
1666 if you use SetConstraints you should call it manually or otherwise the
1667 window layout won't be correctly updated when its size changes.", "");
1670 bool , GetAutoLayout() const,
1671 "Returns the current autoLayout setting", "");
1675 virtual bool , Layout(),
1676 "Invokes the constraint-based layout algorithm or the sizer-based
1677 algorithm for this window. See SetAutoLayout: when auto layout is on,
1678 this function gets called automatically by the default EVT_SIZE
1679 handler when the window is resized.", "");
1683 void , SetSizer(wxSizer *sizer, bool deleteOld = True ),
1684 "Sets the window to have the given layout sizer. The window will then
1685 own the object, and will take care of its deletion. If an existing
1686 layout sizer object is already owned by the window, it will be deleted
1687 if the deleteOld parameter is true. Note that this function will also
1688 call SetAutoLayout implicitly with a True parameter if the sizer is
1689 non-NoneL and False otherwise.", "");
1692 void , SetSizerAndFit( wxSizer *sizer, bool deleteOld = True ),
1693 "The same as SetSizer, except it also sets the size hints for the
1694 window based on the sizer's minimum size.", "");
1698 wxSizer *, GetSizer() const,
1699 "Return the sizer associated with the window by a previous call to
1700 SetSizer or None if there isn't one.", "");
1703 // Track if this window is a member of a sizer
1705 void , SetContainingSizer(wxSizer* sizer),
1706 "This normally does not need to be called by application code. It is
1707 called internally when a window is added to a sizer, and is used so
1708 the window can remove itself from the sizer when it is destroyed.", "");
1711 wxSizer *, GetContainingSizer() const,
1712 "Return the sizer that this window is a member of, if any, otherwise None.", "");
1718 // ----------------------
1719 #if wxUSE_ACCESSIBILITY
1720 // Override to create a specific accessible object.
1721 virtual wxAccessible* CreateAccessible();
1723 // Sets the accessible object.
1724 void SetAccessible(wxAccessible* accessible) ;
1726 // Returns the accessible object.
1727 wxAccessible* GetAccessible() { return m_accessible; };
1729 // Returns the accessible object, creating if necessary.
1730 wxAccessible* GetOrCreateAccessible() ;
1737 virtual void , InheritAttributes(),
1738 "This function is (or should be, in case of custom controls) called
1739 during window creation to intelligently set up the window visual
1740 attributes, that is the font and the foreground and background
1743 By 'intelligently' the following is meant: by default, all windows use
1744 their own default attributes. However if some of the parent's
1745 attributes are explicitly changed (that is, using SetFont and not
1746 SetDefaultFont) and if the corresponding attribute hadn't been
1747 explicitly set for this window itself, then this window takes the same
1748 value as used by the parent. In addition, if the window overrides
1749 ShouldInheritColours to return false, the colours will not be changed
1750 no matter what and only the font might.
1752 This rather complicated logic is necessary in order to accomodate the
1753 different usage scenarius. The most common one is when all default
1754 attributes are used and in this case, nothing should be inherited as
1755 in modern GUIs different controls use different fonts (and colours)
1756 than their siblings so they can't inherit the same value from the
1757 parent. However it was also deemed desirable to allow to simply change
1758 the attributes of all children at once by just changing the font or
1759 colour of their common parent, hence in this case we do inherit the
1764 // TODO: Virtualize this with directors
1766 virtual bool , ShouldInheritColours() const,
1767 "Return true from here to allow the colours of this window to be
1768 changed by InheritAttributes, returning false forbids inheriting them
1769 from the parent window.
1771 The base class version returns false, but this method is overridden in
1772 wxControl where it returns true.", "");
1777 def PostCreate(self, pre):
1779 Phase 3 of the 2-phase create <wink!>
1780 Call this method after precreating the window with the 2-phase create method.
1782 self.this = pre.this
1783 self.thisown = pre.thisown
1785 if hasattr(self, '_setOORInfo'):
1786 self._setOORInfo(self)
1787 if hasattr(self, '_setCallbackInfo'):
1788 self._setCallbackInfo(self, self.__class__)
1800 def DLG_PNT(win, point_or_x, y=None):
1802 Convenience function for converting a Point or (x,y) in
1803 dialog units to pixel units.
1806 return win.ConvertDialogPointToPixels(point_or_x)
1808 return win.ConvertDialogPointToPixels(wx.Point(point_or_x, y))
1810 def DLG_SZE(win, size_width, height=None):
1812 Convenience function for converting a Size or (w,h) in
1813 dialog units to pixel units.
1816 return win.ConvertDialogSizeToPixels(size_width)
1818 return win.ConvertDialogSizeToPixels(wx.Size(size_width, height))
1824 // Unfortunatly the names of these new static methods clash with the
1825 // names wxPython has been using forever for the overloaded
1826 // wxWindow::FindWindow, so instead of swigging them as statics create
1827 // standalone functions for them.
1830 DocStr(wxFindWindowById,
1831 "Find the first window in the application with the given id. If parent
1832 is None, the search will start from all top-level frames and dialog
1833 boxes; if non-None, the search will be limited to the given window
1834 hierarchy. The search is recursive in both cases.", "");
1836 DocStr(wxFindWindowByName,
1837 "Find a window by its name (as given in a window constructor or Create
1838 function call). If parent is None, the search will start from all
1839 top-level frames and dialog boxes; if non-None, the search will be
1840 limited to the given window hierarchy. The search is recursive in both
1843 If no window with such name is found, wx.FindWindowByLabel is called.", "");
1845 DocStr(wxFindWindowByLabel,
1846 "Find a window by its label. Depending on the type of window, the label
1847 may be a window title or panel item label. If parent is None, the
1848 search will start from all top-level frames and dialog boxes; if
1849 non-None, the search will be limited to the given window
1850 hierarchy. The search is recursive in both cases.", "");
1854 wxWindow* wxFindWindowById( long id, const wxWindow *parent = NULL ) {
1855 return wxWindow::FindWindowById(id, parent);
1858 wxWindow* wxFindWindowByName( const wxString& name,
1859 const wxWindow *parent = NULL ) {
1860 return wxWindow::FindWindowByName(name, parent);
1863 wxWindow* wxFindWindowByLabel( const wxString& label,
1864 const wxWindow *parent = NULL ) {
1865 return wxWindow::FindWindowByLabel(label, parent);
1873 #include <wx/msw/private.h> // to get wxGetWindowId
1878 wxWindow* wxWindow_FromHWND(wxWindow* parent, unsigned long _hWnd) {
1880 WXHWND hWnd = (WXHWND)_hWnd;
1881 long id = wxGetWindowId(hWnd);
1882 wxWindow* win = new wxWindow;
1883 parent->AddChild(win);
1884 win->SetEventHandler(win);
1887 win->SubclassWin(hWnd);
1888 win->AdoptAttributesFromHWND();
1889 win->SetupColours();
1892 wxPyRaiseNotImplemented();
1898 //---------------------------------------------------------------------------
1899 //---------------------------------------------------------------------------
projects / wxWidgets.git / blob