X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/dc7a2021d59a9ee18c148974381bb9ece66a522a..5814e8ba4e57839acd1eb7491ed392b07e382593:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 6f954a2a1e..eab626d510 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -62,19 +62,22 @@ events. Windows only.} the window wants to get all char/key events for all keys - even for keys like TAB or ENTER which are usually used for dialog navigation and which wouldn't be generated without this style. If you need to -use this style in order to get the arrows or etc., but would still like to have -normal keyboard navigation take place, you should create and send a -wxNavigationKeyEvent in response to the key events for Tab and -Shift-Tab.} +use this style in order to get the arrows or etc., but would still like +to have normal keyboard navigation take place, you should call +\helpref{Navigate}{wxwindownavigate} in response to the key events for +Tab and Shift-Tab.} \twocolitem{\windowstyle{wxNO\_FULL\_REPAINT\_ON\_RESIZE}}{On Windows, this style used to disable repainting the window completely when its size is changed. Since this behaviour is now the default, the style is now obsolete and no longer has an effect.} -\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical scrollbar.} -\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal scrollbar.} +\twocolitem{\windowstyle{wxVSCROLL}}{Use this style to enable a vertical +scrollbar. Notice that this style cannot be used with native controls +which don't support scrollbars nor with top-level windows in most ports.} +\twocolitem{\windowstyle{wxHSCROLL}}{Use this style to enable a horizontal +scrollbar. The same limitations as for wxVSCROLL apply to this style.} \twocolitem{\windowstyle{wxALWAYS\_SHOW\_SB}}{If a window has scrollbars, disable them instead of hiding them when they are not needed (i.e. when the size of the window is big enough to not require the scrollbars to navigate it). -This style is currently only implemented for wxMSW and wxUniversal and does +This style is currently implemented for wxMSW, wxGTK and wxUniversal and does nothing on the other platforms.} \twocolitem{\windowstyle{wxCLIP\_CHILDREN}}{Use this style to eliminate flicker caused by the background being repainted, then children being painted over them. Windows only.} @@ -115,7 +118,8 @@ even if the mode set by \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmod \wxheading{See also} -\helpref{Event handling overview}{eventhandlingoverview} +\helpref{Event handling overview}{eventhandlingoverview}\\ +\helpref{Window sizing overview}{windowsizingoverview} \latexignore{\rtfignore{\wxheading{Members}}} @@ -170,6 +174,29 @@ can delete a window only when it is safe to do so, in idle time. \helpref{wxCloseEvent}{wxcloseevent} +\membersection{wxWindow::AcceptsFocus}\label{wxwindowacceptsfocus} + +\constfunc{bool}{AcceptsFocus}{\void} + +This method may be overridden in the derived classes to return \false to +indicate that this control doesn't accept input at all (i.e. behaves like e.g. +\helpref{wxStaticText}{wxstatictext}) and so doesn't need focus. + +\wxheading{See also} + +\helpref{AcceptsFocusFromKeyboard}{wxwindowacceptsfocusfromkeyboard} + + +\membersection{wxWindow::AcceptsFocusFromKeyboard}\label{wxwindowacceptsfocusfromkeyboard} + +\constfunc{bool}{AcceptsFocusFromKeyboard}{\void} + +This method may be overridden in the derived classes to return \false to +indicate that while this control can, in principle, have focus if the user +clicks it with the mouse, it shouldn't be included in the TAB traversal chain +when using the keyboard. + + \membersection{wxWindow::AddChild}\label{wxwindowaddchild} \func{virtual void}{AddChild}{\param{wxWindow* }{child}} @@ -203,11 +230,18 @@ Note that wxWidgets maintains the stack of windows having captured the mouse and when the mouse is released the capture returns to the window which had had captured it previously and it is only really released if there were no previous window. In particular, this means that you must release the mouse as many times -as you capture it. +as you capture it, unless the window receives +the \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} event. + +Any application which captures the mouse in the beginning of some operation +{\em must} handle \helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} +and cancel this operation when it receives the event. The event handler must +not recapture mouse. \wxheading{See also} \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse} +\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} \membersection{wxWindow::Center}\label{wxwindowcenter} @@ -355,7 +389,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 @@ -651,7 +685,7 @@ If no window with such name is found, \func{virtual void}{Fit}{\void} Sizes the window so that it fits around its subwindows. This function won't do -anything if there are no subwindows and will only really work correctly if the +anything if there are no subwindows and will only really work correctly if sizers are used for the subwindows layout. Also, if the window has exactly one subwindow it is better (faster and the result is more precise as Fit adds some margin to account for fuzziness of its calculations) to call @@ -689,6 +723,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} @@ -710,11 +748,8 @@ See also \helpref{wxAccessible}{wxaccessible}. \constfunc{wxSize}{GetAdjustedBestSize}{\void} -This method is similar to \helpref{GetBestSize}{wxwindowgetbestsize}, except -in one thing. GetBestSize should return the minimum untruncated size of the -window, while this method will return the largest of BestSize and any user -specified minimum size. ie. it is the minimum size the window should currently -be drawn at, not the minimal size it can possibly tolerate. +This method is deprecated, use \helpref{GetEffectiveMinSize}{wxwindowgeteffectiveminsize} +instead. \membersection{wxWindow::GetBackgroundColour}\label{wxwindowgetbackgroundcolour} @@ -747,17 +782,18 @@ background, such as a tiled bitmap. Currently the style has no effect on other p \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp \helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle} -\membersection{wxWindow::GetBestFittingSize}\label{wxwindowgetbestfittingsize} +\membersection{wxWindow::GetEffectiveMinSize}\label{wxwindowgeteffectiveminsize} -\constfunc{wxSize}{GetBestFittingSize}{\void} +\constfunc{wxSize}{GetEffectiveMinSize}{\void} -Merges the window's best size into the min size and returns the result. +Merges the window's best size into the min size and returns the +result. This is the value used by sizers to determine the appropriate +ammount of sapce to allocate for the widget. \wxheading{See also} \helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp -\helpref{wxWindow::SetBestFittingSize}{wxwindowsetbestfittingsize},\rtfsp -\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints} +\helpref{wxWindow::SetInitialSize}{wxwindowsetinitialsize} \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize} @@ -783,6 +819,7 @@ Returns the currently captured window. \helpref{wxWindow::HasCapture}{wxwindowhascapture}, \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} @@ -858,9 +895,12 @@ a 2-element list {\tt (width, height)}.} \constfunc{wxSize}{GetClientSize}{\void} -This gets the size of the window `client area' in pixels. -The client area is the area which may be drawn on by the programmer, -excluding title bar, border, scrollbars, etc. +Returns the size of the window `client area' in pixels. The client area is the +area which may be drawn on by the programmer, excluding title bar, border, +scrollbars, etc. + +Note that if this window is a top-level one and it is currently minimized, the +return size is empty (both width and height are $0$). \wxheading{Parameters} @@ -1012,6 +1052,23 @@ handle, such as {\bf HWND} for Windows, {\bf Widget} for Motif, {\bf GtkWidget} \perlnote{This method will return an integer in wxPerl.} +\membersection{wxWindow::GetHelpTextAtPoint}\label{wxwindowgethelptextatpoint} + +\constfunc{virtual wxString}{GetHelpTextAtPoint}{\param{const wxPoint &}{point}, \param{wxHelpEvent::Origin }{origin}} + +Gets the help text to be used as context-sensitive help for this window. This +method should be overridden if the help message depends on the position inside +the window, otherwise \helpref{GetHelpText}{wxwindowgethelptext} can be used. + +\wxheading{Parameters} + +\docparam{point}{Coordinates of the mouse at the moment of help event emission.} + +\docparam{origin}{Help event origin, see also \helpref{wxHelpEvent::GetOrigin}{wxhelpeventgetorigin}.} + +\newsince{2.7.0} + + \membersection{wxWindow::GetHelpText}\label{wxwindowgethelptext} \constfunc{virtual wxString}{GetHelpText}{\void} @@ -1023,7 +1080,7 @@ and not in the window object itself. \wxheading{See also} -\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{wxHelpProvider}{wxhelpprovider} +\helpref{SetHelpText}{wxwindowsethelptext}, \helpref{GetHelpTextAtPoint}{wxwindowgethelptextatpoint}, \helpref{wxHelpProvider}{wxhelpprovider} \membersection{wxWindow::GetId}\label{wxwindowgetid} @@ -1063,14 +1120,16 @@ by name. \constfunc{wxSize}{GetMaxSize}{\void} Returns the maximum size of the window, an indication to the sizer layout mechanism -that this is the maximum possible size. +that this is the maximum possible size. \membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize} -\constfunc{wxSize}{GetMinSize}{\void} +\constfunc{virtual wxSize}{GetMinSize}{\void} Returns the minimum size of the window, an indication to the sizer layout mechanism -that this is the minimum required size. +that this is the minimum required size. It normally just returns the value set +by \helpref{SetMinSize}{wxwindowsetminsize}, but it can be overridden to do the +calculation on demand. \membersection{wxWindow::GetName}\label{wxwindowgetname} @@ -1107,9 +1166,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 @@ -1129,11 +1188,52 @@ 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. +Returns the position and size 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 position and size of the window on the screen as a +\helpref{wxRect}{wxrect} object. + +\wxheading{See also} + +\helpref{GetRect}{wxwindowgetrect} \membersection{wxWindow::GetScrollPos}\label{wxwindowgetscrollpos} @@ -1175,8 +1275,11 @@ Returns the built-in scrollbar thumb size. \constfunc{wxSize}{GetSize}{\void} -This gets the size of the entire window in pixels, -including title bar, border, scrollbars, etc. +Returns the size of the entire window in pixels, including title bar, border, +scrollbars, etc. + +Note that if this window is a top-level one and it is currently minimized, the +returned size is the restored window size, not the size of the window icon. \wxheading{Parameters} @@ -1217,20 +1320,25 @@ Return the sizer associated with the window by a previous call to \membersection{wxWindow::GetTextExtent}\label{wxwindowgettextextent} -\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{x}, \param{int* }{y}, +\constfunc{virtual void}{GetTextExtent}{\param{const wxString\& }{string}, \param{int* }{w}, \param{int* }{h}, \param{int* }{descent = NULL}, \param{int* }{externalLeading = NULL}, \param{const wxFont* }{font = NULL}, \param{bool}{ use16 = {\tt false}}} +\constfunc{wxSize}{GetTextExtent}{\param{const wxString\& }{string}} + Gets the dimensions of the string as it would be drawn on the window with the currently selected font. +The text extent is returned in \arg{w} and \arg{h} pointers (first form) or as a +\helpref{wxSize}{wxsize} object (second form). + \wxheading{Parameters} \docparam{string}{String whose extent is to be measured.} -\docparam{x}{Return value for width.} +\docparam{w}{Return value for width.} -\docparam{y}{Return value for height.} +\docparam{h}{Return value for height.} \docparam{descent}{Return value for descent (optional).} @@ -1302,6 +1410,14 @@ that size. \helpref{GetClientSize}{wxwindowgetclientsize} +\membersection{wxWindow::GetWindowBorderSize}\label{wxwindowgetwindowbordersize} + +\constfunc{wxSize}{GetWindowBorderSize}{\void} + +Returns the size of the left/right and top/bottom borders of this window in x +and y components of the result respectively. + + \membersection{wxWindow::GetWindowStyleFlag}\label{wxwindowgetwindowstyleflag} \constfunc{long}{GetWindowStyleFlag}{\void} @@ -1328,9 +1444,22 @@ Returns {\tt true} if this window has the current mouse capture. \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} +\membersection{wxWindow::HasExtraStyle}\label{wxwindowhasextrastyle} + +\constfunc{bool}{HasExtraStyle}{\param{int }{exFlag}} + +Returns \texttt{true} if the window has the given \arg{exFlag} bit set in its +extra styles. + +\wxheading{See also} + +\helpref{SetExtraStyle}{wxwindowsetextrastyle} + + \membersection{wxWindow::HasFlag}\label{wxwindowhasflag} \constfunc{bool}{HasFlag}{\param{int }{flag}} @@ -1338,6 +1467,18 @@ Returns {\tt true} if this window has the current mouse capture. Returns \texttt{true} if the window has the given \arg{flag} bit set. +\membersection{wxWindow::HasMultiplePages}\label{wxwindowhasmultiplepages} + +\constfunc{virtual bool}{HasMultiplePages}{\void} + +This method should be overridden to return \texttt{true} if this window has +multiple pages. All standard class with multiple pages such as +\helpref{wxNotebook}{wxnotebook}, \helpref{wxListbook}{wxlistbook} and +\helpref{wxTreebook}{wxtreebook} already override it to return \texttt{true} +and user-defined classes with similar behaviour should do it as well to allow +the library to handle such windows appropriately. + + \membersection{wxWindow::HasScrollbar}\label{wxwindowhasscrollbar} \constfunc{virtual bool}{HasScrollbar}{\param{int }{orient}} @@ -1412,11 +1553,30 @@ to the dialog via validators. Resets the cached best size value so it will be recalculated the next time it is needed. +\membersection{wxWindow::IsDoubleBuffered}\label{wxwindowisdoublebuffered} + +\constfunc{virtual bool}{IsDoubleBuffered}{\void} + +Returns \true if the window contents is double-buffered by the system, i.e. if +any drawing done on the window is really done on a temporary backing surface +and transferred to the screen all at once later. + +\wxheading{See also} + +\helpref{wxBufferedDC}{wxbuffereddc} + + \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled} \constfunc{virtual bool}{IsEnabled}{\void} -Returns {\tt true} if the window is enabled for input, {\tt false} otherwise. +Returns \true if the window is enabled, i.e. if it accepts user input, \false +otherwise. + +Notice that this method can return \false even if this window itself hadn't +been explicitly disabled when one of its parent windows is disabled. To get the +intrinsic status of this window, use +\helpref{IsThisEnabled}{wxwindowisthisenabled} \wxheading{See also} @@ -1446,6 +1606,18 @@ implements the following methods:\par \end{twocollist}}} +\membersection{wxWindow::IsFrozen}\label{wxwindowisfrozen} + +\constfunc{virtual bool}{IsFrozen}{\void} + +Returns \true if the window is currently frozen by a call to +\helpref{Freeze()}{wxwindowfreeze}. + +\wxheading{See also} + +\helpref{Thaw()}{wxwindowthaw} + + \membersection{wxWindow::IsRetained}\label{wxwindowisretained} \constfunc{virtual bool}{IsRetained}{\void} @@ -1463,6 +1635,32 @@ Retained windows are only available on X platforms. Returns {\tt true} if the window is shown, {\tt false} if it has been hidden. +\wxheading{See also} + +\helpref{wxWindow::IsShownOnScreen}{wxwindowisshownonscreen} + + +\membersection{wxWindow::IsShownOnScreen}\label{wxwindowisshownonscreen} + +\constfunc{virtual bool}{IsShownOnScreen}{\void} + +Returns {\tt true} if the window is physically visible on the screen, i.e. it +is shown and all its parents up to the toplevel window are shown as well. + +\wxheading{See also} + +\helpref{wxWindow::IsShown}{wxwindowisshown} + + +\membersection{wxWindow::IsThisEnabled}\label{wxwindowisthisenabled} + +\constfunc{bool}{IsThisEnabled}{\void} + +Returns \true if this window is intrinsically enabled, \false otherwise, i.e. +if \helpref{Enable(false)}{wxwindowenable} had been called. This method is +mostly used for wxWidgets itself, user code should normally use +\helpref{IsEnabled}{wxwindowisenabled} instead. + \membersection{wxWindow::IsTopLevel}\label{wxwindowistoplevel} @@ -1498,7 +1696,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} @@ -1588,13 +1786,19 @@ it. \func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}} -Does keyboard navigation from this window to another, by sending -a wxNavigationKeyEvent. +Performs a keyboard navigation action starting from this window. This method is +equivalent to calling \helpref{NavigateIn()}{wxwindownavigatein} method on the +parent window. \wxheading{Parameters} \docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.} +\wxheading{Return value} + +Returns \true if the focus was moved to another window or \false if nothing +changed. + \wxheading{Remarks} You may wish to call this from a text control custom keypress handler to do the default @@ -1602,6 +1806,32 @@ navigation behaviour for the tab key, since the standard default behaviour for a multiline text control with the wxTE\_PROCESS\_TAB style is to insert a tab and not navigate to the next control. + +\membersection{wxWindow::NavigateIn}\label{wxwindownavigatein} + +\func{bool}{NavigateIn}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}} + +Performs a keyboard navigation action inside this window. + +See \helpref{Navigate}{wxwindownavigate} for more information. + + +\membersection{wxWindow::NextControlId}\label{wxwindownextcontrolid} + +\func{static int}{NextControlId}{\param{int }{winid}} + +If two controls are created consecutively using \texttt{wxID\_ANY} id, this +function allows to retrieve the effective id of the latter control from the id +of the former. This is useful for example to find the control following its +\helpref{wxStaticText}{wxstatictext} label if only the id of or pointer to the +label is available to the caller but it is known that the two controls were +created together. + +\wxheading{See also} + +\helpref{PrevControlId}{wxwindowprevcontrolid} + + %% VZ: wxWindow::OnXXX() functions should not be documented but I'm leaving %% the old docs here in case we want to move any still needed bits to %% the right location (i.e. probably the corresponding events docs) @@ -2161,6 +2391,14 @@ implements the following methods:\par } +\membersection{wxWindow::PrevControlId}\label{wxwindowprevcontrolid} + +\func{static int}{PrevControlId}{\param{int }{winid}} + +This is similar to \helpref{NextControlId}{wxwindownextcontrolid} but returns +the id of the control created just before the one with the given \arg{winid}. + + \membersection{wxWindow::PushEventHandler}\label{wxwindowpusheventhandler} \func{void}{PushEventHandler}{\param{wxEvtHandler* }{handler}} @@ -2197,9 +2435,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} @@ -2287,6 +2525,7 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt \helpref{wxWindow::CaptureMouse}{wxwindowcapturemouse}, \helpref{wxWindow::HasCapture}{wxwindowhascapture}, \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse}, +\helpref{wxMouseCaptureLostEvent}{wxmousecapturelostevent} \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} @@ -2314,7 +2553,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} @@ -2335,7 +2574,7 @@ handler is supposed to be there). 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. Available on Windows and GTK. +and then re-inserted into another. \wxheading{Parameters} @@ -2404,9 +2643,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} @@ -2457,16 +2694,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} @@ -2532,9 +2774,9 @@ background, such as a tiled bitmap. Currently the style has no effect on other p \helpref{wxWindow::GetBackgroundStyle}{wxwindowgetbackgroundstyle} -\membersection{wxWindow::SetBestFittingSize}\label{wxwindowsetbestfittingsize} +\membersection{wxWindow::SetInitialSize}\label{wxwindowsetinitialsize} -\func{void}{SetBestFittingSize}{\param{const wxSize\& }{size = wxDefaultSize}} +\func{void}{SetInitialSize}{\param{const wxSize\& }{size = wxDefaultSize}} A {\it smart} SetSize that will fill in default size components with the window's {\it best} size values. Also sets the window's minsize to @@ -2543,12 +2785,15 @@ partial size is passed to this function then the sizers will use that size instead of the results of GetBestSize to determine the minimum needs of the window for layout. +Most controls will use this to set their initial size, and their min +size to the passed in value (if any.) + + \wxheading{See also} \helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp \helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp -\helpref{wxWindow::GetBestFittingSize}{wxwindowgetbestfittingsize},\rtfsp -\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints} +\helpref{wxWindow::GetEffectiveMinSize}{wxwindowgeteffectiveminsize} \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret} @@ -2712,14 +2957,12 @@ default for the reasons explained in the window from being used as an implicit parent for the dialogs which were created without a parent. It is useful for the windows which can disappear at any moment as creating children of such windows results in fatal problems.} -\twocolitem{\windowstyle{wxFRAME\_EX\_CONTEXTHELP}}{Under Windows, puts a query button on the -caption. When pressed, Windows will go into a context-sensitive help mode and wxWidgets will send -a wxEVT\_HELP event if the user clicked on an application window. +\twocolitem{\windowstyle{wxWS\_EX\_CONTEXTHELP}}{Under Windows, puts a query +button on the caption. When pressed, Windows will go into a context-sensitive +help mode and wxWidgets will send 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 \& \textasciitilde(wxMINIMIZE\_BOX | wxMAXIMIZE\_BOX)} for the -frames having this style (the dialogs don't have minimize nor maximize box by -default)} +these two styles are automatically turned of if this one is used.} \twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_IDLE}}{This window should always process idle events, even if the mode set by \helpref{wxIdleEvent::SetMode}{wxidleeventsetmode} is wxIDLE\_PROCESS\_SPECIFIED.} \twocolitem{\windowstyle{wxWS\_EX\_PROCESS\_UI\_UPDATES}}{This window should always process UI update events, @@ -2752,7 +2995,7 @@ 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}} +\func{bool}{SetFont}{\param{const wxFont\& }{font}} Sets the font for this window. This function should not be called for the parent window if you don't want its font to be inherited by its children, @@ -2760,11 +3003,22 @@ 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 {\tt wxNullFont} to reset to the default font.} +\wxheading{Return value} + +\true if the want was really changed, \false if it was already set to this +\arg{font} and so nothing was done. + \wxheading{See also} \helpref{wxWindow::GetFont}{wxwindowgetfont},\\ @@ -2978,7 +3232,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} @@ -3090,7 +3345,7 @@ and usually the scrollbar will be automatically hidden. \func{virtual void}{SetSize}{\param{const wxRect\&}{ rect}} -Sets the size and position of the window in pixels. +Sets the position and size of the window in pixels. \func{virtual void}{SetSize}{\param{int}{ width}, \param{int}{ height}} @@ -3121,7 +3376,7 @@ value should be used.} {\bf wxSIZE\_AUTO\_WIDTH}: a $wxDefaultCoord$ width value is taken to indicate a wxWidgets-supplied default width.\\ {\bf wxSIZE\_AUTO\_HEIGHT}: a $wxDefaultCoord$ height value is taken to indicate -a wxWidgets-supplied default width.\\ +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 @@ -3159,42 +3414,14 @@ implements the following methods:\par \membersection{wxWindow::SetSizeHints}\label{wxwindowsetsizehints} -\func{virtual void}{SetSizeHints}{\param{int}{ minW}, \param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}, - \param{int}{ incW=-1}, \param{int}{ incH=-1}} - -\func{void}{SetSizeHints}{\param{const wxSize\&}{ minSize}, -\param{const wxSize\&}{ maxSize=wxDefaultSize}, \param{const wxSize\&}{ incSize=wxDefaultSize}} - - -Allows specification of minimum and maximum window sizes, and window size increments. -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.} - -\docparam{incW}{Specifies the increment for sizing the width (Motif/Xt only).} - -\docparam{incH}{Specifies the increment for sizing the height (Motif/Xt only).} - -\docparam{minSize}{Minimum size.} - -\docparam{maxSize}{Maximum size.} - -\docparam{incSize}{Increment size (Motif/Xt only).} - -\wxheading{Remarks} +Use of this function for windows which are not toplevel windows +(such as wxDialog or wxFrame) is discouraged. Please use +\helpref{SetMinSize}{wxwindowsetminsize} and \helpref{SetMaxSize}{wxwindowsetmaxsize} +instead. -If this function is called, the user will not be able to size the window outside the -given bounds. +\wxheading{See also} -The resizing increments are only significant under Motif or Xt. +\helpref{wxTopLevelWindow::SetSizeHints}{wxtoplevelwindowsetsizehints}. \membersection{wxWindow::SetSizer}\label{wxwindowsetsizer} @@ -3215,7 +3442,7 @@ parameter if the {\it sizer}\/ is non-NULL and {\tt false} otherwise. \docparam{sizer}{The sizer to set. Pass NULL to disassociate and conditionally delete the window's sizer. See below.} -\docparam{deleteOld}{If true (the default), this will delete any prexisting sizer. +\docparam{deleteOld}{If true (the default), this will delete any pre-existing sizer. Pass false if you wish to handle deleting the old sizer yourself.} \wxheading{Remarks} @@ -3326,7 +3553,8 @@ Identical to \helpref{SetWindowStyleFlag}{wxwindowsetwindowstyleflag}. 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. +need to be be called after changing the others for the change to take place +immediately. See \helpref{Window styles}{windowstyles} for more information about flags. @@ -3401,6 +3629,32 @@ 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::ToggleWindowStyle}\label{wxwindowtogglewindowstyle} + +\func{bool}{ToggleWindowStyle}{\param{int }{flag}} + +Turns the given \arg{flag} on if it's currently turned off and vice versa. +This function cannot be used if the value of the flag is $0$ (which is often +the case for default flags). + +Also, please notice that not all styles can be changed after the control +creation. + +\wxheading{Return value} + +Returns \true if the style was turned on by this function, \false if it was +switched off. + +\wxheading{See also} + +\helpref{wxWindow::SetWindowStyleFlag}{wxwindowsetwindowstyleflag},\rtfsp +\helpref{wxWindow::HasFlag}{wxwindowhasflag} + \membersection{wxWindow::TransferDataFromWindow}\label{wxwindowtransferdatafromwindow} @@ -3466,9 +3720,10 @@ This function is currently only implemented under MSW. Calling this method immediately repaints the invalidated area of the window and all of its children recursively while this would usually only happen when the -flow of control returns to the event loop. Notice that this function doesn't -refresh the window and does nothing if the window hadn't been already -repainted. Use \helpref{Refresh}{wxwindowrefresh} first if you want to +flow of control returns to the event loop. +Notice that this function doesn't invalidate any area of the window so +nothing happens if nothing has been invalidated (i.e. marked as requiring +a redraw). Use \helpref{Refresh}{wxwindowrefresh} first if you want to immediately redraw the window unconditionally. @@ -3555,3 +3810,4 @@ 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.} +