X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/8a29359071eaf4f91cd3d15c65f31691baa2b1b9..34bbbc276dc470014c8d200cfbbf7f588076aeaf:/docs/latex/wx/window.tex?ds=sidebyside diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 2cfb54137d..8d2e39bcb6 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -42,9 +42,9 @@ the application-wide policy is for 3D controls. Windows only.} wants to get all char events - even for keys like TAB or ENTER which are usually used for dialog navigation and which wouldn't be generated without this style} -\twocolitem{\windowstyle{wxNO\_FULLREPAINT\_ON\_RESIZE}}{Disables repainting +\twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{Disables repainting the window completely when its size is changed - you will have to repaint the -new window area manually if you use style. Currently only has effect for +new window area manually if you use this style. Currently only has an effect for Windows.} \twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar. (Still used?) } \twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar. (Still used?) } @@ -60,7 +60,7 @@ See also \helpref{window styles overview}{windowstyles}. \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxWindow::wxWindow} +\membersection{wxWindow::wxWindow}\label{wxwindowctor} \func{}{wxWindow}{\void} @@ -143,9 +143,15 @@ A synonym for \helpref{Centre}{wxwindowcentre}. A synonym for \helpref{CentreOnParent}{wxwindowcentreonparent}. +\membersection{wxWindow::CenterOnScreen}\label{wxwindowcenteronscreen} + +\func{void}{CenterOnScreen}{\param{int}{ direction}} + +A synonym for \helpref{CentreOnScreen}{wxwindowcentreonscreen}. + \membersection{wxWindow::Centre}\label{wxwindowcentre} -\func{void}{Centre}{\param{int}{ direction = wxHORIZONTAL}} +\func{void}{Centre}{\param{int}{ direction = wxBOTH}} Centres the window. @@ -156,7 +162,8 @@ or {\tt wxBOTH}. It may also include {\tt wxCENTRE\_ON\_SCREEN} flag if you want to center the window on the entire screen and not on its parent window.} -The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer. +The flag {\tt wxCENTRE\_FRAME} is obsolete and should not be used any longer +(it has no effect). \wxheading{Remarks} @@ -169,9 +176,10 @@ centered relative to the screen anyhow. \membersection{wxWindow::CentreOnParent}\label{wxwindowcentreonparent} -\func{void}{CentreOnParent}{\param{int}{ direction = wxHORIZONTAL}} +\func{void}{CentreOnParent}{\param{int}{ direction = wxBOTH}} -Centres the window. +Centres the window on its parent. This is a more readable synonym for +\helpref{Centre}{wxwindowcentre}. \wxheading{Parameters} @@ -187,7 +195,23 @@ window is not a top level window, then behaviour is the same as \wxheading{See also} -\helpref{wxWindow::CenterOnParent}{wxwindowcenteronparent} +\helpref{wxWindow::CentreOnScreen}{wxwindowcenteronscreen} + +\membersection{wxWindow::CentreOnScreen}\label{wxwindowcentreonscreen} + +\func{void}{CentreOnScreen}{\param{int}{ direction = wxBOTH}} + +Centres the window on screen. This only works for top level windows - +otherwise, the window will still be centered on its parent. + +\wxheading{Parameters} + +\docparam{direction}{Specifies the direction for the centering. May be {\tt wxHORIZONTAL}, {\tt wxVERTICAL}\rtfsp +or {\tt wxBOTH}.} + +\wxheading{See also} + +\helpref{wxWindow::CentreOnParent}{wxwindowcenteronparent} \membersection{wxWindow::Clear}\label{wxwindowclear} @@ -200,6 +224,9 @@ cause an erase background event to be generated. \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}} +\perlnote{In wxPerl this method returns a 2-element list intead of +modifying its parameters.} + \constfunc{virtual wxPoint}{ClientToScreen}{\param{const wxPoint\&}{ pt}} Converts to screen coordinates from coordinates relative to this window. @@ -215,12 +242,11 @@ a screen coordinate will be passed out.} \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{ClientToScreen(point)}}{Accepts and returns a wxPoint} -\twocolitem{\bf{ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)} +\twocolitem{{\bf ClientToScreen(point)}}{Accepts and returns a wxPoint} +\twocolitem{{\bf ClientToScreenXY(x, y)}}{Returns a 2-tuple, (x, y)} \end{twocollist}} } - \membersection{wxWindow::Close}\label{wxwindowclose} \func{virtual bool}{Close}{\param{bool}{ force = FALSE}} @@ -293,15 +319,15 @@ You can also use these functions programmatically. A convenience macro is define \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint} -\twocolitem{\bf{ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize} +\twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint} +\twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize} \end{twocollist}} Additionally, the following helper functions are defined:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{wxDLG\_PNT(win, point)}}{Converts a wxPoint from dialog +\twocolitem{{\bf wxDLG\_PNT(win, point)}}{Converts a wxPoint from dialog units to pixels} -\twocolitem{\bf{wxDLG\_SZE(win, size)}}{Converts a wxSize from dialog +\twocolitem{{\bf wxDLG\_SZE(win, size)}}{Converts a wxSize from dialog units to pixels} \end{twocollist}} } @@ -334,8 +360,8 @@ Dialogs created using Dialog Editor optionally use dialog units. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint} -\twocolitem{\bf{ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize} +\twocolitem{{\bf ConvertDialogPointToPixels(point)}}{Accepts and returns a wxPoint} +\twocolitem{{\bf ConvertDialogSizeToPixels(size)}}{Accepts and returns a wxSize} \end{twocollist}} } @@ -361,6 +387,12 @@ to the list of windows pending real deletion. Destroys all children of a window. Called automatically by the destructor. +\membersection{wxWindow::Disable}\label{wxwindowdisable} + +\func{void}{Disable}{\void} + +Disables the window, same as \helpref{Enable(FALSE)}{wxwindowenable}. + \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles} \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}} @@ -382,7 +414,7 @@ Windows only. \membersection{wxWindow::Enable}\label{wxwindowenable} -\func{virtual void}{Enable}{\param{bool}{ enable}} +\func{virtual void}{Enable}{\param{bool}{ enable = TRUE}} Enable or disable the window for user input. @@ -392,7 +424,8 @@ Enable or disable the window for user input. \wxheading{See also} -\helpref{wxWindow::IsEnabled}{wxwindowisenabled} +\helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp +\helpref{wxWindow::Disable}{wxwindowdisable} \membersection{wxWindow::FindFocus}\label{wxwindowfindfocus} @@ -421,8 +454,8 @@ Find a child of this window, by name. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{FindWindowById(id)}}{Accepts an integer} -\twocolitem{\bf{FindWindowByName(name)}}{Accepts a string} +\twocolitem{{\bf FindWindowById(id)}}{Accepts an integer} +\twocolitem{{\bf FindWindowByName(name)}}{Accepts a string} \end{twocollist}} } @@ -446,17 +479,23 @@ Returns the background colour of the window. \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} -\membersection{wxWindow::GetBestSize}{wxwindowgetbestsize} +\membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize} \constfunc{virtual wxSize}{GetBestSize}{\void} This functions returns the best acceptable minimal size for the window. For example, for a static control, it will be the minimal size such that the -control label is not truncated. For windows containing subwindows (typically -\helpref{wxPanel}wxpanel}), the size returned by this function will be the -same as the size the window would have had after calling +control label is not truncated. For windows containing subwindows (typically +\helpref{wxPanel}{wxpanel}), the size returned by this function will be the +same as the size the window would have had after calling \helpref{Fit}{wxwindowfit}. +\membersection{wxWindow::GetCaret}\label{wxwindowgetcaret} + +\constfunc{wxCaret *}{GetCaret}{\void} + +Returns the \helpref{caret}{wxcaret} associated with the window. + \membersection{wxWindow::GetCharHeight} \constfunc{virtual int}{GetCharHeight}{\void} @@ -479,6 +518,9 @@ Returns a reference to the list of the window's children. \constfunc{virtual void}{GetClientSize}{\param{int* }{width}, \param{int* }{height}} +\perlnote{In wxPerl this method takes no parameter and returns +a 2-element list {\tt ( width, height )}.} + \constfunc{virtual wxSize}{GetClientSize}{\void} This gets the size of the window `client area' in pixels. The client area is the @@ -493,8 +535,8 @@ area which may be drawn on by the programmer, excluding title bar, border etc. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{wxGetClientSizeTuple()}}{Returns a 2-tuple of (width, height)} -\twocolitem{\bf{wxGetClientSize()}}{Returns a wxSize object} +\twocolitem{{\bf GetClientSizeTuple()}}{Returns a 2-tuple of (width, height)} +\twocolitem{{\bf GetClientSize()}}{Returns a wxSize object} \end{twocollist}} } @@ -504,12 +546,6 @@ implements the following methods:\par Returns a pointer to the window's layout constraints, or NULL if there are none. -\membersection{wxWindow::GetDefaultItem}\label{wxwindowgetdefaultitem} - -\constfunc{wxButton*}{GetDefaultItem}{\void} - -Returns a pointer to the button which is the default for this window, or NULL. - \membersection{wxWindow::GetDropTarget}\label{wxwindowgetdroptarget} \constfunc{wxDropTarget*}{GetDropTarget}{\void} @@ -536,6 +572,12 @@ own event handler. \helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp \helpref{wxEvtHandler}{wxevthandler}\rtfsp +\membersection{wxWindow::GetExtraStyle}\label{wxwindowgetextrastyle} + +\constfunc{long}{GetExtraStyle}{\void} + +Returns the extra style bits for the window. + \membersection{wxWindow::GetFont}\label{wxwindowgetfont} \constfunc{wxFont\&}{GetFont}{\void} @@ -570,7 +612,7 @@ be used at all. Returns the grandparent of a window, or NULL if there isn't one. -\membersection{wxWindow::GetHandle} +\membersection{wxWindow::GetHandle}\label{wxwindowgethandle} \constfunc{void*}{GetHandle}{\void} @@ -579,6 +621,19 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif or {\bf GtkWidget \pythonnote{This method will return an integer in wxPython.} +\membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext} + +\constfunc{virtual wxString}{GetHelpText}{\void} + +Gets the help text to be used as context-sensitive help for this window. + +Note that the text is actually stored by the current \helpref{wxHelpProvider}{wxhelpprovider} implementation, +and not in the window object itself. + +\wxheading{See also} + +\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider} + \membersection{wxWindow::GetId}\label{wxwindowgetid} \constfunc{int}{GetId}{\void} @@ -592,30 +647,9 @@ Each window has an integer identifier. If the application has not provided one \wxheading{See also} -\helpref{wxWindow::SetId}{wxwindowsetid}\rtfsp +\helpref{wxWindow::SetId}{wxwindowsetid},\rtfsp \helpref{Window identifiers}{windowids} -\membersection{wxWindow::GetPosition} - -\constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}} - -This gets the position of the window in pixels, relative to the parent window or -if no parent, relative to the whole display. - -\wxheading{Parameters} - -\docparam{x}{Receives the x position of the window.} - -\docparam{y}{Receives the y position of the window.} - -\pythonnote{In place of a single overloaded method name, wxPython -implements the following methods:\par -\indented{2cm}{\begin{twocollist} -\twocolitem{\bf{GetPosition()}}{Returns a wxPoint} -\twocolitem{\bf{GetPositionTuple()}}{Returns a tuple (x, y)} -\end{twocollist}} -} - \membersection{wxWindow::GetLabel} \constfunc{virtual wxString }{GetLabel}{\void} @@ -652,6 +686,38 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam Returns the parent of the window, or NULL if there is no parent. +\membersection{wxWindow::GetPosition}\label{wxwindowgetposition} + +\constfunc{virtual void}{GetPosition}{\param{int* }{x}, \param{int* }{y}} + +\constfunc{wxPoint}{GetPosition}{\void} + +This gets the position of the window in pixels, relative to the parent window or +if no parent, relative to the whole display. + +\wxheading{Parameters} + +\docparam{x}{Receives the x position of the window.} + +\docparam{y}{Receives the y position of the window.} + +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf GetPosition()}}{Returns a wxPoint} +\twocolitem{{\bf GetPositionTuple()}}{Returns a tuple (x, y)} +\end{twocollist}} +} + +\perlnote{In wxPerl there are two methods instead of a single overloaded +method:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf GetPosition()}}{Returns a Wx::Point} +\twocolitem{{\bf GetPositionXY()}}{Returns a 2-element list + {\tt ( x, y )}} +\end{twocollist} +}} + \membersection{wxWindow::GetRect}\label{wxwindowgetrect} \constfunc{virtual wxRect}{GetRect}{\void} @@ -705,12 +771,26 @@ This gets the size of the entire window in pixels. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{GetSize()}}{Returns a wxSize} -\twocolitem{\bf{GetSizeTuple()}}{Returns a 2-tuple (width, height)} +\twocolitem{{\bf GetSize()}}{Returns a wxSize} +\twocolitem{{\bf GetSizeTuple()}}{Returns a 2-tuple (width, height)} \end{twocollist}} } -\membersection{wxWindow::GetTextExtent} +\perlnote{In wxPerl there are two methods instead of a single overloaded +method:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf GetSize()}}{Returns a Wx::Size} +\twocolitem{{\bf GetSizeWH()}}{Returns a 2-element list + {\tt ( width, height )}} +\end{twocollist} +}} + +\membersection{wxWindow::GetSizer}\label{wxwindowgetsizer} + +\constfunc{const wxSizer *}{GetSizer}{\void} + +Return the sizer associated with the window by a previous call to +\helpref{SetSizer()}{wxwindowsetsizer} or {\tt NULL}. \constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y}, \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL}, @@ -739,12 +819,15 @@ window with the currently selected font. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{GetTextExtent(string)}}{Returns a 2-tuple, (width, height)} -\twocolitem{\bf{GetFullTextExtent(string, font=NULL)}}{Returns a +\twocolitem{{\bf GetTextExtent(string)}}{Returns a 2-tuple, (width, height)} +\twocolitem{{\bf GetFullTextExtent(string, font=NULL)}}{Returns a 4-tuple, (width, height, descent, externalLeading) } \end{twocollist}} } +\perlnote{In wxPerl this method takes only the {\tt string} and optionally + {\tt font} parameters, and returns a 4-element list + {\tt ( x, y, descent, externalLeading )}.} \membersection{wxWindow::GetTitle}\label{wxwindowgettitle} @@ -773,12 +856,12 @@ only be called within an \helpref{OnPaint}{wxwindowonpaint} event handler. Returns a pointer to the current validator for the window, or NULL if there is none. -\membersection{wxWindow::GetWindowStyleFlag} +\membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag} \constfunc{long}{GetWindowStyleFlag}{\void} -Gets the window style that was passed to the consructor or {\bf Create} member. -{\bf GetWindowStyle} is synonymous. +Gets the window style that was passed to the constructor or {\bf Create} +method. {\bf GetWindowStyle()} is another name for the same function. \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog} @@ -805,16 +888,24 @@ Returns TRUE if the window is enabled for input, FALSE otherwise. \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}} -\constfunc{bool}{IsExposed}{\param{wxPoint }{&pt}} +\constfunc{bool}{IsExposed}{\param{wxPoint }{\&pt}} \constfunc{bool}{IsExposed}{\param{int }{x}, \param{int }{y}, \param{int }{w}, \param{int }{h}} -\constfunc{bool}{IsExposed}{\param{wxRect }{&rect}} +\constfunc{bool}{IsExposed}{\param{wxRect }{\&rect}} Returns TRUE if the given point or rectange area has been exposed since the last repaint. Call this in an paint event handler to optimize redrawing by only redrawing those areas, which have been exposed. +\pythonnote{In place of a single overloaded method name, wxPython +implements the following methods:\par +\indented{2cm}{\begin{twocollist} +\twocolitem{{\bf IsExposed(x,y, w=0,h=0}}{} +\twocolitem{{\bf IsExposedPoint(pt)}}{} +\twocolitem{{\bf IsExposedRect(rect)}}{} +\end{twocollist}}} + \membersection{wxWindow::IsRetained}\label{wxwindowisretained} \constfunc{virtual bool}{IsRetained}{\void} @@ -922,8 +1013,8 @@ as the call: \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{Move(point)}}{Accepts a wxPoint} -\twocolitem{\bf{MoveXY(x, y)}}{Accepts a pair of integers} +\twocolitem{{\bf Move(point)}}{Accepts a wxPoint} +\twocolitem{{\bf MoveXY(x, y)}}{Accepts a pair of integers} \end{twocollist}} } @@ -973,6 +1064,9 @@ keypresses, then you will need to use \helpref{wxWindow::OnKeyDown}{wxwindowonke Most, but not all, windows allow keypresses to be intercepted. +{\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function, +otherwise menu shortcuts may cease to work under Windows. + \wxheading{See also} \helpref{wxWindow::OnKeyDown}{wxwindowonkeydown}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp @@ -1138,7 +1232,8 @@ Called when the background of the window needs to be erased. \wxheading{Remarks} -This event is only generated under Windows. It is therefore recommended that +Under non-Windows platforms, this event is simulated (simply generated just before the +paint event) and may cause flicker. It is therefore recommended that you set the text background colour explicitly in order to prevent flicker. The default background colour under GTK is grey. @@ -1172,6 +1267,9 @@ keys, such as shift, control, and function keys, then you will need to use \help Most, but not all, windows allow keypresses to be intercepted. +{\bf Tip:} be sure to call {\tt event.Skip()} for events that you don't process in this function, +otherwise menu shortcuts may cease to work under Windows. + \wxheading{See also} \helpref{wxWindow::OnChar}{wxwindowonchar}, \helpref{wxWindow::OnKeyUp}{wxwindowonkeyup},\rtfsp @@ -1373,13 +1471,14 @@ Sent to the event handler when the window must be refreshed. Use the EVT\_PAINT macro in an event table definition to intercept paint events. -In a paint event handler, the application should always create a \helpref{wxPaintDC}{wxpaintdc} object. +Note that In a paint event handler, the application must {\it always} create a \helpref{wxPaintDC}{wxpaintdc} object, +even if you do not use it. Otherwise, under MS Windows, refreshing for this and other windows will go wrong. For example: \small{% \begin{verbatim} - void MyWindow::OnPaint(wxPaintEvent& event) + void MyWindow::OnPaint(wxPaintEvent\& event) { wxPaintDC dc(this); @@ -1399,13 +1498,13 @@ Here is an example of using the \helpref{wxRegionIterator}{wxregioniterator} cla {\small% \begin{verbatim} // Called when window needs to be repainted. -void MyWindow::OnPaint(wxPaintEvent& event) +void MyWindow::OnPaint(wxPaintEvent\& event) { wxPaintDC dc(this); // Find Out where the window is scrolled to int vbX,vbY; // Top left corner of client - ViewStart(&vbX,&vbY); + GetViewStart(&vbX,&vbY); int vX,vY,vW,vH; // Dimensions of client area in pixels wxRegionIterator upd(GetUpdateRegion()); // get the update rect list @@ -1498,6 +1597,11 @@ Note that the size passed is of the whole window: call \helpref{wxWindow::GetClientSize}{wxwindowgetclientsize} for the area which may be used by the application. +When a window is resized, usually only a small part of the window is damaged and you +may only need to repaint that area. However, if your drawing depends on the size of the window, +you may need to clear the DC explicitly and repaint the whole window. In which case, you +may need to call \helpref{wxWindow::Refresh}{wxwindowrefresh} to invalidate the entire window. + \wxheading{See also} \helpref{wxSizeEvent}{wxsizeevent},\rtfsp @@ -1539,7 +1643,7 @@ default value is FALSE.} \membersection{wxWindow::PopupMenu}\label{wxwindowpopupmenu} -\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint& }{pos}} +\func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{const wxPoint\& }{pos}} \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}} @@ -1571,8 +1675,8 @@ by the window. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{PopupMenu(menu, point)}}{Specifies position with a wxPoint} -\twocolitem{\bf{PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)} +\twocolitem{{\bf PopupMenu(menu, point)}}{Specifies position with a wxPoint} +\twocolitem{{\bf PopupMenuXY(menu, x, y)}}{Specifies position with two integers (x, y)} \end{twocollist}} } @@ -1657,8 +1761,7 @@ functions so should not be required by the application programmer. Reparents the window, i.e the window will be removed from its current parent window (e.g. a non-standard toolbar in a wxFrame) -and then re-inserted into another (e.g. a wxMiniFrame for a -floating toolbar). Available on Windows and GTK+. +and then re-inserted into another. Available on Windows and GTK. \wxheading{Parameters} @@ -1683,8 +1786,8 @@ Converts from screen to client window coordinates. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{ScreenToClient(point)}}{Accepts and returns a wxPoint} -\twocolitem{\bf{ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)} +\twocolitem{{\bf ScreenToClient(point)}}{Accepts and returns a wxPoint} +\twocolitem{{\bf ScreenToClientXY(x, y)}}{Returns a 2-tuple, (x, y)} \end{twocollist}} } @@ -1703,8 +1806,7 @@ Physically scrolls the pixels in the window and move child windows accordingly. \docparam{rect}{Rectangle to invalidate. If this is NULL, the whole window is invalidated. If you pass a rectangle corresponding to the area of the window exposed by the scroll, your painting handler -can optimise painting by checking for the invalidated region. This paramter is ignored under GTK, -instead the regions to be invalidated are calculated automatically. } +can optimize painting by checking for the invalidated region. This parameter is ignored under GTK.} \wxheading{Remarks} @@ -1722,23 +1824,16 @@ Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}} Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will -be called automatically when the window is resized. Use in connection with -\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and -\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for layouting subwindows. +be called automatically when the window is resized. Use in connection with +\helpref{wxWindow::SetSizer}{wxwindowsetsizer} and +\helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} for laying out +subwindows. \wxheading{Parameters} \docparam{autoLayout}{Set this to TRUE if you wish the Layout function to be called from within wxWindow::OnSize functions.} -\wxheading{Remarks} - -Note that this function is actually disabled for wxWindow. It has -effect for wxDialog, wxFrame, wxPanel and wxScrolledWindow. Windows -of other types that need to invoke the Layout algorithm should provide -an EVT_SIZE handler and call -\helpref{wxWindow::Layout}{wxwindowlayout} from within it. - \wxheading{See also} \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} @@ -1763,9 +1858,9 @@ Note that setting the background colour does not cause an immediate refresh, so may wish to call \helpref{wxWindow::Clear}{wxwindowclear} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after calling this function. -Note that when using this functions under GTK, you will disable the so called "themes", -i.e. the user chosen apperance of windows and controls, including the themes of -their parent windows. +Use this function with care under GTK as the new appearance of the window might +not look equally well when used with "Themes", i.e GTK's ability to change its +look as the user wishes with run-time loadable modules. \wxheading{See also} @@ -1776,6 +1871,12 @@ their parent windows. \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp \helpref{wxWindow::OnEraseBackground}{wxwindowonerasebackground} +\membersection{wxWindow::SetCaret}\label{wxwindowsetcaret} + +\constfunc{void}{SetCaret}{\param{wxCaret *}{caret}} + +Sets the \helpref{caret}{wxcaret} associated with the window. + \membersection{wxWindow::SetClientSize}\label{wxwindowsetclientsize} \func{virtual void}{SetClientSize}{\param{int}{ width}, \param{int}{ height}} @@ -1798,8 +1899,8 @@ around panel items, for example. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{SetClientSize(size)}}{Accepts a wxSize} -\twocolitem{\bf{SetClientSizeWH(width, height)}}{} +\twocolitem{{\bf SetClientSize(size)}}{Accepts a wxSize} +\twocolitem{{\bf SetClientSizeWH(width, height)}}{} \end{twocollist}} } @@ -1807,9 +1908,13 @@ implements the following methods:\par \func{virtual void}{SetCursor}{\param{const wxCursor\&}{cursor}} -Sets the window's cursor. Notice that setting the cursor for this window does -not set it for its children so you'll need to explicitly call SetCursor() for -them too if you need it. +% VZ: the docs are correct, if the code doesn't behave like this, it must be +% changed +Sets the window's cursor. Notice that the window cursor also sets it for the +children of the window implicitly. + +The {\it cursor} may be {\tt wxNullCursor} in which case the window cursor will +be reset back to default. \wxheading{Parameters} @@ -1819,36 +1924,6 @@ them too if you need it. \helpref{::wxSetCursor}{wxsetcursor}, \helpref{wxCursor}{wxcursor} -\membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler} - -\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} - -Sets the event handler for this window. - -\wxheading{Parameters} - -\docparam{handler}{Specifies the handler to be set.} - -\wxheading{Remarks} - -An event handler is an object that is capable of processing the events -sent to a window. By default, the window is its own event handler, but -an application may wish to substitute another, for example to allow -central implementation of event-handling for a variety of different -window classes. - -It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since -this sets up a chain of event handlers, where an event not handled by one event handler is -handed to the next one in the chain. - -\wxheading{See also} - -\helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp -\helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp -\helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp -\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp -\helpref{wxEvtHandler}{wxevthandler} - \membersection{wxWindow::SetConstraints}\label{wxwindowsetconstraints} \func{void}{SetConstraints}{\param{wxLayoutConstraints* }{constraints}} @@ -1883,6 +1958,50 @@ If the window already has a drop target, it is deleted. \helpref{wxWindow::GetDropTarget}{wxwindowgetdroptarget}, \helpref{Drag and drop overview}{wxdndoverview} +\membersection{wxWindow::SetEventHandler}\label{wxwindowseteventhandler} + +\func{void}{SetEventHandler}{\param{wxEvtHandler* }{handler}} + +Sets the event handler for this window. + +\wxheading{Parameters} + +\docparam{handler}{Specifies the handler to be set.} + +\wxheading{Remarks} + +An event handler is an object that is capable of processing the events +sent to a window. By default, the window is its own event handler, but +an application may wish to substitute another, for example to allow +central implementation of event-handling for a variety of different +window classes. + +It is usually better to use \helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler} since +this sets up a chain of event handlers, where an event not handled by one event handler is +handed to the next one in the chain. + +\wxheading{See also} + +\helpref{wxWindow::GetEventHandler}{wxwindowgeteventhandler},\rtfsp +\helpref{wxWindow::PushEventHandler}{wxwindowpusheventhandler},\rtfsp +\helpref{wxWindow::PopEventHandler}{wxwindowpusheventhandler},\rtfsp +\helpref{wxEvtHandler::ProcessEvent}{wxevthandlerprocessevent},\rtfsp +\helpref{wxEvtHandler}{wxevthandler} + +\membersection{wxWindow::SetExtraStyle}\label{wxwindowsetextrastyle} + +\func{void}{SetExtraStyle}{\param{long }{exStyle}} + +Sets the extra style bits for the window. The currently defined extra style +bits are: + +\twocolwidtha{5cm}% +\begin{twocollist}\itemsep=0pt +\twocolitem{\windowstyle{wxWS\_EX\_VALIDATE\_RECURSIVELY}}{TransferDataTo/FromWindow() +and Validate() methods will recursively descend into all children of the +window if it has this style flag set.} +\end{twocollist} + \membersection{wxWindow::SetFocus}\label{wxwindowsetfocus} \func{virtual void}{SetFocus}{\void} @@ -1929,6 +2048,19 @@ their parent windows. \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour} +\membersection{wxWindow::SetHelpText}\label{wxwindowsethelptext} + +\func{virtual void}{SetHelpText}{\param{const wxString\& }{helpText}} + +Sets the help text to be used as context-sensitive help for this window. + +Note that the text is actually stored by the current \helpref{wxHelpProvider}{wxhelpprovider} implementation, +and not in the window object itself. + +\wxheading{See also} + +\helpref{GetHelpText}{wxwindowgethelptext}, \helpref{wxHelpProvider}{wxhelpprovider} + \membersection{wxWindow::SetId}\label{wxwindowsetid} \func{void}{SetId}{\param{int}{ id}} @@ -2176,9 +2308,9 @@ by wxWindows, or that the current value of the dimension should be used. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par \indented{2cm}{\begin{twocollist} -\twocolitem{\bf{SetDimensions(x, y, width, height, sizeFlags=wxSIZE_AUTO)}}{} -\twocolitem{\bf{SetSize(size)}}{} -\twocolitem{\bf{SetPosition(point)}}{} +\twocolitem{{\bf SetDimensions(x, y, width, height, sizeFlags=wxSIZE\_AUTO)}}{} +\twocolitem{{\bf SetSize(size)}}{} +\twocolitem{{\bf SetPosition(point)}}{} \end{twocollist}} } @@ -2253,16 +2385,57 @@ Sets the window's title. Applicable only to frames and dialogs. Deletes the current validator (if any) and sets the window validator, having called wxValidator::Clone to create a new validator of this type. +\membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip} + +\func{void}{SetToolTip}{\param{const wxString\& }{tip}} + +\func{void}{SetToolTip}{\param{wxToolTip* }{tip}} + +Attach a tooltip to the window. + +See also: \helpref{GetToolTip}{wxwindowgettooltip}, + \helpref{wxToolTip}{wxtooltip} + + +\membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip} + +\constfunc{wxToolTip*}{GetToolTip}{\void} + +Get the associated tooltip or NULL if none. + + + +\membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle} + +\func{void}{SetWindowStyle}{\param{long}{ style}} + +Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}. + +\membersection{wxWindow::SetWindowStyleFlag}\label{wxwindowsetwindowstyleflag} + +\func{virtual void}{SetWindowStyleFlag}{\param{long}{ style}} + +Sets the style of the window. Please note that some styles cannot be changed +after the window creation and that \helpref{Refresh()}{wxwindowrefresh} might +be called after changing the others for the change to take place immediately. + +See \helpref{Window styles}{windowstyles} for more information about flags. + +\wxheading{See also} + +\helpref{GetWindowStyleFlag}{wxwindowgetwindowstyleflag} + \membersection{wxWindow::Show}\label{wxwindowshow} \func{virtual bool}{Show}{\param{bool}{ show}} -Shows or hides the window. +Shows or hides the window. You may need to call \helpref{Raise}{wxwindowraise} +for a top level window if you want to bring it to top, although this is not +needed if Show() is called immediately after the frame creation. \wxheading{Parameters} -\docparam{show}{If TRUE, displays the window and brings it to the front. Otherwise, -hides the window.} +\docparam{show}{If TRUE displays the window. Otherwise, hides it.} \wxheading{See also} @@ -2275,6 +2448,9 @@ hides the window.} Transfers values from child controls to data areas specified by their validators. Returns FALSE if a transfer failed. +If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set, +the method will also call TransferDataFromWindow() of all child windows. + \wxheading{See also} \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow},\rtfsp @@ -2286,6 +2462,9 @@ FALSE if a transfer failed. Transfers values to child controls from data areas specified by their validators. +If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set, +the method will also call TransferDataToWindow() of all child windows. + \wxheading{Return value} Returns FALSE if a transfer failed. @@ -2301,6 +2480,9 @@ Returns FALSE if a transfer failed. Validates the current values of the child controls using their validators. +If the window has {\tt wxWS\_EX\_VALIDATE\_RECURSIVELY} extra style flag set, +the method will also call Validate() of all child windows. + \wxheading{Return value} Returns FALSE if any of the validations failed.