]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/calclevt.tex
remove C++ comment
[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
954b8ae6
JS
12\wxheading{Include files}
13
14<wx/laywin.h>
15
a7af285d
VZ
16\wxheading{Library}
17
18\helpref{wxAdv}{librarieslist}
19
6fb26ea3
JS
20\wxheading{Event table macros}
21
22\twocolwidtha{7cm}%
23\begin{twocollist}\itemsep=0pt
24\twocolitem{{\bf EVT\_CALCULATE\_LAYOUT(func)}}{Process a wxEVT\_CALCULATE\_LAYOUT event,
25which asks the window to take a 'bite' out of a rectangle provided by the algorithm.}
26\end{twocollist}
27
28\wxheading{See also}
29
30\helpref{wxQueryLayoutInfoEvent}{wxquerylayoutinfoevent},\rtfsp
31\helpref{wxSashLayoutWindow}{wxsashlayoutwindow},\rtfsp
32\helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}.
33
34\latexignore{\rtfignore{\wxheading{Members}}}
35
f510b7b2 36\membersection{wxCalculateLayoutEvent::wxCalculateLayoutEvent}\label{wxcalculatelayouteventctor}
6fb26ea3
JS
37
38\func{}{wxCalculateLayoutEvent}{\param{wxWindowID }{id = 0}}
39
40Constructor.
41
42\membersection{wxCalculateLayoutEvent::GetFlags}\label{wxcalculatelayouteventgetflags}
43
44\constfunc{int}{GetFlags}{\void}
45
46Returns the flags associated with this event. Not currently used.
47
48\membersection{wxCalculateLayoutEvent::GetRect}\label{wxcalculatelayouteventgetrect}
49
50\constfunc{wxRect}{GetRect}{\void}
51
52Before the event handler is entered, returns the remaining parent client area that the window
53could occupy. When the event handler returns, this should contain the remaining parent client rectangle,
54after the event handler has subtracted the area that its window occupies.
55
56\membersection{wxCalculateLayoutEvent::SetFlags}\label{wxcalculatelayouteventsetflags}
57
58\func{void}{SetFlags}{\param{int }{flags}}
59
60Sets the flags associated with this event. Not currently used.
61
62\membersection{wxCalculateLayoutEvent::SetRect}\label{wxcalculatelayouteventsetrect}
63
64\func{void}{SetRect}{\param{const wxRect\& }{rect}}
65
66Call this to specify the new remaining parent client area, after the space occupied by the
67window has been subtracted.
68