X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4ff4d0452517648e45268203917e611d107e6c7d..0149e2778396dfac568e1d381b87b44282e12df5:/docs/latex/wx/window.tex diff --git a/docs/latex/wx/window.tex b/docs/latex/wx/window.tex index 2ea573f0a9..1dae19c773 100644 --- a/docs/latex/wx/window.tex +++ b/docs/latex/wx/window.tex @@ -115,7 +115,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}}} @@ -721,11 +722,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} @@ -758,17 +756,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} @@ -1092,14 +1091,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} @@ -1372,6 +1373,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} @@ -2660,9 +2669,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 @@ -2671,12 +2680,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} @@ -3292,42 +3304,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} @@ -3459,7 +3443,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. @@ -3539,6 +3524,28 @@ exactly the same number of times as \helpref{Freeze}{wxwindowfreeze}. \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} \func{virtual bool}{TransferDataFromWindow}{\void}