X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/1b69c815746d9ca7cbfcbe96423e2021ed3fbdb2..0fec2f73ecb616a2189f95c340e9fa7e5cc2350f:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index d7d86c9631..437cd23a79 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -1,6 +1,6 @@ \section{\class{wxWindow}}\label{wxwindow} -wxWindow is the base class for all windows and represents any visible objecto n +wxWindow is the base class for all windows and represents any visible object on screen. All controls, top level windows and so on are windows. Sizers and device contexts are not, however, as they don't appear on screen themselves. @@ -9,7 +9,7 @@ the destructor before the window itself is deleted which means that you don't have to worry about deleting them manually. Please see the \helpref{window deletion overview}{windowdeletionoverview} for more information. -Also note that in this, and many others, wxWindows classes some +Also note that in this, and many others, wxWidgets classes some \texttt{GetXXX()} methods may be overloaded (as, for example, \helpref{GetSize}{wxwindowgetsize} or \helpref{GetClientSize}{wxwindowgetclientsize}). In this case, the overloads @@ -17,7 +17,7 @@ are non-virtual because having multiple virtual functions with the same name results in a virtual function name hiding at the derived class level (in English, this means that the derived class has to override all overloaded variants if it overrides any of them). To allow overriding them in the derived -class, wxWindows uses a unique protected virtual \texttt{DoGetXXX()} method +class, wxWidgets uses a unique protected virtual \texttt{DoGetXXX()} method and all \texttt{GetXXX()} ones are forwarded to it, so overriding the former changes the behaviour of the latter. @@ -128,11 +128,11 @@ Constructs a window, which can be a child of a frame, dialog or any other non-co \docparam{id}{Window identifier. If -1, will automatically create an identifier.} -\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWindows +\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which 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 wxWindows +\docparam{size}{Window size. wxDefaultSize is (-1, -1) which 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. } @@ -142,13 +142,13 @@ correctly sized. } \docparam{name}{Window name.} -\membersection{wxWindow::\destruct{wxWindow}} +\membersection{wxWindow::\destruct{wxWindow}}\label{wxwindowdtor} \func{}{\destruct{wxWindow}}{\void} Destructor. Deletes all subwindows, then deletes itself. Instead of using the {\bf delete} operator explicitly, you should normally -use \helpref{wxWindow::Destroy}{wxwindowdestroy} so that wxWindows +use \helpref{wxWindow::Destroy}{wxwindowdestroy} so that wxWidgets can delete a window only when it is safe to do so, in idle time. \wxheading{See also} @@ -158,14 +158,14 @@ can delete a window only when it is safe to do so, in idle time. \helpref{wxCloseEvent}{wxcloseevent} -\membersection{wxWindow::AddChild} +\membersection{wxWindow::AddChild}\label{wxwindowaddchild} \func{virtual void}{AddChild}{\param{wxWindow* }{child}} Adds a child window. This is called automatically by window creation functions so should not be required by the application programmer. -Notice that this function is mostly internal to wxWindows and shouldn't be +Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code. \wxheading{Parameters} @@ -173,6 +173,13 @@ called by the user code. \docparam{child}{Child window to add.} +\membersection{wxWindow::CacheBestSize}\label{wxwindowcachebestsize} + +\constfunc{void}{CacheBestSize}{\param{const wxSize\& }{size}} + +Sets the cached best size value. + + \membersection{wxWindow::CaptureMouse}\label{wxwindowcapturemouse} \func{virtual void}{CaptureMouse}{\void} @@ -180,7 +187,7 @@ called by the user code. Directs all mouse input to this window. Call \helpref{wxWindow::ReleaseMouse}{wxwindowreleasemouse} to release the capture. -Note that wxWindows maintains the stack of windows having captured the mouse +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 @@ -287,7 +294,7 @@ Clears the window by filling it with the current background colour. Does not cause an erase background event to be generated. -\membersection{wxWindow::ClientToScreen} +\membersection{wxWindow::ClientToScreen}\label{wxwindowclienttoscreen} \constfunc{virtual void}{ClientToScreen}{\param{int* }{x}, \param{int* }{y}} @@ -426,7 +433,7 @@ Dialog units are used for maintaining a dialog's proportions even if the font ch \helpref{wxWindow::ConvertDialogToPixels}{wxwindowconvertdialogtopixels} -\pythonnote{In place of a single overloaded method name, wxPythonimplements the following methods:\par +\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} @@ -451,7 +458,7 @@ windows. to the list of windows pending real deletion. -\membersection{wxWindow::DestroyChildren} +\membersection{wxWindow::DestroyChildren}\label{wxwindowdestroychildren} \func{virtual void}{DestroyChildren}{\void} @@ -470,6 +477,15 @@ 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::DoGetBestSize}\label{wxwindowdogetbestsize} + +\constfunc{virtual wxSize}{DoGetBestSize}{\void} + +Gets the size which best suits the window: for a control, it would be +the minimal size which doesn't truncate the control, for a panel - the +same size as it would have after a call to \helpref{Fit()}{wxwindowfit}. + + \membersection{wxWindow::DoUpdateWindowUI}\label{wxwindowdoupdatewindowui} \func{virtual void}{DoUpdateWindowUI}{\param{wxUpdateUIEvent\&}{ event}} @@ -477,7 +493,7 @@ already disabled before the call to this function. Does the window-specific updating after processing the update event. This function is called by \helpref{wxWindow::UpdateWindowUI}{wxwindowupdatewindowui} in order to check return values in the \helpref{wxUpdateUIEvent}{wxupdateuievent} and -act appropriately. For example, to allow frame and dialog title updating, wxWindows +act appropriately. For example, to allow frame and dialog title updating, wxWidgets implements this function as follows: \begin{verbatim} @@ -655,9 +671,9 @@ be called to reenable window redrawing. Calls to these two functions may be nested. This method is useful for visual appearance optimization (for example, it -is a good idea to use it before inserting large amount of text into a -wxTextCtrl under wxGTK) but is not implemented on all platforms nor for all -controls so it is mostly just a hint to wxWindows and not a mandatory +is a good idea to use it before doing many large text insertions in a row into +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. @@ -670,7 +686,7 @@ Gets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa \membersection{wxWindow::GetAccessible}\label{wxwindowgetaccessible} -\func{wxAccessibile*}{GetAccessible}{\void} +\func{wxAccessible*}{GetAccessible}{\void} Returns the accessible object for this window, if any. @@ -700,6 +716,36 @@ Returns the background colour of the window. \helpref{wxWindow::SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour} +\membersection{wxWindow::GetBackgroundStyle}\label{wxwindowgetbackgroundstyle} + +\constfunc{virtual wxBackgroundStyle}{GetBackgroundStyle}{\void} + +Returns the background style of the window. The background style indicates +whether background colour should be determined by the system (wxBG\_STYLE\_SYSTEM), +be set to a specific colour (wxBG\_STYLE\_COLOUR), or should be left to the +application to implement (wxBG\_STYLE\_CUSTOM). + +On GTK+, use of wxBG\_STYLE\_CUSTOM allows the flicker-free drawing of a custom +background, such as a tiled bitmap. Currently the style has no effect on other platforms. + +\wxheading{See also} + +\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp +\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp +\helpref{wxWindow::SetBackgroundStyle}{wxwindowsetbackgroundstyle} + +\membersection{wxWindow::GetBestFittingSize}\label{wxwindowgetbestfittingsize} + +\constfunc{wxSize}{GetBestFittingSize}{\void} + +Merges the window's best size into the min size and returns the result. + +\wxheading{See also} + +\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp +\helpref{wxWindow::SetBestFittingSize}{wxwindowsetbestfittingsize},\rtfsp +\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints} + \membersection{wxWindow::GetBestSize}\label{wxwindowgetbestsize} @@ -734,28 +780,28 @@ Returns the currently captured window. \helpref{wxMouseCaptureChangedEvent}{wxmousecapturechangedevent} -\membersection{wxWindow::GetCharHeight} +\membersection{wxWindow::GetCharHeight}\label{wxwindowgetcharheight} \constfunc{virtual int}{GetCharHeight}{\void} Returns the character height for this window. -\membersection{wxWindow::GetCharWidth} +\membersection{wxWindow::GetCharWidth}\label{wxwindowgetcharwidth} \constfunc{virtual int}{GetCharWidth}{\void} Returns the average character width for this window. -\membersection{wxWindow::GetChildren} +\membersection{wxWindow::GetChildren}\label{wxwindowgetchildren} \func{wxList\&}{GetChildren}{\void} Returns a reference to the list of the window's children. -\membersection{wxControl::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes} +\membersection{wxWindow::GetClassDefaultAttributes}\label{wxwindowgetclassdefaultattributes} \func{static wxVisualAttributes}{GetClassDefaultAttributes}{\param{wxWindowVariant}{ variant = \texttt{wxWINDOW\_VARIANT\_NORMAL}}} @@ -771,9 +817,9 @@ returned font. See \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant for more about this. This static method is ``overridden'' in many derived classes and so calling, -for example, \helpref{wxButton}::GetClassDefaultAttributes() will typically +for example, \helpref{wxButton}{wxbutton}::GetClassDefaultAttributes() will typically return the values appropriate for a button which will be normally different -from those returned by, say, \helpref{wxListCtrl}::GetClassDefaultAttributes(). +from those returned by, say, \helpref{wxListCtrl}{wxlistctrl}::GetClassDefaultAttributes(). The \texttt{wxVisualAttributes} structure has at least the fields \texttt{font}, \texttt{colFg} and \texttt{colBg}. All of them may be invalid @@ -781,6 +827,10 @@ if it was not possible to determine the default control appearance or, especially for the background colour, if the field doesn't make sense as is the case for \texttt{colBg} for the controls with themed background. +\wxheading{See also} + +\helpref{InheritAttributes}{wxwindowinheritattributes} + \membersection{wxWindow::GetClientSize}\label{wxwindowgetclientsize} @@ -842,7 +892,7 @@ Return the cursor associated with this window. \helpref{wxWindow::SetCursor}{wxwindowsetcursor} -\membersection{wxControl::GetDefaultAttributes}\label{wxwindowgetdefaultattributes} +\membersection{wxWindow::GetDefaultAttributes}\label{wxwindowgetdefaultattributes} \constfunc{virtual wxVisualAttributes}{GetDefaultAttributes}{\void} @@ -898,9 +948,9 @@ Returns the extra style bits for the window. \membersection{wxWindow::GetFont}\label{wxwindowgetfont} -\constfunc{wxFont\&}{GetFont}{\void} +\constfunc{wxFont}{GetFont}{\void} -Returns a reference to the font for this window. +Returns the font for this window. \wxheading{See also} @@ -926,7 +976,7 @@ be used at all. \helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour} -\membersection{wxWindow::GetGrandParent} +\membersection{wxWindow::GetGrandParent}\label{wxwindowgetgrandparent} \constfunc{wxWindow*}{GetGrandParent}{\void} @@ -976,7 +1026,7 @@ Each window has an integer identifier. If the application has not provided one \helpref{Window identifiers}{windowids} -\membersection{wxWindow::GetLabel} +\membersection{wxWindow::GetLabel}\label{wxwindowgetlabel} \constfunc{virtual wxString }{GetLabel}{\void} @@ -991,6 +1041,19 @@ the button text. This function can be useful for meta-programs (such as testing tools or special-needs access programs) which need to identify windows by name. +\membersection{wxWindow::GetMaxSize}\label{wxwindowgetmaxsize} + +\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. + +\membersection{wxWindow::GetMinSize}\label{wxwindowgetminsize} + +\constfunc{wxSize}{GetMinSize}{\void} + +Returns the minimum size of the window, an indication to the sizer layout mechanism +that this is the minimum required size. \membersection{wxWindow::GetName}\label{wxwindowgetname} @@ -1008,7 +1071,7 @@ name in the window constructor or via \helpref{wxWindow::SetName}{wxwindowsetnam \helpref{wxWindow::SetName}{wxwindowsetname} -\membersection{wxWindow::GetParent} +\membersection{wxWindow::GetParent}\label{wxwindowgetparent} \constfunc{virtual wxWindow*}{GetParent}{\void} @@ -1240,7 +1303,7 @@ method. {\bf GetWindowStyle()} is another name for the same function. \membersection{wxWindow::GetWindowVariant}\label{wxwindowgetwindowvariant} -\constructor{wxWindowVariant}{GetWindowVariant}{\void} +\constfunc{wxWindowVariant}{GetWindowVariant}{\void} Returns the value previous passed to \helpref{wxWindow::SetWindowVariant}{wxwindowsetwindowvariant}. @@ -1266,6 +1329,35 @@ Returns true if this window has the current mouse capture. Equivalent to calling \helpref{Show}{wxwindowshow}({\tt false}). +\membersection{wxWindow::InheritAttributes}\label{wxwindowinheritattributes} + +\func{void}{InheritAttributes}{\void} + +This function is (or should be, in case of custom controls) called during +window creation to intelligently set up the window visual attributes, that is +the font and the foreground and background colours. + +By ``intelligently'' the following is meant: by default, all windows use their +own \helpref{default}{wxwindowgetclassdefaultattributes} attributes. However +if some of the parents attributes are explicitly (that is, using +\helpref{SetFont}{wxwindowsetfont} and not +\helpref{SetOwnFont}{wxwindowsetownfont}) changed \emph{and} if the +corresponding attribute hadn't been explicitly set for this window itself, +then this window takes the same value as used by the parent. In addition, if +the window overrides \helpref{ShouldInheritColours}{wxwindowshouldinheritcolours} +to return \false, the colours will not be changed no matter what and only the +font might. + +This rather complicated logic is necessary in order to accommodate the +different usage scenarios. The most common one is when all default attributes +are used and in this case, nothing should be inherited as in modern GUIs +different controls use different fonts (and colours) than their siblings so +they can't inherit the same value from the parent. However it was also deemed +desirable to allow to simply change the attributes of all children at once by +just changing the font or colour of their common parent, hence in this case we +do inherit the parents attributes. + + \membersection{wxWindow::InitDialog}\label{wxwindowinitdialog} \func{void}{InitDialog}{\void} @@ -1274,6 +1366,13 @@ Sends an {\tt wxEVT\_INIT\_DIALOG} event, whose handler usually transfers data to the dialog via validators. +\membersection{wxWindow::InvalidateBestSize}\label{wxwindowinvalidatebestsize} + +\func{void}{InvalidateBestSize}{\void} + +Resets the cached best size value so it will be recalculated the next time it is needed. + + \membersection{wxWindow::IsEnabled}\label{wxwindowisenabled} \constfunc{virtual bool}{IsEnabled}{\void} @@ -1415,6 +1514,52 @@ implements the following methods:\par \end{twocollist}} } + +\membersection{wxWindow::MoveAfterInTabOrder}\label{wxwindowmoveafterintaborder} + +\func{void}{MoveAfterInTabOrder}{\param{wxWindow *}{win}} + +Moves this window in the tab navigation order after the specified \arg{win}. +This means that when the user presses \texttt{TAB} key on that other window, +the focus switches to this window. + +Default tab order is the same as creation order, this function and +\helpref{MoveBeforeInTabOrder()}{wxwindowmovebeforeintaborder} allow to change +it after creating all the windows. + +\wxheading{Parameters} + +\docparam{win}{A sibling of this window which should precede it in tab order, +must not be NULL} + + +\membersection{wxWindow::MoveBeforeInTabOrder}\label{wxwindowmovebeforeintaborder} + +\func{void}{MoveBeforeInTabOrder}{\param{wxWindow *}{win}} + +Same as \helpref{MoveAfterInTabOrder}{wxwindowmoveafterintaborder} except that +it inserts this window just before \arg{win} instead of putting it right after +it. + + +\membersection{wxWindow::Navigate}\label{wxwindownavigate} + +\func{bool}{Navigate}{\param{int}{ flags = wxNavigationKeyEvent::IsForward}} + +Does keyboard navigation from this window to another, by sending +a wxNavigationKeyEvent. + +\wxheading{Parameters} + +\docparam{flags}{A combination of wxNavigationKeyEvent::IsForward and wxNavigationKeyEvent::WinChange.} + +\wxheading{Remarks} + +You may wish to call this from a text control custom keypress handler to do the default +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. + %% 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) @@ -1500,7 +1645,7 @@ implements the following methods:\par %% %% This function is only relevant to top-level windows (frames and dialogs), and under %% Windows only. Under GTK the normal EVT\_CHAR\_ event has the functionality, i.e. -%% you can intercepts it and if you don't call \helpref{wxEvent::Skip}{wxeventskip} +%% you can intercept it, and if you don't call \helpref{wxEvent::Skip}{wxeventskip} %% the window won't get the event. %% %% \wxheading{See also} @@ -1682,7 +1827,7 @@ implements the following methods:\par %% The default implementation for \helpref{wxFrame::OnMenuHighlight}{wxframeonmenuhighlight} displays help %% text in the first field of the status bar. %% -%% This function was known as {\bf OnMenuSelect} in earlier versions of wxWindows, but this was confusing +%% This function was known as {\bf OnMenuSelect} in earlier versions of wxWidgets, but this was confusing %% since a selection is normally a left-click action. %% %% \wxheading{See also} @@ -1954,14 +2099,15 @@ default value is {\tt 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 = wxDefaultPosition}} \func{bool}{PopupMenu}{\param{wxMenu* }{menu}, \param{int }{x}, \param{int }{y}} Pops up the given menu at the specified coordinates, relative to this window, and returns control when the user has dismissed the menu. If a menu item is selected, the corresponding menu event is generated and will be -processed as usually. +processed as usually. If the coordinates are not specified, current mouse +cursor position is used. \wxheading{Parameters} @@ -1979,9 +2125,13 @@ processed as usually. \wxheading{Remarks} -Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui} is called -to ensure that the menu items are in the correct state. The menu does not get deleted -by the window. +Just before the menu is popped up, \helpref{wxMenu::UpdateUI}{wxmenuupdateui} +is called to ensure that the menu items are in the correct state. The menu does +not get deleted by the window. + +It is recommended to not explicitly specify coordinates when calling PopupMenu +in response to mouse click, because some of the ports (namely, wxGTK) can do +a better job of positioning the menu in that case. \pythonnote{In place of a single overloaded method name, wxPython implements the following methods:\par @@ -2118,7 +2268,7 @@ Releases mouse input captured with \helpref{wxWindow::CaptureMouse}{wxwindowcapt Removes a child window. This is called automatically by window deletion functions so should not be required by the application programmer. -Notice that this function is mostly internal to wxWindows and shouldn't be +Notice that this function is mostly internal to wxWidgets and shouldn't be called by the user code. \wxheading{Parameters} @@ -2265,7 +2415,7 @@ Sets the accelerator table for this window. See \helpref{wxAcceleratorTable}{wxa \membersection{wxWindow::SetAccessible}\label{wxwindowsetaccessible} -\func{void}{SetAccessible}{\param{wxAccessibile*}{ accessible}} +\func{void}{SetAccessible}{\param{wxAccessible*}{ accessible}} Sets the accessible for this window. Any existing accessible for this window will be deleted first, if not identical to {\it accessible}. @@ -2296,13 +2446,18 @@ from within wxWindow::OnSize functions.} \membersection{wxWindow::SetBackgroundColour}\label{wxwindowsetbackgroundcolour} -\func{virtual void}{SetBackgroundColour}{\param{const wxColour\& }{colour}} +\func{virtual bool}{SetBackgroundColour}{\param{const wxColour\& }{colour}} Sets the background colour of the window. +Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for +explanation of the difference between this method and +\helpref{SetOwnBackgroundColour}{wxwindowsetownbackgroundcolour}. + \wxheading{Parameters} -\docparam{colour}{The colour to be used as the background colour.} +\docparam{colour}{The colour to be used as the background colour, pass + {\tt wxNullColour} to reset to the default colour.} \wxheading{Remarks} @@ -2314,9 +2469,11 @@ Note that setting the background colour does not cause an immediate refresh, so may wish to call \helpref{wxWindow::ClearBackground}{wxwindowclearbackground} or \helpref{wxWindow::Refresh}{wxwindowrefresh} after calling this function. -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. +Using this function will disable attempts to use themes for this +window, if the system supports them. Use with care since usually the +themes represent the appearance chosen by the user to be used for all +applications on the system. + \wxheading{See also} @@ -2327,6 +2484,43 @@ look as the user wishes with run-time loadable modules. \helpref{wxWindow::Refresh}{wxwindowrefresh},\rtfsp \helpref{wxEraseEvent}{wxeraseevent} +\membersection{wxWindow::SetBackgroundStyle}\label{wxwindowsetbackgroundstyle} + +\func{virtual void}{SetBackgroundStyle}{\param{wxBackgroundStyle}{ style}} + +Sets the background style of the window. The background style indicates +whether background colour should be determined by the system (wxBG\_STYLE\_SYSTEM), +be set to a specific colour (wxBG\_STYLE\_COLOUR), or should be left to the +application to implement (wxBG\_STYLE\_CUSTOM). + +On GTK+, use of wxBG\_STYLE\_CUSTOM allows the flicker-free drawing of a custom +background, such as a tiled bitmap. Currently the style has no effect on other platforms. + +\wxheading{See also} + +\helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp +\helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp +\helpref{wxWindow::GetBackgroundStyle}{wxwindowgetbackgroundstyle} + + +\membersection{wxWindow::SetBestFittingSize}\label{wxwindowsetbestfittingsize} + +\func{void}{SetBestFittingSize}{\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 +the value passed in for use with sizers. This means that if a full or +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. + +\wxheading{See also} + +\helpref{wxWindow::SetSize}{wxwindowsetsize},\rtfsp +\helpref{wxWindow::GetBestSize}{wxwindowgetbestsize},\rtfsp +\helpref{wxWindow::GetBestFittingSize}{wxwindowgetbestfittingsize},\rtfsp +\helpref{wxWindow::SetSizeHints}{wxwindowsetsizehints} + \membersection{wxWindow::SetCaret}\label{wxwindowsetcaret} @@ -2414,6 +2608,67 @@ the constraints automatically in OnSize; otherwise, you must override OnSize and explicitly. When setting both a wxLayoutConstraints and a \helpref{wxSizer}{wxsizer}, only the sizer will have effect. +\membersection{wxWindow::SetInitialBestSize}\label{wxwindowsetinitialbestsize} + +\func{virtual void}{SetInitialBestSize}{\param{const wxSize\& }{size}} + +Sets the initial window size if none is given (i.e. at least one of the +components of the size passed to ctor/Create() is wxDefaultCoord). + +\membersection{wxWindow::SetMaxSize}\label{wxwindowsetmaxsize} + +\func{void}{SetMaxSize}{\param{const wxSize\& }{size}} + +Sets the maximum size of the window, to indicate to the sizer layout mechanism +that this is the maximum possible size. + +\membersection{wxWindow::SetMinSize}\label{wxwindowsetminsize} + +\func{void}{SetMinSize}{\param{const wxSize\& }{size}} + +Sets the minimum size of the window, to indicate to the sizer layout mechanism +that this is the minimum required size. You may need to call this +if you change the window size after construction and before adding +to its parent sizer. + +\membersection{wxWindow::SetOwnBackgroundColour}\label{wxwindowsetownbackgroundcolour} + +\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}} + +Sets the background colour of the window but prevents it from being inherited +by the children of this window. + +\wxheading{See also} + +\helpref{SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp +\helpref{InheritAttributes}{wxwindowinheritattributes} + + +\membersection{wxWindow::SetOwnFont}\label{wxwindowsetownfont} + +\func{void}{SetOwnBackgroundColour}{\param{const wxColour\& }{colour}} + +Sets the font of the window but prevents it from being inherited by the +children of this window. + +\wxheading{See also} + +\helpref{SetFont}{wxwindowsetfont},\rtfsp +\helpref{InheritAttributes}{wxwindowinheritattributes} + + +\membersection{wxWindow::SetOwnForegroundColour}\label{wxwindowsetownforegroundcolour} + +\func{void}{SetOwnForegroundColour}{\param{const wxColour\& }{colour}} + +Sets the foreground colour of the window but prevents it from being inherited +by the children of this window. + +\wxheading{See also} + +\helpref{SetForegroundColour}{wxwindowsetforegroundcolour},\rtfsp +\helpref{InheritAttributes}{wxwindowinheritattributes} + \membersection{wxWindow::SetDropTarget}\label{wxwindowsetdroptarget} @@ -2484,7 +2739,7 @@ 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 wxWindows will send +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 @@ -2513,7 +2768,7 @@ This sets the window to receive keyboard input. \func{virtual void}{SetFocusFromKbd}{\void} -This function is called by wxWindows keyboard navigation code when the user +This function is called by wxWidgets 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. @@ -2523,15 +2778,21 @@ can be overridden to do something in addition to this in the derived classes. \func{void}{SetFont}{\param{const wxFont\& }{font}} -Sets the font for this window. +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, +use \helpref{SetOwnFont}{wxwindowsetownfont} instead in this case and +see \helpref{InheritAttributes}{wxwindowinheritattributes} for more +explanations. \wxheading{Parameters} -\docparam{font}{Font to associate with this window.} +\docparam{font}{Font to associate with this window, pass +{\tt wxNullFont} to reset to the default font.} \wxheading{See also} -\helpref{wxWindow::GetFont}{wxwindowgetfont} +\helpref{wxWindow::GetFont}{wxwindowgetfont},\\ +\helpref{InheritAttributes}{wxwindowinheritattributes} \membersection{wxWindow::SetForegroundColour}\label{wxwindowsetforegroundcolour} @@ -2540,9 +2801,14 @@ Sets the font for this window. Sets the foreground colour of the window. +Please see \helpref{InheritAttributes}{wxwindowinheritattributes} for +explanation of the difference between this method and +\helpref{SetOwnForegroundColour}{wxwindowsetownforegroundcolour}. + \wxheading{Parameters} -\docparam{colour}{The colour to be used as the foreground colour.} +\docparam{colour}{The colour to be used as the foreground colour, pass + {\tt wxNullColour} to reset to the default colour.} \wxheading{Remarks} @@ -2550,15 +2816,17 @@ The interpretation of foreground colour is open to interpretation according to the window class; it may be the text colour or other colour, or it may not be used at all. -Note that when using this functions under GTK, you will disable the so called "themes", -i.e. the user chosen appearance of windows and controls, including the themes of -their parent windows. +Using this function will disable attempts to use themes for this +window, if the system supports them. Use with care since usually the +themes represent the appearance chosen by the user to be used for all +applications on the system. \wxheading{See also} \helpref{wxWindow::GetForegroundColour}{wxwindowgetforegroundcolour},\rtfsp \helpref{wxWindow::SetBackgroundColour}{wxwindowsetbackgroundcolour},\rtfsp -\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour} +\helpref{wxWindow::GetBackgroundColour}{wxwindowgetbackgroundcolour},\rtfsp +\helpref{wxWindow::ShouldInheritColours}{wxwindowshouldinheritcolours} \membersection{wxWindow::SetHelpText}\label{wxwindowsethelptext} @@ -2805,11 +3073,11 @@ 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 wxWindows-supplied default width.\\ +a wxWidgets-supplied default width.\\ {\bf wxSIZE\_AUTO\_HEIGHT}: a -1 height value is taken to indicate -a wxWindows-supplied default width.\\ +a wxWidgets-supplied default width.\\ {\bf wxSIZE\_AUTO}: -1 size values are taken to indicate -a wxWindows-supplied default size.\\ +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 @@ -2823,7 +3091,7 @@ 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 -by wxWindows, or that the current value of the dimension should be used. +by wxWidgets, or that the current value of the dimension should be used. \wxheading{See also} @@ -2844,6 +3112,10 @@ implements the following methods:\par \func{virtual void}{SetSizeHints}{\param{int}{ minW=-1}, \param{int}{ minH=-1}, \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. @@ -2861,6 +3133,12 @@ If a pair of values is not set (or set to -1), the default values will be used. \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} If this function is called, the user will not be able to size the window outside the @@ -2892,7 +3170,7 @@ 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 +SetSizer now enables and disables Layout automatically, but prior to wxWidgets 2.3.3 the following applied: You must call \helpref{wxWindow::SetAutoLayout}{wxwindowsetautolayout} to tell a window to use @@ -2972,6 +3250,10 @@ Sets the virtual size of the window in pixels. \func{virtual void}{SetVirtualSizeHints}{\param{int}{ minW},\param{int}{ minH}, \param{int}{ maxW=-1}, \param{int}{ maxH=-1}} +\func{void}{SetVirtualSizeHints}{\param{const wxSize\&}{ minSize=wxDefaultSize}, +\param{const wxSize\&}{ maxSize=wxDefaultSize}} + + 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. @@ -2986,6 +3268,10 @@ will be used. \docparam{maxH}{Specifies the maximum height allowable.} +\docparam{minSize}{Minimum size.} + +\docparam{maxSize}{Maximum size.} + \wxheading{Remarks} If this function is called, the user will not be able to size the virtual area @@ -3020,7 +3306,7 @@ See \helpref{Window styles}{windowstyles} for more information about flags. This function can be called under all platforms but only does anything under Mac OS X 10.3+ currently. Under this system, each of the standard control can -exist in several sizes which correpond to the elements of wxWindowVariant +exist in several sizes which correspond to the elements of wxWindowVariant enum: \begin{verbatim} enum wxWindowVariant @@ -3036,6 +3322,18 @@ By default the controls use the normal size, of course, but this function can be used to change this. +\membersection{wxWindow::ShouldInheritColours}\label{wxwindowshouldinheritcolours} + +\func{virtual bool}{ShouldInheritColours}{\void} + +Return \true from here to allow the colours of this window to be changed by +\helpref{InheritAttributes}{wxwindowinheritattributes}, returning \false +forbids inheriting them from the parent window. + +The base class version returns \false, but this method is overridden in +\helpref{wxControl}{wxcontrol} where it returns \true. + + \membersection{wxWindow::Show}\label{wxwindowshow} \func{virtual bool}{Show}{\param{bool}{ show = {\tt true}}} @@ -3151,7 +3449,7 @@ UI is up-to-date at this point (as far as your wxUpdateUIEvent handlers are concerned). This may be necessary if you have called \helpref{wxUpdateUIEvent::SetMode}{wxupdateuieventsetmode} or \helpref{wxUpdateUIEvent::SetUpdateInterval}{wxupdateuieventsetupdateinterval} to -limit the overhead that wxWindows incurs by sending update UI events in idle time. +limit the overhead that wxWidgets incurs by sending update UI events in idle time. {\it flags} should be a bitlist of one or more of the following values.