X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/d9f42a9e5a62fd9d8f06bc4685cb7db721e231bc..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index e61faddd2a..4c15ed1719 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -3,7 +3,7 @@ %% Purpose: wxWindow documentation %% Author: wxWidgets Team %% Modified by: -%% Created: +%% Created: %% RCS-ID: $Id$ %% Copyright: (c) wxWidgets Team %% License: wxWindows license @@ -138,13 +138,13 @@ Constructs a window, which can be a child of a frame, dialog or any other non-co \docparam{parent}{Pointer to a parent window.} -\docparam{id}{Window identifier. If -1, will automatically create an identifier.} +\docparam{id}{Window identifier. If wxID\_ANY, will automatically create an identifier.} -\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets +\docparam{pos}{Window position. wxDefaultPosition indicates that wxWidgets should generate a default position for the window. If using the wxWindow class directly, supply an actual position.} -\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets +\docparam{size}{Window size. wxDefaultSize indicates that wxWidgets should generate a default size for the window. If no suitable size can be found, the window will be sized to 20x20 pixels so that the window is visible but obviously not correctly sized. } @@ -355,7 +355,7 @@ Usually it is only used with the top level windows (wxFrame and wxDialog classes) as the others are not supposed to have any special OnClose() logic. The close handler should check whether the window is being deleted forcibly, -using \helpref{wxCloseEvent::GetForce}{wxcloseeventgetforce}, in which case it +using \helpref{wxCloseEvent::CanVeto}{wxcloseeventcanveto}, in which case it should destroy the window using \helpref{wxWindow::Destroy}{wxwindowdestroy}. {\it Note} that calling Close does not guarantee that the window will be @@ -689,6 +689,10 @@ a wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all controls so it is mostly just a hint to wxWidgets and not a mandatory directive. +\wxheading{See also} + +\helpref{wxWindowUpdateLocker}{wxwindowupdatelocker} + \membersection{wxWindow::GetAcceleratorTable}\label{wxwindowgetacceleratortable} @@ -809,9 +813,13 @@ Returns the average character width for this window. \membersection{wxWindow::GetChildren}\label{wxwindowgetchildren} -\func{wxList\&}{GetChildren}{\void} +\func{wxWindowList\&}{GetChildren}{\void} -Returns a reference to the list of the window's children. +\constfunc{const wxWindowList\&}{GetChildren}{\void} + +Returns a reference to the list of the window's children. \texttt{wxWindowList} +is a type-safe \helpref{wxList}{wxlist}-like class whose elements are of type +\texttt{wxWindow *}. \membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes} @@ -1031,7 +1039,7 @@ Returns the identifier of the window. \wxheading{Remarks} Each window has an integer identifier. If the application has not provided one -(or the default Id -1) an unique identifier with a negative value will be generated. +(or the default wxID\_ANY) an unique identifier with a negative value will be generated. \wxheading{See also} @@ -1103,9 +1111,9 @@ windows. \wxheading{Parameters} -\docparam{x}{Receives the x position of the window.} +\docparam{x}{Receives the x position of the window if non-\NULL.} -\docparam{y}{Receives the y position of the window.} +\docparam{y}{Receives the y position of the window if non-\NULL.} \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par @@ -1125,12 +1133,53 @@ method:\par }} +\wxheading{See also} + +\helpref{GetScreenPosition}{wxwindowgetscreenposition} + + \membersection{wxWindow::GetRect}\label{wxwindowgetrect} \constfunc{virtual wxRect}{GetRect}{\void} Returns the size and position of the window as a \helpref{wxRect}{wxrect} object. +\wxheading{See also} + +\helpref{GetScreenRect}{wxwindowgetscreenrect} + + +\membersection{wxWindow::GetScreenPosition}\label{wxwindowgetscreenposition} + +\constfunc{virtual void}{GetScreenPosition}{\param{int* }{x}, \param{int* }{y}} + +\constfunc{wxPoint}{GetScreenPosition}{\void} + +Returns the window position in screen coordinates, whether the window is a +child window or a top level one. + +\wxheading{Parameters} + +\docparam{x}{Receives the x position of the window on the screen if non-\NULL.} + +\docparam{y}{Receives the y position of the window on the screen if non-\NULL.} + +\wxheading{See also} + +\helpref{GetPosition}{wxwindowgetposition} + + +\membersection{wxWindow::GetScreenRect}\label{wxwindowgetscreenrect} + +\constfunc{virtual wxRect}{GetScreenRect}{\void} + +Returns the size and position of the window on the screen as a +\helpref{wxRect}{wxrect} object. + +\wxheading{See also} + +\helpref{GetRect}{wxwindowgetrect} + \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos} @@ -1250,17 +1299,6 @@ implements the following methods:\par {\tt ( x, y, descent, externalLeading )}.} -\membersection{wxWindow::GetTitle}\label{wxwindowgettitle} - -\func{virtual wxString}{GetTitle}{\void} - -Gets the window's title. Applicable only to frames and dialogs. - -\wxheading{See also} - -\helpref{wxWindow::SetTitle}{wxwindowsettitle} - - \membersection{wxWindow::GetToolTip}\label{wxwindowgettooltip} \constfunc{wxToolTip*}{GetToolTip}{\void} @@ -1338,6 +1376,13 @@ Returns {\tt true} if this window has the current mouse capture. \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} +\membersection{wxWindow::HasFlag}\label{wxwindowhasflag} + +\constfunc{bool}{HasFlag}{\param{int }{flag}} + +Returns \texttt{true} if the window has the given \arg{flag} bit set. + + \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar} \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}} @@ -1498,7 +1543,7 @@ This is just a wrapper for \helpref{ScrollLines}{wxwindowscrolllines}$(-1)$. \func{void}{Lower}{\void} -Lowers the window to the bottom of the window hierarchy. +Lowers the window to the bottom of the window hierarchy (z-order). \wxheading{See also} @@ -1541,7 +1586,7 @@ wxWindow::Move function, which is defined in the base wxWindow class as the call: \begin{verbatim} - SetSize(x, y, -1, -1, wxSIZE_USE_EXISTING); + SetSize(x, y, wxDefaultCoord, wxDefaultCoord, wxSIZE_USE_EXISTING); \end{verbatim} \wxheading{See also} @@ -1826,28 +1871,6 @@ and not navigate to the next control. %% %% \helpref{wxValidator}{wxvalidator}, \helpref{wxWindow::TransferDataToWindow}{wxwindowtransferdatatowindow} %% -%% \membersection{wxWindow::OnMenuCommand}\label{wxwindowonmenucommand} -%% -%% \func{void}{OnMenuCommand}{\param{wxCommandEvent\& }{event}} -%% -%% Called when a menu command is received from a menu bar. -%% -%% \wxheading{Parameters} -%% -%% \docparam{event}{The menu command event. For more information, see \helpref{wxCommandEvent}{wxcommandevent}.} -%% -%% \wxheading{Remarks} -%% -%% A function with this name doesn't actually exist; you can choose any member function to receive -%% menu command events, using the EVT\_COMMAND macro for individual commands or EVT\_COMMAND\_RANGE for -%% a range of commands. -%% -%% \wxheading{See also} -%% -%% \helpref{wxCommandEvent}{wxcommandevent},\rtfsp -%% \helpref{wxWindow::OnMenuHighlight}{wxwindowonmenuhighlight},\rtfsp -%% \helpref{Event handling overview}{eventhandlingoverview} -%% %% \membersection{wxWindow::OnMenuHighlight}\label{wxwindowonmenuhighlight} %% %% \func{void}{OnMenuHighlight}{\param{wxMenuEvent\& }{event}} @@ -1875,7 +1898,6 @@ and not navigate to the next control. %% \wxheading{See also} %% %% \helpref{wxMenuEvent}{wxmenuevent},\rtfsp -%% \helpref{wxWindow::OnMenuCommand}{wxwindowonmenucommand},\rtfsp %% \helpref{Event handling overview}{eventhandlingoverview} %% %% @@ -2220,9 +2242,9 @@ remove the event handler. \func{void}{Raise}{\void} -Raises the window to the top of the window hierarchy. +Raises the window to the top of the window hierarchy (z-order). -In current version of wxWidgets this works both for manage and child windows. +In current version of wxWidgets this works both for managed and child windows. \wxheading{See also} @@ -2236,7 +2258,7 @@ In current version of wxWidgets this works both for manage and child windows. Causes this window, and all of its children recursively (except under wxGTK1 where this is not implemented), to be repainted. Note that repainting doesn't happen immediately but only during the next event loop iteration, if you need -to update the window immediately you should use \helpref{Update}{wxwindowupdate} +to update the window immediately you should use \helpref{Update}{wxwindowupdate} instead. \wxheading{Parameters} @@ -2337,7 +2359,7 @@ not delete) it from it. \wxheading{Parameters} -\docparam{handler}{The event handler to remove, must be non {\tt NULL} and +\docparam{handler}{The event handler to remove, must be non-{\tt NULL} and must be present in this windows event handlers chain} \wxheading{Return value} @@ -2427,9 +2449,7 @@ on top/bottom and nothing was done. \wxheading{Remarks} -This function is currently only implemented under MSW and wxTextCtrl under -wxGTK (it also works for wxScrolledWindow derived classes under all -platforms). +This function is currently only implemented under MSW and wxGTK. \wxheading{See also} @@ -2454,7 +2474,7 @@ parameter)} \wxheading{Remarks} -Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow} +Note that you can often use \helpref{wxScrolledWindow}{wxscrolledwindow} instead of using this function directly. @@ -2480,16 +2500,21 @@ See also \helpref{wxAccessible}{wxaccessible}. \func{void}{SetAutoLayout}{\param{bool}{ autoLayout}} Determines whether the \helpref{wxWindow::Layout}{wxwindowlayout} function will -be called automatically when the window is resized. It is called implicitly by -\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use +be called automatically when the window is resized. Please note that this only +happens for the windows usually used to contain children, namely +\helpref{wxPanel}{wxpanel} and \helpref{wxTopLevelWindow}{wxtoplevelwindow} +(and the classes deriving from them). + +This method is called implicitly by +\helpref{wxWindow::SetSizer}{wxwindowsetsizer} but if you use \helpref{wxWindow::SetConstraints}{wxwindowsetconstraints} you should call it manually or otherwise the window layout won't be correctly updated when its size changes. \wxheading{Parameters} -\docparam{autoLayout}{Set this to {\tt true} if you wish the Layout function to be called -from within wxWindow::OnSize functions.} +\docparam{autoLayout}{Set this to \true if you wish the Layout function to be +called automatically when the window is resized.} \wxheading{See also} @@ -2783,6 +2808,12 @@ use \helpref{SetOwnFont}{wxwindowsetownfont} instead in this case and see \helpref{InheritAttributes}{wxwindowinheritattributes} for more explanations. +Please notice that the given font is \emph{not} automatically used for +\helpref{wxPaintDC}{wxpaintdc} objects associated with this window, you need to +call \helpref{wxDC::SetFont()}{wxdcsetfont} too. However this font is used by +any standard controls for drawing their text as well as by +\helpref{wxWindow::GetTextExtent()}{wxwindowgettextextent}. + \wxheading{Parameters} \docparam{font}{Font to associate with this window, pass @@ -3001,7 +3032,8 @@ from your \helpref{wxSizeEvent}{wxsizeevent} handler function. \wxheading{See also} \helpref{Scrolling overview}{scrollingoverview},\rtfsp -\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow} +\helpref{wxScrollBar}{wxscrollbar}, \helpref{wxScrolledWindow}{wxscrolledwindow},\rtfsp +\helpref{wxScrollWinEvent}{wxscrollwinevent} \begin{comment} @@ -3123,16 +3155,16 @@ Sets the size of the window in pixels. \wxheading{Parameters} -\docparam{x}{Required x position in pixels, or -1 to indicate that the existing +\docparam{x}{Required x position in pixels, or wxDefaultCoord to indicate that the existing value should be used.} -\docparam{y}{Required y position in pixels, or -1 to indicate that the existing +\docparam{y}{Required y position in pixels, or wxDefaultCoord to indicate that the existing value should be used.} -\docparam{width}{Required width in pixels, or -1 to indicate that the existing +\docparam{width}{Required width in pixels, or wxDefaultCoord to indicate that the existing value should be used.} -\docparam{height}{Required height position in pixels, or -1 to indicate that the existing +\docparam{height}{Required height position in pixels, or wxDefaultCoord to indicate that the existing value should be used.} \docparam{size}{\helpref{wxSize}{wxsize} object for setting the size.} @@ -3141,15 +3173,15 @@ value should be used.} \docparam{sizeFlags}{Indicates the interpretation of other parameters. It is a bit list of the following: -{\bf wxSIZE\_AUTO\_WIDTH}: a $-1$ width value is taken to indicate -a wxWidgets-supplied default width.\\ -{\bf wxSIZE\_AUTO\_HEIGHT}: a $-1$ height value is taken to indicate +{\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate a wxWidgets-supplied default width.\\ -{\bf wxSIZE\_AUTO}: -1 size values are taken to indicate +{\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate +a wxWidgets-supplied default height.\\ +{\bf wxSIZE\_AUTO}: $wxDefaultCoord$ size values are taken to indicate a wxWidgets-supplied default size.\\ {\bf wxSIZE\_USE\_EXISTING}: existing dimensions should be used -if -1 values are supplied.\\ -{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow dimensions of $-1$ and less to be interpreted +if $wxDefaultCoord$ values are supplied.\\ +{\bf wxSIZE\_ALLOW\_MINUS\_ONE}: allow negative dimensions (ie. value of $wxDefaultCoord$) to be interpreted as real dimensions, not default values. {\bf wxSIZE\_FORCE}: normally, if the position and the size of the window are already the same as the parameters of this function, nothing is done. but with @@ -3163,7 +3195,7 @@ The second form is a convenience for calling the first form with default x and y parameters, and must be used with non-default width and height values. The first form sets the position and optionally size, of the window. -Parameters may be -1 to indicate either that a default should be supplied +Parameters may be $wxDefaultCoord$ to indicate either that a default should be supplied by wxWidgets, or that the current value of the dimension should be used. \wxheading{See also} @@ -3275,21 +3307,6 @@ Dialogs, notebook pages and the status bar have this flag set to true by default so that the default look and feel is simulated best. -\membersection{wxWindow::SetTitle}\label{wxwindowsettitle} - -\func{virtual void}{SetTitle}{\param{const wxString\& }{title}} - -Sets the window's title. Applicable only to frames and dialogs. - -\wxheading{Parameters} - -\docparam{title}{The window's title.} - -\wxheading{See also} - -\helpref{wxWindow::GetTitle}{wxwindowgettitle} - - \membersection{wxWindow::SetToolTip}\label{wxwindowsettooltip} \func{void}{SetToolTip}{\param{const wxString\& }{tip}} @@ -3439,6 +3456,10 @@ Reenables window updating after a previous call to \helpref{Freeze}{wxwindowfreeze}. To really thaw the control, it must be called exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}. +\wxheading{See also} + +\helpref{wxWindowUpdateLocker}{wxwindowupdatelocker} + \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow} @@ -3593,4 +3614,3 @@ Interface Guidelines forbid moving the mouse cursor programmatically. \docparam{x}{The new x position for the cursor.} \docparam{y}{The new y position for the cursor.} -