1 \section{\class{wxWindow
}}\label{wxwindow
}
3 wxWindow is the base class for all windows. Any children of the window will be deleted
4 automatically by the destructor before the window itself is deleted.
6 Please note that we documented a number of handler functions (OnChar(), OnMouse() etc.) in this
7 help text. These must not be called by a user program and are documented only for illustration.
8 On several platforms, only a few of these handlers are actually written (they are not always
9 needed) and if you are uncertain on how to add a certain behaviour to a window class, intercept
10 the respective event as usual and call
\helpref{wxEvent::Skip
}{wxeventskip
} so that the native
11 platform can implement its native behaviour or just ignore the event if nothing needs to be
14 \wxheading{Derived from
}
16 \helpref{wxEvtHandler
}{wxevthandler
}\\
17 \helpref{wxObject
}{wxobject
}
19 \wxheading{Include files
}
23 \wxheading{Window styles
}
25 The following styles can apply to all windows, although they will not always make sense for a particular
26 window class or on all platforms.
29 \begin{twocollist
}\itemsep=
0pt
30 \twocolitem{\windowstyle{wxSIMPLE
\_BORDER}}{Displays a thin border around the window. wxBORDER is the old name
31 for this style. Windows only.
}
32 \twocolitem{\windowstyle{wxDOUBLE
\_BORDER}}{Displays a double border. Windows only.
}
33 \twocolitem{\windowstyle{wxSUNKEN
\_BORDER}}{Displays a sunken border.
}
34 \twocolitem{\windowstyle{wxRAISED
\_BORDER}}{Displays a raised border.
}
35 \twocolitem{\windowstyle{wxSTATIC
\_BORDER}}{Displays a border suitable for a static control. Windows only.
}
36 \twocolitem{\windowstyle{wxTRANSPARENT
\_WINDOW}}{The window is transparent, that is, it will not receive paint
37 events. Windows only.
}
38 \twocolitem{\windowstyle{wxNO
\_3D}}{Prevents the children of this window taking on
3D styles, even though
39 the application-wide policy is for
3D controls. Windows only.
}
40 \twocolitem{\windowstyle{wxTAB
\_TRAVERSAL}}{Use this to enable tab traversal for non-dialog windows.
}
41 \twocolitem{\windowstyle{wxWANTS
\_CHARS}}{Use this to indicate that the window
42 wants to get all char events - even for keys like TAB or ENTER which are
43 usually used for dialog navigation and which wouldn't be generated without
45 \twocolitem{\windowstyle{wxNO
\_FULLREPAINT\_ON\_RESIZE}}{Disables repainting
46 the window completely when its size is changed - you will have to repaint the
47 new window area manually if you use style. Currently only has effect for
49 \twocolitem{\windowstyle{wxVSCROLL
}}{Use this style to enable a vertical scrollbar. (Still used?)
}
50 \twocolitem{\windowstyle{wxHSCROLL
}}{Use this style to enable a horizontal scrollbar. (Still used?)
}
51 \twocolitem{\windowstyle{wxCLIP
\_CHILDREN}}{Use this style to eliminate flicker caused by the background being
52 repainted, then children being painted over them. Windows only.
}
55 See also
\helpref{window styles overview
}{windowstyles
}.
59 \helpref{Event handling overview
}{eventhandlingoverview
}
61 \latexignore{\rtfignore{\wxheading{Members
}}}
63 \membersection{wxWindow::wxWindow
}
65 \func{}{wxWindow
}{\void}
69 \func{}{wxWindow
}{\param{wxWindow*
}{ parent
},
\param{wxWindowID
}{id
},
70 \param{const wxPoint\&
}{pos = wxDefaultPosition
},
71 \param{const wxSize\&
}{size = wxDefaultSize
},
72 \param{long
}{style =
0},
73 \param{const wxString\&
}{name = wxPanelNameStr
}}
75 Constructs a window, which can be a child of a frame, dialog or any other non-control window.
77 \wxheading{Parameters
}
79 \docparam{parent
}{Pointer to a parent window.
}
81 \docparam{id
}{Window identifier. If -
1, will automatically create an identifier.
}
83 \docparam{pos
}{Window position. wxDefaultPosition is (-
1, -
1) which indicates that wxWindows
84 should generate a default position for the window. If using the wxWindow class directly, supply
87 \docparam{size
}{Window size. wxDefaultSize is (-
1, -
1) which indicates that wxWindows
88 should generate a default size for the window. If no suitable size can be found, the
89 window will be sized to
20x20 pixels so that the window is visible but obviously not
92 \docparam{style
}{Window style. For generic window styles, please see
\helpref{wxWindow
}{wxwindow
}.
}
94 \docparam{name
}{Window name.
}
96 \membersection{wxWindow::
\destruct{wxWindow
}}
98 \func{}{\destruct{wxWindow
}}{\void}
100 Destructor. Deletes all subwindows, then deletes itself. Instead of using
101 the
{\bf delete
} operator explicitly, you should normally
102 use
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} so that wxWindows
103 can delete a window only when it is safe to do so, in idle time.
107 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
108 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
109 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
110 \helpref{wxCloseEvent
}{wxcloseevent
}
112 \membersection{wxWindow::AddChild
}
114 \func{virtual void
}{AddChild
}{\param{wxWindow*
}{child
}}
116 Adds a child window. This is called automatically by window creation
117 functions so should not be required by the application programmer.
119 \wxheading{Parameters
}
121 \docparam{child
}{Child window to add.
}
123 \membersection{wxWindow::CaptureMouse
}\label{wxwindowcapturemouse
}
125 \func{virtual void
}{CaptureMouse
}{\void}
127 Directs all mouse input to this window. Call
\helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
} to
132 \helpref{wxWindow::ReleaseMouse
}{wxwindowreleasemouse
}
134 \membersection{wxWindow::Center
}\label{wxwindowcenter
}
136 \func{void
}{Center
}{\param{int
}{ direction
}}
138 A synonym for
\helpref{Centre
}{wxwindowcentre
}.
140 \membersection{wxWindow::CenterOnParent
}\label{wxwindowcenteronparent
}
142 \func{void
}{CenterOnParent
}{\param{int
}{ direction
}}
144 A synonym for
\helpref{CentreOnParent
}{wxwindowcentreonparent
}.
146 \membersection{wxWindow::Centre
}\label{wxwindowcentre
}
148 \func{void
}{Centre
}{\param{int
}{ direction = wxHORIZONTAL
}}
152 \wxheading{Parameters
}
154 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
155 or
{\tt wxBOTH
}. It may also include
{\tt wxCENTRE
\_ON\_SCREEN} flag
156 if you want to center the window on the entire screen and not on its
159 The flag
{\tt wxCENTRE
\_FRAME} is obsolete and should not be used any longer.
163 If the window is a top level one (i.e. doesn't have a parent), it will be
164 centered relative to the screen anyhow.
168 \helpref{wxWindow::Center
}{wxwindowcenter
}
170 \membersection{wxWindow::CentreOnParent
}\label{wxwindowcentreonparent
}
172 \func{void
}{CentreOnParent
}{\param{int
}{ direction = wxHORIZONTAL
}}
176 \wxheading{Parameters
}
178 \docparam{direction
}{Specifies the direction for the centering. May be
{\tt wxHORIZONTAL
},
{\tt wxVERTICAL
}\rtfsp
183 This methods provides for a way to center top level windows over their
184 parents instead of the entire screen. If there is no parent or if the
185 window is not a top level window, then behaviour is the same as
186 \helpref{wxWindow::Centre
}{wxwindowcentre
}.
190 \helpref{wxWindow::CenterOnParent
}{wxwindowcenteronparent
}
192 \membersection{wxWindow::Clear
}\label{wxwindowclear
}
194 \func{void
}{Clear
}{\void}
196 Clears the window by filling it with the current background colour. Does not
197 cause an erase background event to be generated.
199 \membersection{wxWindow::ClientToScreen
}
201 \constfunc{virtual void
}{ClientToScreen
}{\param{int*
}{x
},
\param{int*
}{y
}}
203 \constfunc{virtual wxPoint
}{ClientToScreen
}{\param{const wxPoint\&
}{ pt
}}
205 Converts to screen coordinates from coordinates relative to this window.
207 \docparam{x
}{A pointer to a integer value for the x coordinate. Pass the client coordinate in, and
208 a screen coordinate will be passed out.
}
210 \docparam{y
}{A pointer to a integer value for the y coordinate. Pass the client coordinate in, and
211 a screen coordinate will be passed out.
}
213 \docparam{pt
}{The client position for the second form of the function.
}
215 \pythonnote{In place of a single overloaded method name, wxPython
216 implements the following methods:
\par
217 \indented{2cm
}{\begin{twocollist
}
218 \twocolitem{\bf{ClientToScreen(point)
}}{Accepts and returns a wxPoint
}
219 \twocolitem{\bf{ClientToScreenXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
224 \membersection{wxWindow::Close
}\label{wxwindowclose
}
226 \func{virtual bool
}{Close
}{\param{const bool
}{ force = FALSE
}}
228 The purpose of this call is to provide a safer way of destroying a window than using
229 the
{\it delete
} operator.
231 \wxheading{Parameters
}
233 \docparam{force
}{FALSE if the window's close handler should be able to veto the destruction
234 of this window, TRUE if it cannot.
}
238 Close calls the
\helpref{close handler
}{wxcloseevent
} for the window, providing an opportunity for the window to
239 choose whether to destroy the window.
241 The close handler should check whether the window is being deleted forcibly,
242 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}, in which case it should
243 destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
245 Applies to managed windows (wxFrame and wxDialog classes) only.
247 {\it Note
} that calling Close does not guarantee that the window will be destroyed; but it
248 provides a way to simulate a manual close of a window, which may or may not be implemented by
249 destroying the window. The default implementation of wxDialog::OnCloseWindow does not
250 necessarily delete the dialog, since it will simply simulate an wxID
\_CANCEL event which
251 itself only hides the dialog.
253 To guarantee that the window will be destroyed, call
\helpref{wxWindow::Destroy
}{wxwindowdestroy
} instead.
257 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
258 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
259 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
260 \helpref{wxCloseEvent
}{wxcloseevent
}
262 \membersection{wxWindow::ConvertDialogToPixels
}\label{wxwindowconvertdialogtopixels
}
264 \func{wxPoint
}{ConvertDialogToPixels
}{\param{const wxPoint\&
}{ pt
}}
266 \func{wxSize
}{ConvertDialogToPixels
}{\param{const wxSize\&
}{ sz
}}
268 Converts a point or size from dialog units to pixels.
270 For the x dimension, the dialog units are multiplied by the average character width
271 and then divided by
4.
273 For the y dimension, the dialog units are multiplied by the average character height
274 and then divided by
8.
278 Dialog units are used for maintaining a dialog's proportions even if the font changes.
279 Dialogs created using Dialog Editor optionally use dialog units.
281 You can also use these functions programmatically. A convenience macro is defined:
285 #define wxDLG_UNIT(parent, pt) parent->ConvertDialogToPixels(pt)
291 \helpref{wxWindow::ConvertPixelsToDialog
}{wxwindowconvertpixelstodialog
}
293 \pythonnote{In place of a single overloaded method name, wxPython
294 implements the following methods:
\par
295 \indented{2cm
}{\begin{twocollist
}
296 \twocolitem{\bf{ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
297 \twocolitem{\bf{ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
300 Additionally, the following helper functions are defined:
\par
301 \indented{2cm
}{\begin{twocollist
}
302 \twocolitem{\bf{wxDLG
\_PNT(win, point)
}}{Converts a wxPoint from dialog
304 \twocolitem{\bf{wxDLG
\_SZE(win, size)
}}{Converts a wxSize from dialog
310 \membersection{wxWindow::ConvertPixelsToDialog
}\label{wxwindowconvertpixelstodialog
}
312 \func{wxPoint
}{ConvertPixelsToDialog
}{\param{const wxPoint\&
}{ pt
}}
314 \func{wxSize
}{ConvertPixelsToDialog
}{\param{const wxSize\&
}{ sz
}}
316 Converts a point or size from pixels to dialog units.
318 For the x dimension, the pixels are multiplied by
4 and then divided by the average
321 For the y dimension, the pixels are multipled by
8 and then divided by the average
326 Dialog units are used for maintaining a dialog's proportions even if the font changes.
327 Dialogs created using Dialog Editor optionally use dialog units.
331 \helpref{wxWindow::ConvertDialogToPixels
}{wxwindowconvertdialogtopixels
}
334 \pythonnote{In place of a single overloaded method name, wxPython
335 implements the following methods:
\par
336 \indented{2cm
}{\begin{twocollist
}
337 \twocolitem{\bf{ConvertDialogPointToPixels(point)
}}{Accepts and returns a wxPoint
}
338 \twocolitem{\bf{ConvertDialogSizeToPixels(size)
}}{Accepts and returns a wxSize
}
342 \membersection{wxWindow::Destroy
}\label{wxwindowdestroy
}
344 \func{virtual bool
}{Destroy
}{\void}
346 Destroys the window safely. Use this function instead of the delete operator, since
347 different window classes can be destroyed differently. Frames and dialogs
348 are not destroyed immediately when this function is called - they are added
349 to a list of windows to be deleted on idle time, when all the window's events
350 have been processed. This prevents problems with events being sent to non-existant
353 \wxheading{Return value
}
355 TRUE if the window has either been successfully deleted, or it has been added
356 to the list of windows pending real deletion.
358 \membersection{wxWindow::DestroyChildren
}
360 \func{virtual void
}{DestroyChildren
}{\void}
362 Destroys all children of a window. Called automatically by the destructor.
364 \membersection{wxWindow::DragAcceptFiles
}\label{wxwindowdragacceptfiles
}
366 \func{virtual void
}{DragAcceptFiles
}{\param{const bool
}{ accept
}}
368 Enables or disables elibility for drop file events (OnDropFiles).
370 \wxheading{Parameters
}
372 \docparam{accept
}{If TRUE, the window is eligible for drop file events. If FALSE, the window
373 will not accept drop file events.
}
381 \helpref{wxWindow::OnDropFiles
}{wxwindowondropfiles
}
383 \membersection{wxWindow::Enable
}\label{wxwindowenable
}
385 \func{virtual void
}{Enable
}{\param{const bool
}{ enable
}}
387 Enable or disable the window for user input.
389 \wxheading{Parameters
}
391 \docparam{enable
}{If TRUE, enables the window for input. If FALSE, disables the window.
}
395 \helpref{wxWindow::IsEnabled
}{wxwindowisenabled
}
397 \membersection{wxWindow::FindFocus
}\label{wxwindowfindfocus
}
399 \func{static wxWindow*
}{FindFocus
}{\void}
401 Finds the window or control which currently has the keyboard focus.
405 Note that this is a static function, so it can be called without needing a wxWindow pointer.
409 \helpref{wxWindow::SetFocus
}{wxwindowsetfocus
}
411 \membersection{wxWindow::FindWindow
}\label{wxwindowfindwindow
}
413 \func{wxWindow*
}{FindWindow
}{\param{long
}{ id
}}
415 Find a child of this window, by identifier.
417 \func{wxWindow*
}{FindWindow
}{\param{const wxString\&
}{ name
}}
419 Find a child of this window, by name.
421 \pythonnote{In place of a single overloaded method name, wxPython
422 implements the following methods:
\par
423 \indented{2cm
}{\begin{twocollist
}
424 \twocolitem{\bf{FindWindowById(id)
}}{Accepts an integer
}
425 \twocolitem{\bf{FindWindowByName(name)
}}{Accepts a string
}
429 \membersection{wxWindow::Fit
}\label{wxwindowfit
}
431 \func{virtual void
}{Fit
}{\void}
433 Sizes the window so that it fits around its subwindows.
435 \membersection{wxWindow::GetBackgroundColour
}\label{wxwindowgetbackgroundcolour
}
437 \constfunc{virtual wxColour
}{GetBackgroundColour
}{\void}
439 Returns the background colour of the window.
443 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
444 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
445 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
446 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
}
448 \membersection{wxWindow::GetCharHeight
}
450 \constfunc{virtual int
}{GetCharHeight
}{\void}
452 Returns the character height for this window.
454 \membersection{wxWindow::GetCharWidth
}
456 \constfunc{virtual int
}{GetCharWidth
}{\void}
458 Returns the average character width for this window.
460 \membersection{wxWindow::GetChildren
}
462 \func{wxList\&
}{GetChildren
}{\void}
464 Returns a reference to the list of the window's children.
466 \membersection{wxWindow::GetClientSize
}\label{wxwindowgetclientsize
}
468 \constfunc{virtual void
}{GetClientSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
470 \constfunc{virtual wxSize
}{GetClientSize
}{\void}
472 This gets the size of the window `client area' in pixels. The client area is the
473 area which may be drawn on by the programmer, excluding title bar, border etc.
475 \wxheading{Parameters
}
477 \docparam{width
}{Receives the client width in pixels.
}
479 \docparam{height
}{Receives the client height in pixels.
}
481 \pythonnote{In place of a single overloaded method name, wxPython
482 implements the following methods:
\par
483 \indented{2cm
}{\begin{twocollist
}
484 \twocolitem{\bf{wxGetClientSizeTuple()
}}{Returns a
2-tuple of (width, height)
}
485 \twocolitem{\bf{wxGetClientSize()
}}{Returns a wxSize object
}
489 \membersection{wxWindow::GetConstraints
}\label{wxwindowgetconstraints
}
491 \constfunc{wxLayoutConstraints*
}{GetConstraints
}{\void}
493 Returns a pointer to the window's layout constraints, or NULL if there are none.
495 \membersection{wxWindow::GetDefaultItem
}\label{wxwindowgetdefaultitem
}
497 \constfunc{wxButton*
}{GetDefaultItem
}{\void}
499 Returns a pointer to the button which is the default for this window, or NULL.
501 \membersection{wxWindow::GetDropTarget
}\label{wxwindowgetdroptarget
}
503 \constfunc{wxDropTarget*
}{GetDropTarget
}{\void}
505 Returns the associated drop target, which may be NULL.
509 \helpref{wxWindow::SetDropTarget
}{wxwindowsetdroptarget
},
510 \helpref{Drag and drop overview
}{wxdndoverview
}
512 \membersection{wxWindow::GetEventHandler
}\label{wxwindowgeteventhandler
}
514 \constfunc{wxEvtHandler*
}{GetEventHandler
}{\void}
516 Returns the event handler for this window. By default, the window is its
521 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
522 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
523 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
524 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
525 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
527 \membersection{wxWindow::GetFont
}\label{wxwindowgetfont
}
529 \constfunc{wxFont\&
}{GetFont
}{\void}
531 Returns a reference to the font for this window.
535 \helpref{wxWindow::SetFont
}{wxwindowsetfont
}
537 \membersection{wxWindow::GetForegroundColour
}\label{wxwindowgetforegroundcolour
}
539 \func{virtual wxColour
}{GetForegroundColour
}{\void}
541 Returns the foreground colour of the window.
545 The interpretation of foreground colour is open to interpretation according
546 to the window class; it may be the text colour or other colour, or it may not
551 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
552 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
553 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
555 \membersection{wxWindow::GetGrandParent
}
557 \constfunc{wxWindow*
}{GetGrandParent
}{\void}
559 Returns the grandparent of a window, or NULL if there isn't one.
561 \membersection{wxWindow::GetHandle
}
563 \constfunc{void*
}{GetHandle
}{\void}
565 Returns the platform-specific handle of the physical window. Cast it to an appropriate
566 handle, such as
{\bf HWND
} for Windows,
{\bf Widget
} for Motif or
{\bf GtkWidget
} for GTK.
568 \membersection{wxWindow::GetId
}\label{wxwindowgetid
}
570 \constfunc{int
}{GetId
}{\void}
572 Returns the identifier of the window.
576 Each window has an integer identifier. If the application has not provided one
577 (or the default Id -
1) an unique identifier with a negative value will be generated.
581 \helpref{wxWindow::SetId
}{wxwindowsetid
}\rtfsp
582 \helpref{Window identifiers
}{windowids
}
584 \membersection{wxWindow::GetPosition
}
586 \constfunc{virtual void
}{GetPosition
}{\param{int*
}{x
},
\param{int*
}{y
}}
588 This gets the position of the window in pixels, relative to the parent window or
589 if no parent, relative to the whole display.
591 \wxheading{Parameters
}
593 \docparam{x
}{Receives the x position of the window.
}
595 \docparam{y
}{Receives the y position of the window.
}
597 \pythonnote{In place of a single overloaded method name, wxPython
598 implements the following methods:
\par
599 \indented{2cm
}{\begin{twocollist
}
600 \twocolitem{\bf{GetPosition()
}}{Returns a wxPoint
}
601 \twocolitem{\bf{GetPositionTuple()
}}{Returns a tuple (x, y)
}
605 \membersection{wxWindow::GetLabel
}
607 \constfunc{virtual wxString
}{GetLabel
}{\void}
609 Generic way of getting a label from any window, for
610 identification purposes.
614 The interpretation of this function differs from class to class.
615 For frames and dialogs, the value returned is the title. For buttons or static text controls, it is
616 the button text. This function can be useful for meta-programs (such as testing
617 tools or special-needs access programs) which need to identify windows
620 \membersection{wxWindow::GetName
}\label{wxwindowgetname
}
622 \constfunc{virtual wxString
}{GetName
}{\void}
624 Returns the window's name.
628 This name is not guaranteed to be unique; it is up to the programmer to supply an appropriate
629 name in the window constructor or via
\helpref{wxWindow::SetName
}{wxwindowsetname
}.
633 \helpref{wxWindow::SetName
}{wxwindowsetname
}
635 \membersection{wxWindow::GetParent
}
637 \constfunc{virtual wxWindow*
}{GetParent
}{\void}
639 Returns the parent of the window, or NULL if there is no parent.
641 \membersection{wxWindow::GetRect
}\label{wxwindowgetrect
}
643 \constfunc{virtual wxRect
}{GetRect
}{\void}
645 Returns the size and position of the window as a
\helpref{wxRect
}{wxrect
} object.
647 \membersection{wxWindow::GetScrollThumb
}\label{wxwindowgetscrollthumb
}
649 \func{virtual int
}{GetScrollThumb
}{\param{int
}{orientation
}}
651 Returns the built-in scrollbar thumb size.
655 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
657 \membersection{wxWindow::GetScrollPos
}\label{wxwindowgetscrollpos
}
659 \func{virtual int
}{GetScrollPos
}{\param{int
}{orientation
}}
661 Returns the built-in scrollbar position.
665 See
\helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
667 \membersection{wxWindow::GetScrollRange
}\label{wxwindowgetscrollrange
}
669 \func{virtual int
}{GetScrollRange
}{\param{int
}{orientation
}}
671 Returns the built-in scrollbar range.
675 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
}
677 \membersection{wxWindow::GetSize
}\label{wxwindowgetsize
}
679 \constfunc{virtual void
}{GetSize
}{\param{int*
}{width
},
\param{int*
}{height
}}
681 \constfunc{virtual wxSize
}{GetSize
}{\void}
683 This gets the size of the entire window in pixels.
685 \wxheading{Parameters
}
687 \docparam{width
}{Receives the window width.
}
689 \docparam{height
}{Receives the window height.
}
691 \pythonnote{In place of a single overloaded method name, wxPython
692 implements the following methods:
\par
693 \indented{2cm
}{\begin{twocollist
}
694 \twocolitem{\bf{GetSize()
}}{Returns a wxSize
}
695 \twocolitem{\bf{GetSizeTuple()
}}{Returns a
2-tuple (width, height)
}
699 \membersection{wxWindow::GetTextExtent
}
701 \constfunc{virtual void
}{GetTextExtent
}{\param{const wxString\&
}{string
},
\param{int*
}{x
},
\param{int*
}{y
},
702 \param{int*
}{descent = NULL
},
\param{int*
}{externalLeading = NULL
},
703 \param{const wxFont*
}{font = NULL
},
\param{const bool
}{ use16 = FALSE
}}
705 Gets the dimensions of the string as it would be drawn on the
706 window with the currently selected font.
708 \wxheading{Parameters
}
710 \docparam{string
}{String whose extent is to be measured.
}
712 \docparam{x
}{Return value for width.
}
714 \docparam{y
}{Return value for height.
}
716 \docparam{descent
}{Return value for descent (optional).
}
718 \docparam{externalLeading
}{Return value for external leading (optional).
}
720 \docparam{font
}{Font to use instead of the current window font (optional).
}
722 \docparam{use16
}{If TRUE,
{\it string
} contains
16-bit characters. The default is FALSE.
}
725 \pythonnote{In place of a single overloaded method name, wxPython
726 implements the following methods:
\par
727 \indented{2cm
}{\begin{twocollist
}
728 \twocolitem{\bf{GetTextExtent(string)
}}{Returns a
2-tuple, (width, height)
}
729 \twocolitem{\bf{GetFullTextExtent(string, font=NULL)
}}{Returns a
730 4-tuple, (width, height, descent, externalLeading)
}
735 \membersection{wxWindow::GetTitle
}\label{wxwindowgettitle
}
737 \func{virtual wxString
}{GetTitle
}{\void}
739 Gets the window's title. Applicable only to frames and dialogs.
743 \helpref{wxWindow::SetTitle
}{wxwindowsettitle
}
745 \membersection{wxWindow::GetUpdateRegion
}\label{wxwindowgetupdateregion
}
747 \constfunc{virtual wxRegion
}{GetUpdateRegion
}{\void}
749 Returns the region specifying which parts of the window have been damaged. Should
750 only be called within an
\helpref{OnPaint
}{wxwindowonpaint
} event handler.
754 \helpref{wxRegion
}{wxregion
},
\helpref{wxRegionIterator
}{wxregioniterator
},
\helpref{wxWindow::OnPaint
}{wxwindowonpaint
}
756 \membersection{wxWindow::GetValidator
}\label{wxwindowgetvalidator
}
758 \constfunc{wxValidator*
}{GetValidator
}{\void}
760 Returns a pointer to the current validator for the window, or NULL if there is none.
762 \membersection{wxWindow::GetWindowStyleFlag
}
764 \constfunc{long
}{GetWindowStyleFlag
}{\void}
766 Gets the window style that was passed to the consructor or
{\bf Create
} member.
767 {\bf GetWindowStyle
} is synonymous.
769 \membersection{wxWindow::InitDialog
}\label{wxwindowinitdialog
}
771 \func{void
}{InitDialog
}{\void}
773 Sends an
\helpref{wxWindow::OnInitDialog
}{wxwindowoninitdialog
} event, which
774 in turn transfers data to the dialog via validators.
778 \helpref{wxWindow::OnInitDialog
}{wxwindowoninitdialog
}
780 \membersection{wxWindow::IsEnabled
}\label{wxwindowisenabled
}
782 \constfunc{virtual bool
}{IsEnabled
}{\void}
784 Returns TRUE if the window is enabled for input, FALSE otherwise.
788 \helpref{wxWindow::Enable
}{wxwindowenable
}
790 \membersection{wxWindow:IsExposed
}\label{wxwindowisexposed
}
792 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
}}
794 \constfunc{bool
}{IsExposed
}{\param{wxPoint
}{&pt
}}
796 \constfunc{bool
}{IsExposed
}{\param{int
}{x
},
\param{int
}{y
},
\param{int
}{w
},
\param{int
}{h
}}
798 \constfunc{bool
}{IsExposed
}{\param{wxRect
}{&rect
}}
800 Returns TRUE if the given point or rectange area has been exposed since the
801 last repaint. Call this in an paint event handler to optimize redrawing by
802 only redrawing those areas, which have been exposed.
804 \membersection{wxWindow::IsRetained
}\label{wxwindowisretained
}
806 \constfunc{virtual bool
}{IsRetained
}{\void}
808 Returns TRUE if the window is retained, FALSE otherwise.
812 Retained windows are only available on X platforms.
814 \membersection{wxWindow::IsShown
}\label{wxwindowisshown
}
816 \constfunc{virtual bool
}{IsShown
}{\void}
818 Returns TRUE if the window is shown, FALSE if it has been hidden.
820 \membersection{wxWindow::IsTopLevel
}\label{wxwindowistoplevel
}
822 \constfunc{bool
}{IsTopLevel
}{\void}
824 Returns TRUE if the given window is a top-level one. Currently all frames and
825 dialogs are considered to be top-level windows (even if they have a parent
828 \membersection{wxWindow::Layout
}\label{wxwindowlayout
}
830 \func{void
}{Layout
}{\void}
832 Invokes the constraint-based layout algorithm or the sizer-based algorithm
835 See
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} on when
836 this function gets called automatically using auto layout.
838 \membersection{wxWindow::LoadFromResource
}\label{wxwindowloadfromresource
}
840 \func{virtual bool
}{LoadFromResource
}{\param{wxWindow*
}{parent
},
\rtfsp
841 \param{const wxString\&
}{resourceName
},
\param{const wxResourceTable*
}{resourceTable = NULL
}}
843 Loads a panel or dialog from a resource file.
845 \wxheading{Parameters
}
847 \docparam{parent
}{Parent window.
}
849 \docparam{resourceName
}{The name of the resource to load.
}
851 \docparam{resourceTable
}{The resource table to load it from. If this is NULL, the
852 default resource table will be used.
}
854 \wxheading{Return value
}
856 TRUE if the operation succeeded, otherwise FALSE.
858 \membersection{wxWindow::Lower
}\label{wxwindowlower
}
860 \func{void
}{Lower
}{\void}
862 Lowers the window to the bottom of the window hierarchy if it is a managed window (dialog
865 \membersection{wxWindow::MakeModal
}\label{wxwindowmakemodal
}
867 \func{virtual void
}{MakeModal
}{\param{const bool
}{flag
}}
869 Disables all other windows in the application so that
870 the user can only interact with this window. (This function
871 is not implemented anywhere).
873 \wxheading{Parameters
}
875 \docparam{flag
}{If TRUE, this call disables all other windows in the application so that
876 the user can only interact with this window. If FALSE, the effect is reversed.
}
878 \membersection{wxWindow::Move
}\label{wxwindowmove
}
880 \func{void
}{Move
}{\param{int
}{ x
},
\param{int
}{ y
}}
882 \func{void
}{Move
}{\param{const wxPoint\&
}{ pt
}}
884 Moves the window to the given position.
886 \wxheading{Parameters
}
888 \docparam{x
}{Required x position.
}
890 \docparam{y
}{Required y position.
}
892 \docparam{pt
}{\helpref{wxPoint
}{wxpoint
} object representing the position.
}
896 Implementations of SetSize can also implicitly implement the
897 wxWindow::Move function, which is defined in the base wxWindow class
901 SetSize(x, y, -
1, -
1, wxSIZE_USE_EXISTING);
906 \helpref{wxWindow::SetSize
}{wxwindowsetsize
}
908 \pythonnote{In place of a single overloaded method name, wxPython
909 implements the following methods:
\par
910 \indented{2cm
}{\begin{twocollist
}
911 \twocolitem{\bf{Move(point)
}}{Accepts a wxPoint
}
912 \twocolitem{\bf{MoveXY(x, y)
}}{Accepts a pair of integers
}
916 \membersection{wxWindow::OnActivate
}\label{wxwindowonactivate
}
918 \func{void
}{OnActivate
}{\param{wxActivateEvent\&
}{ event
}}
920 Called when a window is activated or deactivated.
922 \wxheading{Parameters
}
924 \docparam{event
}{Object containing activation information.
}
928 If the window is being activated,
\helpref{wxActivateEvent::GetActive
}{wxactivateeventgetactive
} returns TRUE,
929 otherwise it returns FALSE (it is being deactivated).
933 \helpref{wxActivateEvent
}{wxactivateevent
},
\rtfsp
934 \helpref{Event handling overview
}{eventhandlingoverview
}
936 \membersection{wxWindow::OnChar
}\label{wxwindowonchar
}
938 \func{void
}{OnChar
}{\param{wxKeyEvent\&
}{ event
}}
940 Called when the user has pressed a key that is not a modifier (SHIFT, CONTROL or ALT).
942 \wxheading{Parameters
}
944 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
945 details about this class.
}
949 This member function is called in response to a keypress. To intercept this event,
950 use the EVT
\_CHAR macro in an event table definition. Your
{\bf OnChar
} handler may call this
951 default function to achieve default keypress functionality.
953 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
956 Note that not all keypresses can be intercepted this way. If you wish to intercept modifier
957 keypresses, then you will need to use
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
} or
958 \helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
}.
960 Most, but not all, windows allow keypresses to be intercepted.
964 \helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
},
\helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
},
\rtfsp
965 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
966 \helpref{Event handling overview
}{eventhandlingoverview
}
968 \membersection{wxWindow::OnCharHook
}\label{wxwindowoncharhook
}
970 \func{void
}{OnCharHook
}{\param{wxKeyEvent\&
}{ event
}}
972 This member is called to allow the window to intercept keyboard events
973 before they are processed by child windows.
975 \wxheading{Parameters
}
977 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
978 details about this class.
}
982 This member function is called in response to a keypress, if the window is active. To intercept this event,
983 use the EVT
\_CHAR\_HOOK macro in an event table definition. If you do not process a particular
984 keypress, call
\helpref{wxEvent::Skip
}{wxeventskip
} to allow default processing.
986 An example of using this function is in the implementation of escape-character processing for wxDialog,
987 where pressing ESC dismisses the dialog by
{\bf OnCharHook
} 'forging' a cancel button press event.
989 Note that the ASCII values do not have explicit key codes: they are passed as ASCII
992 This function is only relevant to top-level windows (frames and dialogs), and under
993 Windows only. Under GTK the normal EVT
\_CHAR\_ event has the functionality, i.e.
994 you can intercepts it and if you don't call
\helpref{wxEvent::Skip
}{wxeventskip
}
995 the window won't get the event.
999 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1000 \helpref{wxApp::OnCharHook
}{wxapponcharhook
},
\rtfsp
1001 \helpref{Event handling overview
}{eventhandlingoverview
}
1003 \membersection{wxWindow::OnCommand
}\label{wxwindowoncommand
}
1005 \func{virtual void
}{OnCommand
}{\param{wxEvtHandler\&
}{object
},
\param{wxCommandEvent\&
}{event
}}
1007 This virtual member function is called if the control does not handle the command event.
1009 \wxheading{Parameters
}
1011 \docparam{object
}{Object receiving the command event.
}
1013 \docparam{event
}{Command event
}
1017 This virtual function is provided mainly for backward compatibility. You can also intercept commands
1018 from child controls by using an event table, with identifiers or identifier ranges to identify
1019 the control(s) in question.
1021 \wxheading{See also
}
1023 \helpref{wxCommandEvent
}{wxcommandevent
},
\rtfsp
1024 \helpref{Event handling overview
}{eventhandlingoverview
}
1026 \membersection{wxWindow::OnClose
}\label{wxwindowonclose
}
1028 \func{virtual bool
}{OnClose
}{\void}
1030 Called when the user has tried to close a a frame
1031 or dialog box using the window manager (X) or system menu (Windows).
1033 {\bf Note:
} This is an obsolete function.
1034 It is superceded by the
\helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
} event
1037 \wxheading{Return value
}
1039 If TRUE is returned by OnClose, the window will be deleted by the system, otherwise the
1040 attempt will be ignored. Do not delete the window from within this handler, although
1041 you may delete other windows.
1043 \wxheading{See also
}
1045 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
1046 \helpref{wxWindow::Close
}{wxwindowclose
},
\rtfsp
1047 \helpref{wxWindow::OnCloseWindow
}{wxwindowonclosewindow
},
\rtfsp
1048 \helpref{wxCloseEvent
}{wxcloseevent
}
1050 \membersection{wxWindow::OnCloseWindow
}\label{wxwindowonclosewindow
}
1052 \func{void
}{OnCloseWindow
}{\param{wxCloseEvent\&
}{event
}}
1054 This is an event handler function called when the user has tried to close a a frame
1055 or dialog box using the window manager (X) or system menu (Windows). It is
1056 called via the
\helpref{wxWindow::Close
}{wxwindowclose
} function, so
1057 that the application can also invoke the handler programmatically.
1059 Use the EVT
\_CLOSE event table macro to handle close events.
1061 You should check whether the application is forcing the deletion of the window
1062 using
\helpref{wxCloseEvent::GetForce
}{wxcloseeventgetforce
}. If this is TRUE,
1063 destroy the window using
\helpref{wxWindow::Destroy
}{wxwindowdestroy
}.
1064 If not, it is up to you whether you respond by destroying the window.
1066 (Note: GetForce is now superceded by CanVeto. So to test whether forced destruction of
1067 the window is required, test for the negative of CanVeto. If CanVeto returns FALSE,
1068 it is not possible to skip window deletion.)
1070 If you don't destroy the window, you should call
\helpref{wxCloseEvent::Veto
}{wxcloseeventveto
} to
1071 let the calling code know that you did not destroy the window. This allows the
\helpref{wxWindow::Close
}{wxwindowclose
} function
1072 to return TRUE or FALSE depending on whether the close instruction was honoured or not.
1076 The
\helpref{wxWindow::OnClose
}{wxwindowonclose
} virtual function remains
1077 for backward compatibility with earlier versions of wxWindows. The
1078 default
{\bf OnCloseWindow
} handler for wxFrame and wxDialog will call
{\bf OnClose
},
1079 destroying the window if it returns TRUE or if the close is being forced.
1081 \wxheading{See also
}
1083 \helpref{Window deletion overview
}{windowdeletionoverview
},
\rtfsp
1084 \helpref{wxWindow::Close
}{wxwindowclose
},
\rtfsp
1085 \helpref{wxWindow::OnClose
}{wxwindowonclose
},
\rtfsp
1086 \helpref{wxWindow::Destroy
}{wxwindowdestroy
},
\rtfsp
1087 \helpref{wxCloseEvent
}{wxcloseevent
},
\rtfsp
1088 \helpref{wxApp::OnQueryEndSession
}{wxapponqueryendsession
},
\rtfsp
1089 \helpref{wxApp::OnEndSession
}{wxapponendsession
}
1091 \membersection{wxWindow::OnDropFiles
}\label{wxwindowondropfiles
}
1093 \func{void
}{OnDropFiles
}{\param{wxDropFilesEvent\&
}{ event
}}
1095 Called when files have been dragged from the file manager to the window.
1097 \wxheading{Parameters
}
1099 \docparam{event
}{Drop files event. For more information, see
\helpref{wxDropFilesEvent
}{wxdropfilesevent
}.
}
1103 The window must have previously been enabled for dropping by calling
1104 \rtfsp\helpref{wxWindow::DragAcceptFiles
}{wxwindowdragacceptfiles
}.
1106 This event is only generated under Windows.
1108 To intercept this event, use the EVT
\_DROP\_FILES macro in an event table definition.
1110 \wxheading{See also
}
1112 \helpref{wxDropFilesEvent
}{wxdropfilesevent
},
\helpref{wxWindow::DragAcceptFiles
}{wxwindowdragacceptfiles
},
\rtfsp
1113 \helpref{Event handling overview
}{eventhandlingoverview
}
1115 \membersection{wxWindow::OnEraseBackground
}\label{wxwindowonerasebackground
}
1117 \func{void
}{OnEraseBackground
}{\param{wxEraseEvent\&
}{ event
}}
1119 Called when the background of the window needs to be erased.
1121 \wxheading{Parameters
}
1123 \docparam{event
}{Erase background event. For more information, see
\helpref{wxEraseEvent
}{wxeraseevent
}.
}
1127 This event is only generated under Windows. It is therefore recommended that
1128 you set the text background colour explicitly in order to prevent flicker.
1129 The default background colour under GTK is grey.
1131 To intercept this event, use the EVT
\_ERASE\_BACKGROUND macro in an event table definition.
1133 \wxheading{See also
}
1135 \helpref{wxEraseEvent
}{wxeraseevent
},
\helpref{Event handling overview
}{eventhandlingoverview
}
1137 \membersection{wxWindow::OnKeyDown
}\label{wxwindowonkeydown
}
1139 \func{void
}{OnKeyDown
}{\param{wxKeyEvent\&
}{ event
}}
1141 Called when the user has pressed a key, before it is translated into an ASCII value using other
1142 modifier keys that might be pressed at the same time.
1144 \wxheading{Parameters
}
1146 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
1147 details about this class.
}
1151 This member function is called in response to a key down event. To intercept this event,
1152 use the EVT
\_KEY\_DOWN macro in an event table definition. Your
{\bf OnKeyDown
} handler may call this
1153 default function to achieve default keypress functionality.
1155 Note that not all keypresses can be intercepted this way. If you wish to intercept special
1156 keys, such as shift, control, and function keys, then you will need to use
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
} or
1157 \helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
}.
1159 Most, but not all, windows allow keypresses to be intercepted.
1161 \wxheading{See also
}
1163 \helpref{wxWindow::OnChar
}{wxwindowonchar
},
\helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
},
\rtfsp
1164 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1165 \helpref{Event handling overview
}{eventhandlingoverview
}
1167 \membersection{wxWindow::OnKeyUp
}\label{wxwindowonkeyup
}
1169 \func{void
}{OnKeyUp
}{\param{wxKeyEvent\&
}{ event
}}
1171 Called when the user has released a key.
1173 \wxheading{Parameters
}
1175 \docparam{event
}{Object containing keypress information. See
\helpref{wxKeyEvent
}{wxkeyevent
} for
1176 details about this class.
}
1180 This member function is called in response to a key up event. To intercept this event,
1181 use the EVT
\_KEY\_UP macro in an event table definition. Your
{\bf OnKeyUp
} handler may call this
1182 default function to achieve default keypress functionality.
1184 Note that not all keypresses can be intercepted this way. If you wish to intercept special
1185 keys, such as shift, control, and function keys, then you will need to use
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
} or
1186 \helpref{wxWindow::OnKeyUp
}{wxwindowonkeyup
}.
1188 Most, but not all, windows allow key up events to be intercepted.
1190 \wxheading{See also
}
1192 \helpref{wxWindow::OnChar
}{wxwindowonchar
},
\helpref{wxWindow::OnKeyDown
}{wxwindowonkeydown
},
\rtfsp
1193 \helpref{wxKeyEvent
}{wxkeyevent
},
\helpref{wxWindow::OnCharHook
}{wxwindowoncharhook
},
\rtfsp
1194 \helpref{Event handling overview
}{eventhandlingoverview
}
1196 \membersection{wxWindow::OnKillFocus
}\label{wxwindowonkillfocus
}
1198 \func{void
}{OnKillFocus
}{\param{wxFocusEvent\&
}{event
}}
1200 Called when a window's focus is being killed.
1202 \wxheading{Parameters
}
1204 \docparam{event
}{The focus event. For more information, see
\helpref{wxFocusEvent
}{wxfocusevent
}.
}
1208 To intercept this event, use the macro EVT
\_KILL\_FOCUS in an event table definition.
1210 Most, but not all, windows respond to this event.
1212 \wxheading{See also
}
1214 \helpref{wxFocusEvent
}{wxfocusevent
},
\helpref{wxWindow::OnSetFocus
}{wxwindowonsetfocus
},
\rtfsp
1215 \helpref{Event handling overview
}{eventhandlingoverview
}
1217 \membersection{wxWindow::OnIdle
}\label{wxwindowonidle
}
1219 \func{void
}{OnIdle
}{\param{wxIdleEvent\&
}{event
}}
1221 Provide this member function for any processing which needs to be done
1222 when the application is idle.
1224 \wxheading{See also
}
1226 \helpref{wxApp::OnIdle
}{wxapponidle
},
\helpref{wxIdleEvent
}{wxidleevent
}
1228 \membersection{wxWindow::OnInitDialog
}\label{wxwindowoninitdialog
}
1230 \func{void
}{OnInitDialog
}{\param{wxInitDialogEvent\&
}{ event
}}
1232 Default handler for the wxEVT
\_INIT\_DIALOG event. Calls
\helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
}.
1234 \wxheading{Parameters
}
1236 \docparam{event
}{Dialog initialisation event.
}
1240 Gives the window the default behaviour of transferring data to child controls via
1241 the validator that each control has.
1243 \wxheading{See also
}
1245 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
}
1247 \membersection{wxWindow::OnMenuCommand
}\label{wxwindowonmenucommand
}
1249 \func{void
}{OnMenuCommand
}{\param{wxCommandEvent\&
}{event
}}
1251 Called when a menu command is received from a menu bar.
1253 \wxheading{Parameters
}
1255 \docparam{event
}{The menu command event. For more information, see
\helpref{wxCommandEvent
}{wxcommandevent
}.
}
1259 A function with this name doesn't actually exist; you can choose any member function to receive
1260 menu command events, using the EVT
\_COMMAND macro for individual commands or EVT
\_COMMAND\_RANGE for
1261 a range of commands.
1263 \wxheading{See also
}
1265 \helpref{wxCommandEvent
}{wxcommandevent
},
\rtfsp
1266 \helpref{wxWindow::OnMenuHighlight
}{wxwindowonmenuhighlight
},
\rtfsp
1267 \helpref{Event handling overview
}{eventhandlingoverview
}
1269 \membersection{wxWindow::OnMenuHighlight
}\label{wxwindowonmenuhighlight
}
1271 \func{void
}{OnMenuHighlight
}{\param{wxMenuEvent\&
}{event
}}
1273 Called when a menu select is received from a menu bar: that is, the
1274 mouse cursor is over a menu item, but the left mouse button has not been
1277 \wxheading{Parameters
}
1279 \docparam{event
}{The menu highlight event. For more information, see
\helpref{wxMenuEvent
}{wxmenuevent
}.
}
1283 You can choose any member function to receive
1284 menu select events, using the EVT
\_MENU\_HIGHLIGHT macro for individual menu items or EVT
\_MENU\_HIGHLIGHT\_ALL macro
1287 The default implementation for
\helpref{wxFrame::OnMenuHighlight
}{wxframeonmenuhighlight
} displays help
1288 text in the first field of the status bar.
1290 This function was known as
{\bf OnMenuSelect
} in earlier versions of wxWindows, but this was confusing
1291 since a selection is normally a left-click action.
1293 \wxheading{See also
}
1295 \helpref{wxMenuEvent
}{wxmenuevent
},
\rtfsp
1296 \helpref{wxWindow::OnMenuCommand
}{wxwindowonmenucommand
},
\rtfsp
1297 \helpref{Event handling overview
}{eventhandlingoverview
}
1300 \membersection{wxWindow::OnMouseEvent
}\label{wxwindowonmouseevent
}
1302 \func{void
}{OnMouseEvent
}{\param{wxMouseEvent\&
}{ event
}}
1304 Called when the user has initiated an event with the
1307 \wxheading{Parameters
}
1309 \docparam{event
}{The mouse event. See
\helpref{wxMouseEvent
}{wxmouseevent
} for
1314 Most, but not all, windows respond to this event.
1316 To intercept this event, use the EVT
\_MOUSE\_EVENTS macro in an event table definition, or individual
1317 mouse event macros such as EVT
\_LEFT\_DOWN.
1319 \wxheading{See also
}
1321 \helpref{wxMouseEvent
}{wxmouseevent
},
\rtfsp
1322 \helpref{Event handling overview
}{eventhandlingoverview
}
1324 \membersection{wxWindow::OnMove
}\label{wxwindowonmove
}
1326 \func{void
}{OnMove
}{\param{wxMoveEvent\&
}{event
}}
1328 Called when a window is moved.
1330 \wxheading{Parameters
}
1332 \docparam{event
}{The move event. For more information, see
\helpref{wxMoveEvent
}{wxmoveevent
}.
}
1336 Use the EVT
\_MOVE macro to intercept move events.
1340 Not currently implemented.
1342 \wxheading{See also
}
1344 \helpref{wxMoveEvent
}{wxmoveevent
},
\rtfsp
1345 \helpref{wxFrame::OnSize
}{wxframeonsize
},
\rtfsp
1346 \helpref{Event handling overview
}{eventhandlingoverview
}
1348 \membersection{wxWindow::OnPaint
}\label{wxwindowonpaint
}
1350 \func{void
}{OnPaint
}{\param{wxPaintEvent\&
}{event
}}
1352 Sent to the event handler when the window must be refreshed.
1354 \wxheading{Parameters
}
1356 \docparam{event
}{Paint event. For more information, see
\helpref{wxPaintEvent
}{wxpaintevent
}.
}
1360 Use the EVT
\_PAINT macro in an event table definition to intercept paint events.
1362 In a paint event handler, the application should always create a
\helpref{wxPaintDC
}{wxpaintdc
} object.
1368 void MyWindow::OnPaint(wxPaintEvent& event)
1377 You can optimize painting by retrieving the rectangles
1378 that have been damaged and only repainting these. The rectangles are in
1379 terms of the client area, and are unscrolled, so you will need to do
1380 some calculations using the current view position to obtain logical,
1383 Here is an example of using the
\helpref{wxRegionIterator
}{wxregioniterator
} class:
1387 // Called when window needs to be repainted.
1388 void MyWindow::OnPaint(wxPaintEvent& event)
1392 // Find Out where the window is scrolled to
1393 int vbX,vbY; // Top left corner of client
1394 ViewStart(&vbX,&vbY);
1396 int vX,vY,vW,vH; // Dimensions of client area in pixels
1397 wxRegionIterator upd(GetUpdateRegion()); // get the update rect list
1406 // Alternatively we can do this:
1408 // upd.GetRect(&rect);
1410 // Repaint this rectangle
1419 \wxheading{See also
}
1421 \helpref{wxPaintEvent
}{wxpaintevent
},
\rtfsp
1422 \helpref{wxPaintDC
}{wxpaintdc
},
\rtfsp
1423 \helpref{Event handling overview
}{eventhandlingoverview
}
1425 \membersection{wxWindow::OnScroll
}\label{wxwindowonscroll
}
1427 \func{void
}{OnScroll
}{\param{wxScrollWinEvent\&
}{event
}}
1429 Called when a scroll window event is received from one of the window's built-in scrollbars.
1431 \wxheading{Parameters
}
1433 \docparam{event
}{Command event. Retrieve the new scroll position by
1434 calling
\helpref{wxScrollEvent::GetPosition
}{wxscrolleventgetposition
}, and the
1435 scrollbar orientation by calling
\helpref{wxScrollEvent::GetOrientation
}{wxscrolleventgetorientation
}.
}
1439 Note that it is not possible to distinguish between horizontal and vertical scrollbars
1440 until the function is executing (you can't have one function for vertical, another
1441 for horizontal events).
1443 \wxheading{See also
}
1445 \helpref{wxScrollWinEvent
}{wxscrollwinevent
},
\rtfsp
1446 \helpref{Event handling overview
}{eventhandlingoverview
}
1448 \membersection{wxWindow::OnSetFocus
}\label{wxwindowonsetfocus
}
1450 \func{void
}{OnSetFocus
}{\param{wxFocusEvent\&
}{event
}}
1452 Called when a window's focus is being set.
1454 \wxheading{Parameters
}
1456 \docparam{event
}{The focus event. For more information, see
\helpref{wxFocusEvent
}{wxfocusevent
}.
}
1460 To intercept this event, use the macro EVT
\_SET\_FOCUS in an event table definition.
1462 Most, but not all, windows respond to this event.
1464 \wxheading{See also
}
1466 \helpref{wxFocusEvent
}{wxfocusevent
},
\helpref{wxWindow::OnKillFocus
}{wxwindowonkillfocus
},
\rtfsp
1467 \helpref{Event handling overview
}{eventhandlingoverview
}
1469 \membersection{wxWindow::OnSize
}\label{wxwindowonsize
}
1471 \func{void
}{OnSize
}{\param{wxSizeEvent\&
}{event
}}
1473 Called when the window has been resized.
1475 \wxheading{Parameters
}
1477 \docparam{event
}{Size event. For more information, see
\helpref{wxSizeEvent
}{wxsizeevent
}.
}
1481 You may wish to use this for frames to resize their child windows as appropriate.
1483 Note that the size passed is of
1484 the whole window: call
\helpref{wxWindow::GetClientSize
}{wxwindowgetclientsize
} for the area which may be
1485 used by the application.
1487 \wxheading{See also
}
1489 \helpref{wxSizeEvent
}{wxsizeevent
},
\rtfsp
1490 \helpref{Event handling overview
}{eventhandlingoverview
}
1492 \membersection{wxWindow::OnSysColourChanged
}\label{wxwindowonsyscolourchanged
}
1494 \func{void
}{OnSysColourChanged
}{\param{wxOnSysColourChangedEvent\&
}{event
}}
1496 Called when the user has changed the system colours. Windows only.
1498 \wxheading{Parameters
}
1500 \docparam{event
}{System colour change event. For more information, see
\helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
}.
}
1502 \wxheading{See also
}
1504 \helpref{wxSysColourChangedEvent
}{wxsyscolourchangedevent
},
\rtfsp
1505 \helpref{Event handling overview
}{eventhandlingoverview
}
1507 \membersection{wxWindow::PopEventHandler
}\label{wxwindowpopeventhandler
}
1509 \constfunc{wxEvtHandler*
}{PopEventHandler
}{\param{bool
}{deleteHandler = FALSE
}}
1511 Removes and returns the top-most event handler on the event handler stack.
1513 \wxheading{Parameters
}
1515 \docparam{deleteHandler
}{If this is TRUE, the handler will be deleted after it is removed. The
1516 default value is FALSE.
}
1518 \wxheading{See also
}
1520 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
1521 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1522 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1523 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1524 \helpref{wxEvtHandler
}{wxevthandler
}\rtfsp
1526 \membersection{wxWindow::PopupMenu
}\label{wxwindowpopupmenu
}
1528 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{const wxPoint&
}{pos
}}
1530 \func{bool
}{PopupMenu
}{\param{wxMenu*
}{menu
},
\param{int
}{x
},
\param{int
}{y
}}
1532 Pops up the given menu at the specified coordinates, relative to this
1533 window, and returns control when the user has dismissed the menu. If a
1534 menu item is selected, the corresponding menu event is generated and will be
1535 processed as usually.
1537 \wxheading{Parameters
}
1539 \docparam{menu
}{Menu to pop up.
}
1541 \docparam{pos
}{The position where the menu will appear.
}
1543 \docparam{x
}{Required x position for the menu to appear.
}
1545 \docparam{y
}{Required y position for the menu to appear.
}
1547 \wxheading{See also
}
1549 \helpref{wxMenu
}{wxmenu
}
1553 Just before the menu is popped up,
\helpref{wxMenu::UpdateUI
}{wxmenuupdateui
} is called
1554 to ensure that the menu items are in the correct state. The menu does not get deleted
1557 \pythonnote{In place of a single overloaded method name, wxPython
1558 implements the following methods:
\par
1559 \indented{2cm
}{\begin{twocollist
}
1560 \twocolitem{\bf{PopupMenu(menu, point)
}}{Specifies position with a wxPoint
}
1561 \twocolitem{\bf{PopupMenuXY(menu, x, y)
}}{Specifies position with two integers (x, y)
}
1565 \membersection{wxWindow::PushEventHandler
}\label{wxwindowpusheventhandler
}
1567 \func{void
}{PushEventHandler
}{\param{wxEvtHandler*
}{handler
}}
1569 Pushes this event handler onto the event stack for the window.
1571 \wxheading{Parameters
}
1573 \docparam{handler
}{Specifies the handler to be pushed.
}
1577 An event handler is an object that is capable of processing the events
1578 sent to a window. By default, the window is its own event handler, but
1579 an application may wish to substitute another, for example to allow
1580 central implementation of event-handling for a variety of different
1583 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} allows
1584 an application to set up a chain of event handlers, where an event not handled by one event handler is
1585 handed to the next one in the chain. Use
\helpref{wxWindow::PopEventHandler
}{wxwindowpopeventhandler
} to
1586 remove the event handler.
1588 \wxheading{See also
}
1590 \helpref{wxWindow::SetEventHandler
}{wxwindowseteventhandler
},
\rtfsp
1591 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1592 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1593 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1594 \helpref{wxEvtHandler
}{wxevthandler
}
1596 \membersection{wxWindow::Raise
}\label{wxwindowraise
}
1598 \func{void
}{Raise
}{\void}
1600 Raises the window to the top of the window hierarchy if it is a managed window (dialog
1603 \membersection{wxWindow::Refresh
}\label{wxwindowrefresh
}
1605 \func{virtual void
}{Refresh
}{\param{const bool
}{ eraseBackground = TRUE
},
\param{const wxRect*
}{rect
1608 Causes a message or event to be generated to repaint the
1611 \wxheading{Parameters
}
1613 \docparam{eraseBackground
}{If TRUE, the background will be
1616 \docparam{rect
}{If non-NULL, only the given rectangle will
1617 be treated as damaged.
}
1619 \membersection{wxWindow::ReleaseMouse
}\label{wxwindowreleasemouse
}
1621 \func{virtual void
}{ReleaseMouse
}{\void}
1623 Releases mouse input captured with
\helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}.
1625 \wxheading{See also
}
1627 \helpref{wxWindow::CaptureMouse
}{wxwindowcapturemouse
}
1629 \membersection{wxWindow::RemoveChild
}\label{wxwindowremovechild
}
1631 \func{virtual void
}{RemoveChild
}{\param{wxWindow*
}{child
}}
1633 Removes a child window. This is called automatically by window deletion
1634 functions so should not be required by the application programmer.
1636 \wxheading{Parameters
}
1638 \docparam{child
}{Child window to remove.
}
1640 \membersection{wxWindow::Reparent
}\label{wxwindowreparent
}
1642 \func{virtual bool
}{Reparent
}{\param{wxWindow*
}{newParent
}}
1644 Reparents the window, i.e the window will be removed from its
1645 current parent window (e.g. a non-standard toolbar in a wxFrame)
1646 and then re-inserted into another (e.g. a wxMiniFrame for a
1647 floating toolbar). Available on Windows and GTK+.
1649 \wxheading{Parameters
}
1651 \docparam{newParent
}{New parent.
}
1653 \membersection{wxWindow::ScreenToClient
}\label{wxwindowscreentoclient
}
1655 \constfunc{virtual void
}{ScreenToClient
}{\param{int*
}{x
},
\param{int*
}{y
}}
1657 \constfunc{virtual wxPoint
}{ScreenToClient
}{\param{const wxPoint\&
}{pt
}}
1659 Converts from screen to client window coordinates.
1661 \wxheading{Parameters
}
1663 \docparam{x
}{Stores the screen x coordinate and receives the client x coordinate.
}
1665 \docparam{y
}{Stores the screen x coordinate and receives the client x coordinate.
}
1667 \docparam{pt
}{The screen position for the second form of the function.
}
1669 \pythonnote{In place of a single overloaded method name, wxPython
1670 implements the following methods:
\par
1671 \indented{2cm
}{\begin{twocollist
}
1672 \twocolitem{\bf{ScreenToClient(point)
}}{Accepts and returns a wxPoint
}
1673 \twocolitem{\bf{ScreenToClientXY(x, y)
}}{Returns a
2-tuple, (x, y)
}
1678 \membersection{wxWindow::ScrollWindow
}\label{wxwindowscrollwindow
}
1680 \func{virtual void
}{ScrollWindow
}{\param{int
}{dx
},
\param{int
}{dy
},
\param{const wxRect*
}{ rect = NULL
}}
1682 Physically scrolls the pixels in the window and move child windows accordingly.
1684 \wxheading{Parameters
}
1686 \docparam{dx
}{Amount to scroll horizontally.
}
1688 \docparam{dy
}{Amount to scroll vertically.
}
1690 \docparam{rect
}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you
1691 pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler
1692 can optimise painting by checking for the invalidated region. This paramter is ignored under GTK,
1693 instead the regions to be invalidated are calculated automatically.
}
1697 Use this function to optimise your scrolling implementations, to minimise the area that must be
1698 redrawn. Note that it is rarely required to call this function from a user program.
1700 \membersection{wxWindow::SetAcceleratorTable
}\label{wxwindowsetacceleratortable
}
1702 \func{virtual void
}{SetAcceleratorTable
}{\param{const wxAcceleratorTable\&
}{ accel
}}
1704 Sets the accelerator table for this window. See
\helpref{wxAcceleratorTable
}{wxacceleratortable
}.
1706 \membersection{wxWindow::SetAutoLayout
}\label{wxwindowsetautolayout
}
1708 \func{void
}{SetAutoLayout
}{\param{const bool
}{ autoLayout
}}
1710 Determines whether the
\helpref{wxWindow::Layout
}{wxwindowlayout
} function will
1711 be called automatically when the window is resized. Use in connection with
1712 \helpref{wxWindow::SetSizer
}{wxwindowsetsizer
} and
1713 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
} for layouting subwindows.
1715 \wxheading{Parameters
}
1717 \docparam{autoLayout
}{Set this to TRUE if you wish the Layout function to be called
1718 from within wxWindow::OnSize functions.
}
1722 Note that this function is actually disabled for wxWindow and only indirectly
1723 takes affect for children of wxDialog, wxFrame, wxNotebook and wxSplitterWindow.
1725 \wxheading{See also
}
1727 \helpref{wxWindow::SetConstraints
}{wxwindowsetconstraints
}
1729 \membersection{wxWindow::SetBackgroundColour
}\label{wxwindowsetbackgroundcolour
}
1731 \func{virtual void
}{SetBackgroundColour
}{\param{const wxColour\&
}{colour
}}
1733 Sets the background colour of the window.
1735 \wxheading{Parameters
}
1737 \docparam{colour
}{The colour to be used as the background colour.
}
1741 The background colour is usually painted by the default
\rtfsp
1742 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
} event handler function
1743 under Windows and automatically under GTK.
1745 Note that setting the background colour does not cause an immediate refresh, so you
1746 may wish to call
\helpref{wxWindow::Clear
}{wxwindowclear
} or
\helpref{wxWindow::Refresh
}{wxwindowrefresh
} after
1747 calling this function.
1749 Note that when using this functions under GTK, you will disable the so called "themes",
1750 i.e. the user chosen apperance of windows and controls, including the themes of
1751 their parent windows.
1753 \wxheading{See also
}
1755 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
},
\rtfsp
1756 \helpref{wxWindow::SetForegroundColour
}{wxwindowsetforegroundcolour
},
\rtfsp
1757 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
1758 \helpref{wxWindow::Clear
}{wxwindowclear
},
\rtfsp
1759 \helpref{wxWindow::Refresh
}{wxwindowrefresh
},
\rtfsp
1760 \helpref{wxWindow::OnEraseBackground
}{wxwindowonerasebackground
}
1762 \membersection{wxWindow::SetClientSize
}\label{wxwindowsetclientsize
}
1764 \func{virtual void
}{SetClientSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
1766 \func{virtual void
}{SetClientSize
}{\param{const wxSize\&
}{ size
}}
1768 This sets the size of the window client area in pixels. Using this function to size a window
1769 tends to be more device-independent than
\helpref{wxWindow::SetSize
}{wxwindowsetsize
}, since the application need not
1770 worry about what dimensions the border or title bar have when trying to fit the window
1771 around panel items, for example.
1773 \wxheading{Parameters
}
1775 \docparam{width
}{The required client area width.
}
1777 \docparam{height
}{The required client area height.
}
1779 \docparam{size
}{The required client size.
}
1781 \pythonnote{In place of a single overloaded method name, wxPython
1782 implements the following methods:
\par
1783 \indented{2cm
}{\begin{twocollist
}
1784 \twocolitem{\bf{SetClientSize(size)
}}{Accepts a wxSize
}
1785 \twocolitem{\bf{SetClientSizeWH(width, height)
}}{}
1789 \membersection{wxWindow::SetCursor
}\label{wxwindowsetcursor
}
1791 \func{virtual void
}{SetCursor
}{\param{const wxCursor\&
}{cursor
}}
1793 Sets the window's cursor. Notice that setting the cursor for this window does
1794 not set it for its children so you'll need to explicitly call SetCursor() for
1795 them too if you need it.
1797 \wxheading{Parameters
}
1799 \docparam{cursor
}{Specifies the cursor that the window should normally display.
}
1801 \wxheading{See also
}
1803 \helpref{::wxSetCursor
}{wxsetcursor
},
\helpref{wxCursor
}{wxcursor
}
1805 \membersection{wxWindow::SetEventHandler
}\label{wxwindowseteventhandler
}
1807 \func{void
}{SetEventHandler
}{\param{wxEvtHandler*
}{handler
}}
1809 Sets the event handler for this window.
1811 \wxheading{Parameters
}
1813 \docparam{handler
}{Specifies the handler to be set.
}
1817 An event handler is an object that is capable of processing the events
1818 sent to a window. By default, the window is its own event handler, but
1819 an application may wish to substitute another, for example to allow
1820 central implementation of event-handling for a variety of different
1823 It is usually better to use
\helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
} since
1824 this sets up a chain of event handlers, where an event not handled by one event handler is
1825 handed to the next one in the chain.
1827 \wxheading{See also
}
1829 \helpref{wxWindow::GetEventHandler
}{wxwindowgeteventhandler
},
\rtfsp
1830 \helpref{wxWindow::PushEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1831 \helpref{wxWindow::PopEventHandler
}{wxwindowpusheventhandler
},
\rtfsp
1832 \helpref{wxEvtHandler::ProcessEvent
}{wxevthandlerprocessevent
},
\rtfsp
1833 \helpref{wxEvtHandler
}{wxevthandler
}
1835 \membersection{wxWindow::SetConstraints
}\label{wxwindowsetconstraints
}
1837 \func{void
}{SetConstraints
}{\param{wxLayoutConstraints*
}{constraints
}}
1839 Sets the window to have the given layout constraints. The window
1840 will then own the object, and will take care of its deletion.
1841 If an existing layout constraints object is already owned by the
1842 window, it will be deleted.
1844 \wxheading{Parameters
}
1846 \docparam{constraints
}{The constraints to set. Pass NULL to disassociate and delete the window's
1851 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
1852 the constraints automatically in OnSize; otherwise, you must override OnSize and call Layout()
1853 explicitly. When setting both a wxLayoutConstraints and a
\helpref{wxSizer
}{wxsizer
}, only the
1854 sizer will have effect.
1856 \membersection{wxWindow::SetDropTarget
}\label{wxwindowsetdroptarget
}
1858 \func{void
}{SetDropTarget
}{\param{wxDropTarget*
}{ target
}}
1860 Associates a drop target with this window.
1862 If the window already has a drop target, it is deleted.
1864 \wxheading{See also
}
1866 \helpref{wxWindow::GetDropTarget
}{wxwindowgetdroptarget
},
1867 \helpref{Drag and drop overview
}{wxdndoverview
}
1869 \membersection{wxWindow::SetFocus
}\label{wxwindowsetfocus
}
1871 \func{virtual void
}{SetFocus
}{\void}
1873 This sets the window to receive keyboard input.
1875 \membersection{wxWindow::SetFont
}\label{wxwindowsetfont
}
1877 \func{void
}{SetFont
}{\param{const wxFont\&
}{font
}}
1879 Sets the font for this window.
1881 \wxheading{Parameters
}
1883 \docparam{font
}{Font to associate with this window.
}
1885 \wxheading{See also
}
1887 \helpref{wxWindow::GetFont
}{wxwindowgetfont
}
1889 \membersection{wxWindow::SetForegroundColour
}\label{wxwindowsetforegroundcolour
}
1891 \func{virtual void
}{SetForegroundColour
}{\param{const wxColour\&
}{colour
}}
1893 Sets the foreground colour of the window.
1895 \wxheading{Parameters
}
1897 \docparam{colour
}{The colour to be used as the foreground colour.
}
1901 The interpretation of foreground colour is open to interpretation according
1902 to the window class; it may be the text colour or other colour, or it may not
1905 Note that when using this functions under GTK, you will disable the so called "themes",
1906 i.e. the user chosen apperance of windows and controls, including the themes of
1907 their parent windows.
1909 \wxheading{See also
}
1911 \helpref{wxWindow::GetForegroundColour
}{wxwindowgetforegroundcolour
},
\rtfsp
1912 \helpref{wxWindow::SetBackgroundColour
}{wxwindowsetbackgroundcolour
},
\rtfsp
1913 \helpref{wxWindow::GetBackgroundColour
}{wxwindowgetbackgroundcolour
}
1915 \membersection{wxWindow::SetId
}\label{wxwindowsetid
}
1917 \func{void
}{SetId
}{\param{int
}{ id
}}
1919 Sets the identifier of the window.
1923 Each window has an integer identifier. If the application has not provided one,
1924 an identifier will be generated. Normally, the identifier should be provided
1925 on creation and should not be modified subsequently.
1927 \wxheading{See also
}
1929 \helpref{wxWindow::GetId
}{wxwindowgetid
},
\rtfsp
1930 \helpref{Window identifiers
}{windowids
}
1932 \membersection{wxWindow::SetName
}\label{wxwindowsetname
}
1934 \func{virtual void
}{SetName
}{\param{const wxString\&
}{name
}}
1936 Sets the window's name.
1938 \wxheading{Parameters
}
1940 \docparam{name
}{A name to set for the window.
}
1942 \wxheading{See also
}
1944 \helpref{wxWindow::GetName
}{wxwindowgetname
}
1946 \membersection{wxWindow::SetPalette
}\label{wxwindowsetpalette
}
1948 \func{virtual void
}{SetPalette
}{\param{wxPalette*
}{palette
}}
1950 Obsolete - use
\helpref{wxDC::SetPalette
}{wxdcsetpalette
} instead.
1952 \membersection{wxWindow::SetScrollbar
}\label{wxwindowsetscrollbar
}
1954 \func{virtual void
}{SetScrollbar
}{\param{int
}{orientation
},
\param{int
}{position
},
\rtfsp
1955 \param{int
}{thumbSize
},
\param{int
}{range
},
\rtfsp
1956 \param{const bool
}{refresh = TRUE
}}
1958 Sets the scrollbar properties of a built-in scrollbar.
1960 \wxheading{Parameters
}
1962 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
1964 \docparam{position
}{The position of the scrollbar in scroll units.
}
1966 \docparam{thumbSize
}{The size of the thumb, or visible portion of the scrollbar, in scroll units.
}
1968 \docparam{range
}{The maximum position of the scrollbar.
}
1970 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
1974 Let's say you wish to display
50 lines of text, using the same font.
1975 The window is sized so that you can only see
16 lines at a time.
1981 SetScrollbar(wxVERTICAL,
0,
16,
50);
1985 Note that with the window at this size, the thumb position can never go
1986 above
50 minus
16, or
34.
1988 You can determine how many lines are currently visible by dividing the current view
1989 size by the character height in pixels.
1991 When defining your own scrollbar behaviour, you will always need to recalculate
1992 the scrollbar settings when the window size changes. You could therefore put your
1993 scrollbar calculations and SetScrollbar
1994 call into a function named AdjustScrollbars, which can be called initially and also
1995 from your
\helpref{wxWindow::OnSize
}{wxwindowonsize
} event handler function.
1997 \wxheading{See also
}
1999 \helpref{Scrolling overview
}{scrollingoverview
},
\rtfsp
2000 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2003 \membersection{wxWindow::SetScrollPage
}\label{wxwindowsetscrollpage
}
2005 \func{virtual void
}{SetScrollPage
}{\param{int
}{orientation
},
\param{int
}{pageSize
},
\param{const bool
}{refresh = TRUE
}}
2007 Sets the page size of one of the built-in scrollbars.
2009 \wxheading{Parameters
}
2011 \docparam{orientation
}{Determines the scrollbar whose page size is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2013 \docparam{pageSize
}{Page size in scroll units.
}
2015 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2019 The page size of a scrollbar is the number of scroll units that the scroll thumb travels when you
2020 click on the area above/left of or below/right of the thumb. Normally you will want a whole visible
2021 page to be scrolled, i.e. the size of the current view (perhaps the window client size). This
2022 value has to be adjusted when the window is resized, since the page size will have changed.
2024 In addition to specifying how far the scroll thumb travels when paging, in Motif and some versions of Windows
2025 the thumb changes size to reflect the page size relative to the length of the
document. When the
2026 document size is only slightly bigger than the current view (window) size, almost all of the scrollbar
2027 will be taken up by the thumb. When the two values become the same, the scrollbar will (on some systems)
2030 Currently, this function should be called before SetPageRange, because of a quirk in the Windows
2031 handling of pages and ranges.
2033 \wxheading{See also
}
2035 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2036 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2037 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
2038 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2041 \membersection{wxWindow::SetScrollPos
}\label{wxwindowsetscrollpos
}
2043 \func{virtual void
}{SetScrollPos
}{\param{int
}{orientation
},
\param{int
}{pos
},
\param{const bool
}{refresh = TRUE
}}
2045 Sets the position of one of the built-in scrollbars.
2047 \wxheading{Parameters
}
2049 \docparam{orientation
}{Determines the scrollbar whose position is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2051 \docparam{pos
}{Position in scroll units.
}
2053 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2057 This function does not directly affect the contents of the window: it is up to the
2058 application to take note of scrollbar attributes and redraw contents accordingly.
2060 \wxheading{See also
}
2062 \helpref{wxWindow::SetScrollbar
}{wxwindowsetscrollbar
},
\rtfsp
2063 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2064 \helpref{wxWindow::GetScrollThumb
}{wxwindowgetscrollthumb
},
\rtfsp
2065 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2068 \membersection{wxWindow::SetScrollRange
}\label{wxwindowsetscrollrange
}
2070 \func{virtual void
}{SetScrollRange
}{\param{int
}{orientation
},
\param{int
}{range
},
\param{const bool
}{refresh = TRUE
}}
2072 Sets the range of one of the built-in scrollbars.
2074 \wxheading{Parameters
}
2076 \docparam{orientation
}{Determines the scrollbar whose range is to be set. May be wxHORIZONTAL or wxVERTICAL.
}
2078 \docparam{range
}{Scroll range.
}
2080 \docparam{refresh
}{TRUE to redraw the scrollbar, FALSE otherwise.
}
2084 The range of a scrollbar is the number of steps that the thumb may travel, rather than the total
2085 object length of the scrollbar. If you are implementing a scrolling window, for example, you
2086 would adjust the scroll range when the window is resized, by subtracting the window view size from the
2087 total virtual window size. When the two sizes are the same (all the window is visible), the range goes to zero
2088 and usually the scrollbar will be automatically hidden.
2090 \wxheading{See also
}
2092 \helpref{wxWindow::SetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2093 \helpref{wxWindow::SetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
2094 \helpref{wxWindow::GetScrollPos
}{wxwindowsetscrollpos
},
\rtfsp
2095 \helpref{wxWindow::GetScrollPage
}{wxwindowsetscrollpage
},
\rtfsp
2096 \helpref{wxScrollBar
}{wxscrollbar
},
\helpref{wxScrolledWindow
}{wxscrolledwindow
}
2099 \membersection{wxWindow::SetSize
}\label{wxwindowsetsize
}
2101 \func{virtual void
}{SetSize
}{\param{int
}{ x
},
\param{int
}{ y
},
\param{int
}{ width
},
\param{int
}{ height
},
2102 \param{int
}{ sizeFlags = wxSIZE
\_AUTO}}
2104 \func{virtual void
}{SetSize
}{\param{const wxRect\&
}{ rect
}}
2106 Sets the size and position of the window in pixels.
2108 \func{virtual void
}{SetSize
}{\param{int
}{ width
},
\param{int
}{ height
}}
2110 \func{virtual void
}{SetSize
}{\param{const wxSize\&
}{ size
}}
2112 Sets the size of the window in pixels.
2114 \wxheading{Parameters
}
2116 \docparam{x
}{Required x position in pixels, or -
1 to indicate that the existing
2117 value should be used.
}
2119 \docparam{y
}{Required y position in pixels, or -
1 to indicate that the existing
2120 value should be used.
}
2122 \docparam{width
}{Required width in pixels, or -
1 to indicate that the existing
2123 value should be used.
}
2125 \docparam{height
}{Required height position in pixels, or -
1 to indicate that the existing
2126 value should be used.
}
2128 \docparam{size
}{\helpref{wxSize
}{wxsize
} object for setting the size.
}
2130 \docparam{rect
}{\helpref{wxRect
}{wxrect
} object for setting the position and size.
}
2132 \docparam{sizeFlags
}{Indicates the interpretation of other parameters. It is a bit list of the following:
2134 {\bf wxSIZE
\_AUTO\_WIDTH}: a -
1 width value is taken to indicate
2135 a wxWindows-supplied default width.\\
2136 {\bf wxSIZE
\_AUTO\_HEIGHT}: a -
1 height value is taken to indicate
2137 a wxWindows-supplied default width.\\
2138 {\bf wxSIZE
\_AUTO}: -
1 size values are taken to indicate
2139 a wxWindows-supplied default size.\\
2140 {\bf wxSIZE
\_USE\_EXISTING}: existing dimensions should be used
2141 if -
1 values are supplied.\\
2142 {\bf wxSIZE
\_ALLOW\_MINUS\_ONE}: allow dimensions of -
1 and less to be interpreted
2143 as real dimensions, not default values.
2148 The second form is a convenience for calling the first form with default
2149 x and y parameters, and must be used with non-default width and height values.
2151 The first form sets the position and optionally size, of the window.
2152 Parameters may be -
1 to indicate either that a default should be supplied
2153 by wxWindows, or that the current value of the dimension should be used.
2155 \wxheading{See also
}
2157 \helpref{wxWindow::Move
}{wxwindowmove
}
2159 \pythonnote{In place of a single overloaded method name, wxPython
2160 implements the following methods:
\par
2161 \indented{2cm
}{\begin{twocollist
}
2162 \twocolitem{\bf{SetDimensions(x, y, width, height, sizeFlags=wxSIZE_AUTO)
}}{}
2163 \twocolitem{\bf{SetSize(size)
}}{}
2164 \twocolitem{\bf{SetPosition(point)
}}{}
2168 \membersection{wxWindow::SetSizeHints
}\label{wxwindowsetsizehints
}
2170 \func{virtual void
}{SetSizeHints
}{\param{int
}{ minW=-
1},
\param{int
}{ minH=-
1},
\param{int
}{ maxW=-
1},
\param{int
}{ maxH=-
1},
2171 \param{int
}{ incW=-
1},
\param{int
}{ incH=-
1}}
2173 Allows specification of minimum and maximum window sizes, and window size increments.
2174 If a pair of values is not set (or set to -
1), the default values will be used.
2176 \wxheading{Parameters
}
2178 \docparam{minW
}{Specifies the minimum width allowable.
}
2180 \docparam{minH
}{Specifies the minimum height allowable.
}
2182 \docparam{maxW
}{Specifies the maximum width allowable.
}
2184 \docparam{maxH
}{Specifies the maximum height allowable.
}
2186 \docparam{incW
}{Specifies the increment for sizing the width (Motif/Xt only).
}
2188 \docparam{incH
}{Specifies the increment for sizing the height (Motif/Xt only).
}
2192 If this function is called, the user will not be able to size the window outside the
2195 The resizing increments are only significant under Motif or Xt.
2197 \membersection{wxWindow::SetSizer
}\label{wxwindowsetsizer
}
2199 \func{void
}{SetSizer
}{\param{wxSizer*
}{sizer
}}
2201 Sets the window to have the given layout sizer. The window
2202 will then own the object, and will take care of its deletion.
2203 If an existing layout constraints object is already owned by the
2204 window, it will be deleted.
2206 \wxheading{Parameters
}
2208 \docparam{sizer
}{The sizer to set. Pass NULL to disassociate and delete the window's
2213 You must call
\helpref{wxWindow::SetAutoLayout
}{wxwindowsetautolayout
} to tell a window to use
2214 the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout()
2215 explicitly. When setting both a wxSizer and a
\helpref{wxLayoutConstraints
}{wxlayoutconstraints
},
2216 only the sizer will have effect.
2218 \membersection{wxWindow::SetTitle
}\label{wxwindowsettitle
}
2220 \func{virtual void
}{SetTitle
}{\param{const wxString\&
}{title
}}
2222 Sets the window's title. Applicable only to frames and dialogs.
2224 \wxheading{Parameters
}
2226 \docparam{title
}{The window's title.
}
2228 \wxheading{See also
}
2230 \helpref{wxWindow::GetTitle
}{wxwindowgettitle
}
2232 \membersection{wxWindow::SetValidator
}\label{wxwindowsetvalidator
}
2234 \func{virtual void
}{SetValidator
}{\param{const wxValidator\&
}{ validator
}}
2236 Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to
2237 create a new validator of this type.
2239 \membersection{wxWindow::Show
}\label{wxwindowshow
}
2241 \func{virtual bool
}{Show
}{\param{const bool
}{ show
}}
2243 Shows or hides the window.
2245 \wxheading{Parameters
}
2247 \docparam{show
}{If TRUE, displays the window and brings it to the front. Otherwise,
2250 \wxheading{See also
}
2252 \helpref{wxWindow::IsShown
}{wxwindowisshown
}
2254 \membersection{wxWindow::TransferDataFromWindow
}\label{wxwindowtransferdatafromwindow
}
2256 \func{virtual bool
}{TransferDataFromWindow
}{\void}
2258 Transfers values from child controls to data areas specified by their validators. Returns
2259 FALSE if a transfer failed.
2261 \wxheading{See also
}
2263 \helpref{wxWindow::TransferDataToWindow
}{wxwindowtransferdatatowindow
},
\rtfsp
2264 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
2266 \membersection{wxWindow::TransferDataToWindow
}\label{wxwindowtransferdatatowindow
}
2268 \func{virtual bool
}{TransferDataToWindow
}{\void}
2270 Transfers values to child controls from data areas specified by their validators.
2272 \wxheading{Return value
}
2274 Returns FALSE if a transfer failed.
2276 \wxheading{See also
}
2278 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
2279 \helpref{wxValidator
}{wxvalidator
},
\helpref{wxWindow::Validate
}{wxwindowvalidate
}
2281 \membersection{wxWindow::Validate
}\label{wxwindowvalidate
}
2283 \func{virtual bool
}{Validate
}{\void}
2285 Validates the current values of the child controls using their validators.
2287 \wxheading{Return value
}
2289 Returns FALSE if any of the validations failed.
2291 \wxheading{See also
}
2293 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
2294 \helpref{wxWindow::TransferDataFromWindow
}{wxwindowtransferdatafromwindow
},
\rtfsp
2295 \helpref{wxValidator
}{wxvalidator
}
2297 \membersection{wxWindow::WarpPointer
}\label{wxwindowwarppointer
}
2299 \func{void
}{WarpPointer
}{\param{int
}{ x
},
\param{int
}{ y
}}
2301 Moves the pointer to the given position on the window.
2303 \wxheading{Parameters
}
2305 \docparam{x
}{The new x position for the cursor.
}
2307 \docparam{y
}{The new y position for the cursor.
}