X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f4fcc2919776cffa5e3b2f0d44dd24c41e652ff4..e3ba9f8828b5cb1c61011e386a5e44fd16d2d8a5:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index ca648a2f1f..5ccf411a0d 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -397,6 +397,11 @@ Destroys all children of a window. Called automatically by the destructor. Disables the window, same as \helpref{Enable({\tt FALSE})}{wxwindowenable}. +\wxheading{Return value} + +Returns {\tt TRUE} if the window has been disabled, {\tt FALSE} if it had been +already disabled before the call to this function. + \membersection{wxWindow::DragAcceptFiles}\label{wxwindowdragacceptfiles} \func{virtual void}{DragAcceptFiles}{\param{bool}{ accept}} @@ -414,7 +419,7 @@ Windows only. \membersection{wxWindow::Enable}\label{wxwindowenable} -\func{virtual void}{Enable}{\param{bool}{ enable = {\tt TRUE}}} +\func{virtual bool}{Enable}{\param{bool}{ enable = {\tt TRUE}}} Enable or disable the window for user input. @@ -422,6 +427,11 @@ Enable or disable the window for user input. \docparam{enable}{If {\tt TRUE}, enables the window for input. If {\tt FALSE}, disables the window.} +\wxheading{Return value} + +Returns {\tt TRUE} if the window has been enabled or disabled, {\tt FALSE} if +nothing was done, i.e. if the window had already been in the specified state. + \wxheading{See also} \helpref{wxWindow::IsEnabled}{wxwindowisenabled},\rtfsp @@ -459,6 +469,49 @@ implements the following methods:\par \end{twocollist}} } +\membersection{wxWindow::FindWindowById}\label{wxwindowfindwindow} + +\func{wxWindow*}{FindWindowById}{\param{long}{ id}} + +Find the first window with the given {\it id}. + +If {\it parent} is NULL, the search will start from all top-level +frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. +The search is recursive in both cases. + +\wxheading{See also} + +\helpref{FindWindowById}{wxwindowfindwindowbyid} + +\membersection{wxWindow::FindWindowByName}\label{wxwindowfindwindowbyname} + +\func{wxWindow*}{FindWindowByName}{\param{long}{ id}} + +Find a window by its name (as given in a window constructor or {\bf Create} function call). +If {\it parent} is NULL, the search will start from all top-level +frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. +The search is recursive in both cases. + +If no window with such name is found, +\helpref{FindWindowByLabel}{wxwindowfindwindowbylabel} is called. + +\wxheading{See also} + +\helpref{FindWindowById}{wxwindowfindwindowbyid} + +\membersection{wxWindow::FindWindowByLabel}\label{wxwindowfindwindowbylabel} + +\func{wxWindow*}{FindWindowByLabel}{\param{long}{ id}} + +Find a window by its label. Depending on the type of window, the label may be a window title +or panel item label. If {\it parent} is NULL, the search will start from all top-level +frames and dialog boxes; if non-NULL, the search will be limited to the given window hierarchy. +The search is recursive in both cases. + +\wxheading{See also} + +\helpref{FindWindowById}{wxwindowfindwindowbyid} + \membersection{wxWindow::Fit}\label{wxwindowfit} \func{virtual void}{Fit}{\void} @@ -509,6 +562,19 @@ same as the size the window would have had after calling Returns the \helpref{caret}{wxcaret} associated with the window. +\membersection{wxWindow::GetCapture}\label{wxwindowgetcapture} + +\func{static wxWindow *}{GetCapture}{\void} + +Returns the currently captured window. + +\wxheading{See also} + +\helpref{wxWindow::HasCapture}{wxwindowhascapture}, +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + \membersection{wxWindow::GetCharHeight} \constfunc{virtual int}{GetCharHeight}{\void} @@ -557,6 +623,7 @@ implements the following methods:\par \wxheading{See also} \helpref{GetSize}{wxwindowgetsize} +\helpref{GetVirtualSize}{wxwindowgetvirtualsize} \membersection{wxWindow::GetConstraints}\label{wxwindowgetconstraints} @@ -813,7 +880,8 @@ method:\par \wxheading{See also} -\helpref{GetClientSize}{wxwindowgetclientsize} +\helpref{GetClientSize}{wxwindowgetclientsize},\rtfsp +\helpref{GetVirtualSize}{wxwindowgetvirtualsize} \membersection{wxWindow::GetSizer}\label{wxwindowgetsizer} @@ -889,6 +957,23 @@ only be called within an \helpref{wxPaintEvent}{wxpaintevent} handler. Returns a pointer to the current validator for the window, or NULL if there is none. +\membersection{wxWindow::GetVirtualSize}\label{wxwindowgetvirtualsize} + +\constfunc{void}{GetVirtualSize}{\param{int* }{width}, \param{int* }{height}} + +\constfunc{wxSize}{GetVirtualSize}{\void} + +This gets the virtual size of the window in pixels. + +\wxheading{Parameters} + +\docparam{width}{Receives the window virtual width.} + +\docparam{height}{Receives the window virtual height.} + +\helpref{GetSize}{wxwindowgetsize},\rtfsp +\helpref{GetClientSize}{wxwindowgetclientsize} + \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag} \constfunc{long}{GetWindowStyleFlag}{\void} @@ -896,6 +981,18 @@ Returns a pointer to the current validator for the window, or NULL if there is n 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::HasCapture}\label{wxwindowhascapture} + +\constfunc{virtual bool}{HasCapture}{\void} + +Returns TRUE if this window has the current mouse capture. + +\wxheading{See also} + +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} + \membersection{wxWindow::Hide}\label{wxwindowhide} \func{bool}{Hide}{\void} @@ -1665,7 +1762,10 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt \wxheading{See also} -\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse} +\helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, +\helpref{wxWindow::HasCapture}{wxwindowhascapture}, +\helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} \membersection{wxWindow::RemoveChild}\label{wxwindowremovechild} @@ -1678,7 +1778,7 @@ functions so should not be required by the application programmer. \docparam{child}{Child window to remove.} -\membersection{wxWindow::RemoveEventHandler}{wxwindowremoveeventhandler} +\membersection{wxWindow::RemoveEventHandler}\label{wxwindowremoveeventhandler} \func{bool}{RemoveEventHandler}{\param{wxEvtHandler *}{handler}} @@ -2012,7 +2112,7 @@ caption. When pressed, Windows will go into a context-sensitive help mode and wx a wxEVT\_HELP event if the user clicked on an application window. This style cannot be used together with wxMAXIMIZE\_BOX or wxMINIMIZE\_BOX, so you should use the style of -{\tt wxDEFAULT\_FRAME\_STYLE & ~(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the +{\tt wxDEFAULT\_FRAME\_STYLE \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the frames having this style (the dialogs don't have minimize nor maximize box by default)} \end{twocollist} @@ -2023,6 +2123,19 @@ default)} This sets the window to receive keyboard input. +\wxheading{See also} + +\helpref{wxFocusEvent}{wxfocusevent} + +\membersection{wxWindow::SetFocusFromKbd}\label{wxwindowsetfocusfromkbd} + +\func{virtual void}{SetFocusFromKbd}{\void} + +This function is called by wxWindows keyboard navigation code when the user +gives the focus to this window from keyboard (e.g. using {\tt TAB} key). +By default this method simply calls \helpref{SetFocus}{wxwindowsetfocus} but +can be overridden to do something in addition to this in the derived classes. + \membersection{wxWindow::SetFont}\label{wxwindowsetfont} \func{void}{SetFont}{\param{const wxFont\& }{font}} @@ -2377,11 +2490,21 @@ Pass FALSE if you wish to handle deleting the old sizer yourself.} \wxheading{Remarks} +SetSizer now enables and disables Layout automatically, but prior to wxWindows 2.3.3 +the following applied: + You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use the sizer automatically in OnSize; otherwise, you must override OnSize and call Layout() explicitly. When setting both a wxSizer and a \helpref{wxLayoutConstraints}{wxlayoutconstraints}, only the sizer will have effect. +\membersection{wxWindow::SetSizerAndFit}\label{wxwindowsetsizerandfit} + +\func{void}{SetSizerAndFit}{\param{wxSizer* }{sizer}, \param{bool }{deleteOld=TRUE}} + +The same as \helpref{SetSizer}{wxwindowsetsizer}, except it also sets the size hints +for the window based on the sizer's minimum size. + \membersection{wxWindow::SetTitle}\label{wxwindowsettitle} \func{virtual void}{SetTitle}{\param{const wxString\& }{title}} @@ -2422,6 +2545,37 @@ See also: \helpref{GetToolTip}{wxwindowgettooltip}, Get the associated tooltip or NULL if none. +\membersection{wxWindow::SetVirtualSize}\label{wxwindowsetvirtualsize} + +\func{void}{SetVirtualSize}{\param{int}{ width}, \param{int}{ height}} + +\func{void}{SetVirtualSize}{\param{const wxSize\&}{ size}} + +Sets the virtual size of the window in pixels. + + +\membersection{wxWindow::SetVirtualSizeHints}\label{wxwindowsetvirtualsizehints} + +\func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}} + +Allows specification of minimum and maximum virtual window sizes. +If a pair of values is not set (or set to -1), the default values +will be used. + +\wxheading{Parameters} + +\docparam{minW}{Specifies the minimum width allowable.} + +\docparam{minH}{Specifies the minimum height allowable.} + +\docparam{maxW}{Specifies the maximum width allowable.} + +\docparam{maxH}{Specifies the maximum height allowable.} + +\wxheading{Remarks} + +If this function is called, the user will not be able to size the virtual area +of the window outside the given bounds. \membersection{wxWindow::SetWindowStyle}\label{wxwindowsetwindowstyle}