Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Clarify docs about wxSizer::SetSizeHints().

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@42652 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Robert Roebling
2006-10-29 20:12:13 +00:00
parent 916af76f40
commit fd52f25525
1 changed files with 10 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/latex/wx/sizer.tex
View File

@@ -90,7 +90,7 @@ here:
\docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the \docparam{window}{The window to be added to the sizer. Its initial size (either set explicitly by the
user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many user or calculated internally when using wxDefaultSize) is interpreted as the minimal and in many
cases also the initial size. This is particularly useful in connection with \helpref{SetSizeHints}{wxsizersetsizehints}.} cases also the initial size.}
\docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a \docparam{sizer}{The (child-)sizer to be added to the sizer. This allows placing a child sizer in a
sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several sizer and thus to create hierarchies of sizers (typically a vertical box as the top sizer and several
@@ -492,11 +492,16 @@ after initial creation.
\func{void}{SetSizeHints}{\param{wxWindow* }{window}} \func{void}{SetSizeHints}{\param{wxWindow* }{window}}
Tell the sizer to set (and \helpref{Fit}{wxsizerfit}) the minimal size of the \arg{window} to This method first calls \helpref{wxSizer::Fit}{wxsizerfit} and then
match the sizer's minimal size. This is commonly done in the constructor of the window itself, \helpref{SetSizeHints}{wxtoplevelwindowsetsizehints} on the {\it window}
see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable passed to it. This only makes sense when {\it window} is actually a
(as are many dialogs under Unix and frames on probably all platforms). \helpref{wxTopLevelWindow}{wxtoplevelwindow} such as a wxFrame or a
wxDialog, since SetSizeHints only has any effect in these classes.
It does nothing in normal windows or controls.
This method is commonly invoked in the constructor of a toplevel window itself
(see the sample in the description of \helpref{wxBoxSizer}{wxboxsizer}) if the
toplevel window is resizable.
\membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints} \membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints}