]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/calclevt.tex
a bit more docs
[wxWidgets.git] / docs / latex / wx / calclevt.tex
CommitLineData
6fb26ea3
JS
1\section{\class{wxCalculateLayoutEvent}}\label{wxcalculatelayoutevent}
2
3This event is sent by \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} to
4calculate the amount of the remaining client area that the window should
5occupy.
6
7\wxheading{Derived from}
8
9\helpref{wxEvent}{wxevent}\\
10\helpref{wxObject}{wxobject}
11
12\wxheading{Event table macros}
13
14\twocolwidtha{7cm}%
15\begin{twocollist}\itemsep=0pt
16\twocolitem{{\bf EVT\_CALCULATE\_LAYOUT(func)}}{Process a wxEVT\_CALCULATE\_LAYOUT event,
17which asks the window to take a 'bite' out of a rectangle provided by the algorithm.}
18\end{twocollist}
19
20\wxheading{See also}
21
22\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent},\rtfsp
23\helpref{wxSashLayoutWindow}{wxsashlayoutwindow},\rtfsp
24\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}.
25
26\latexignore{\rtfignore{\wxheading{Members}}}
27
28\membersection{wxCalculateLayoutEvent::wxCalculateLayoutEvent}
29
30\func{}{wxCalculateLayoutEvent}{\param{wxWindowID }{id = 0}}
31
32Constructor.
33
34\membersection{wxCalculateLayoutEvent::GetFlags}\label{wxcalculatelayouteventgetflags}
35
36\constfunc{int}{GetFlags}{\void}
37
38Returns the flags associated with this event. Not currently used.
39
40\membersection{wxCalculateLayoutEvent::GetRect}\label{wxcalculatelayouteventgetrect}
41
42\constfunc{wxRect}{GetRect}{\void}
43
44Before the event handler is entered, returns the remaining parent client area that the window
45could occupy. When the event handler returns, this should contain the remaining parent client rectangle,
46after the event handler has subtracted the area that its window occupies.
47
48\membersection{wxCalculateLayoutEvent::SetFlags}\label{wxcalculatelayouteventsetflags}
49
50\func{void}{SetFlags}{\param{int }{flags}}
51
52Sets the flags associated with this event. Not currently used.
53
54\membersection{wxCalculateLayoutEvent::SetRect}\label{wxcalculatelayouteventsetrect}
55
56\func{void}{SetRect}{\param{const wxRect\& }{rect}}
57
58Call this to specify the new remaining parent client area, after the space occupied by the
59window has been subtracted.
60