X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f6bcfd974ef26faf6f91a62cac09827e09463fd1..146ba0feacf1222ec8a45dfd69dae77b063bf2cf:/docs/latex/wx/sizer.tex diff --git a/docs/latex/wx/sizer.tex b/docs/latex/wx/sizer.tex index 7c83d6edc9..86cf483ab0 100644 --- a/docs/latex/wx/sizer.tex +++ b/docs/latex/wx/sizer.tex @@ -1,8 +1,11 @@ \section{\class{wxSizer}}\label{wxsizer} wxSizer is the abstract base class used for laying out subwindows in a window. You -cannot use wxSizer directly; instead, you will have to use \helpref{wxBoxSizer}{wxboxsizer}, -\helpref{wxStaticBoxSizer}{wxstaticboxsizer} or \helpref{wxNotebookSizer}{wxnotebooksizer}. +cannot use wxSizer directly; instead, you will have to use one of the sizer +classes derived from it. Currently there are \helpref{wxBoxSizer}{wxboxsizer}, +\helpref{wxStaticBoxSizer}{wxstaticboxsizer}, +\helpref{wxNotebookSizer}{wxnotebooksizer}, \helpref{wxGridSizer}{wxgridsizer} +and \helpref{wxFlexGridSizer}{wxflexgridsizer}. The layout algorithm used by sizers in wxWindows is closely related to layout in other GUI toolkits, such as Java's AWT, the GTK toolkit or the Qt toolkit. It is @@ -30,6 +33,10 @@ capabilities for the various virtual methods.} \helpref{wxObject}{wxobject} +\wxheading{See also} + +\helpref{Sizer overview}{sizeroverview} + \latexignore{\rtfignore{\wxheading{Members}}} \membersection{wxSizer::wxSizer}\label{wxsizerwxsizer} @@ -80,20 +87,28 @@ children of the same wxBoxSizer. For example, you might have a horizontal wxBoxS of which are supposed to change their size with the sizer. Then the two stretchable windows would get a value of 1 each to make them grow and shrink equally with the sizer's horizontal dimension.} -\docparam{flag}{This parameter can be used to set a number of flags which can be combined using -the binary OR operator |. Two main behaviours are defined using these flags. One is the border -around a window: the {\it border} parameter determines the border width whereas the flags given here -determine where the border may be (wxTOP, wxBOTTOM, wxLEFT, wxRIGHT or wxALL). The other flags -determine the child window's behaviour if the size of the sizer changes. However this is not - in contrast to -the {\it option} flag - in the main orientation, but in the respectively other orientation. So -if you created a wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the -sizer changes its horizontal size. A child may get resized to completely fill out the new size (using -either wxGROW or wxEXPAND), it may get proportionally resized (wxSHAPED), it may get centered (wxALIGN\_CENTER -or wxALIGN\_CENTRE) or it may get aligned to either side (wxALIGN\_LEFT and wxALIGN\_TOP are set to 0 -and thus represent the default, wxALIGN\_RIGHT and wxALIGN\_BOTTOM have their obvious meaning). -With proportional resize, a child may also be centered in the main orientation using -wxALIGN\_CENTER\_VERTICAL (same as wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL -(same as wxALIGN\_CENTRE\_HORIZONTAL) flags.} +\docparam{flag}{This parameter can be used to set a number of flags which can +be combined using the binary OR operator |. Two main behaviours are defined +using these flags. One is the border around a window: the {\it border} +parameter determines the border width whereas the flags given here determine +where the border may be (wxTOP, wxBOTTOM, wxLEFT, wxRIGHT or wxALL). The other +flags determine the child window's behaviour if the size of the sizer changes. +However this is not - in contrast to the {\it option} flag - in the main +orientation, but in the respectively other orientation. So if you created a +wxBoxSizer with the wxVERTICAL option, these flags will be relevant if the +sizer changes its horizontal size. A child may get resized to completely fill +out the new size (using either wxGROW or wxEXPAND), it may get proportionally +resized (wxSHAPED), it may get centered (wxALIGN\_CENTER or wxALIGN\_CENTRE) +or it may get aligned to either side (wxALIGN\_LEFT and wxALIGN\_TOP are set +to 0 and thus represent the default, wxALIGN\_RIGHT and wxALIGN\_BOTTOM have +their obvious meaning). With proportional resize, a child may also be centered +in the main orientation using wxALIGN\_CENTER\_VERTICAL (same as +wxALIGN\_CENTRE\_VERTICAL) and wxALIGN\_CENTER\_HORIZONTAL (same as +wxALIGN\_CENTRE\_HORIZONTAL) flags. Finally, you can also specify +wxADJUST\_MINSIZE flag to make the minimal size of the control dynamically adjust +to the value returned by its \helpref{GetBestSize()}{wxwindowgetbestsize} +method - this allows, for example, for correct relayouting of a static text +control even if its text is changed during run-time.} \docparam{border}{Determines the border width, if the {\it flag} parameter is set to any border.} @@ -116,6 +131,20 @@ Tell the sizer to resize the {\it window} to match the sizer's minimal size. Thi is commonly done in the constructor of the window itself, see sample in the description of \helpref{wxBoxSizer}{wxboxsizer}. +\membersection{wxSizer::FitInside}\label{wxsizerfitinside} + +\func{void}{FitInside}{\param{wxWindow* }{window}} + +Tell the sizer to resize the virtual size of the {\it window} to match the sizer's +minimal size. This will not alter the on screen size of the window, but may cause +the addition/removal/alteration of scrollbars required to view the virtual area in +windows which manage it. + +\wxheading{See also} + +\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars},\rtfsp +\helpref{wxSizer::SetVirtualSizeHints}{wxsizersetvirtualsizehints} + \membersection{wxSizer::GetSize}\label{wxsizergetsize} \func{wxSize}{GetSize}{\void} @@ -215,8 +244,19 @@ after initial creation. \func{void}{SetSizeHints}{\param{wxWindow* }{window}} -Tell the sizer to set the minimal size of the {\it window} to match the sizer's minimal size. -This is commonly done in the constructor of the window itself, see sample in the description -of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable (as are many dialogs under Unix and -frames on probably all platforms). +Tell the sizer to set (and \helpref{Fit}{wxsizerfit}) the minimal size of the {\it window} to +match the sizer's minimal size. This is commonly done in the constructor of the window itself, +see sample in the description of \helpref{wxBoxSizer}{wxboxsizer} if the window is resizable +(as are many dialogs under Unix and frames on probably all platforms). + +\membersection{wxSizer::SetVirtualSizeHints}\label{wxsizersetvirtualsizehints} + +\func{void}{SetVirtualSizeHints}{\param{wxWindow* }{window}} + +Tell the sizer to set the minimal size of the {\it window} virtual area to match the sizer's +minimal size. For windows with managed scrollbars this will set them appropriately. + +\wxheading{See also} + +\helpref{wxScrolledWindow::SetScrollbars}{wxscrolledwindowsetscrollbars}