docs/latex/wx/calclevt.tex

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