docs/latex/wx/qylayevt.tex

   1 \section{\class{wxQueryLayoutInfoEvent}}\label{wxquerylayoutinfoevent}
   2
   3 This event is sent when \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm} wishes to get
   4 the size, orientation and alignment of a window. More precisely, the event is sent
   5 by the OnCalculateLayout handler which is itself invoked by wxLayoutAlgorithm.
   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\_QUERY\_LAYOUT\_INFO(func)}}{Process a wxEVT\_QUERY\_LAYOUT\_INFO event,
  17 to get size, orientation and alignment from a window.}
  18 \end{twocollist}
  19
  20 \wxheading{Data structures}
  21
  22 {\small
  23 \begin{verbatim}
  24 enum wxLayoutOrientation {
  25     wxLAYOUT_HORIZONTAL,
  26     wxLAYOUT_VERTICAL
  27 };
  28
  29 enum wxLayoutAlignment {
  30     wxLAYOUT_NONE,
  31     wxLAYOUT_TOP,
  32     wxLAYOUT_LEFT,
  33     wxLAYOUT_RIGHT,
  34     wxLAYOUT_BOTTOM,
  35 };
  36 \end{verbatim}
  37 }
  38
  39 \wxheading{See also}
  40
  41 \helpref{wxCalculateLayoutEvent}{wxcalculatelayoutevent},\rtfsp
  42 \helpref{wxSashLayoutWindow}{wxsashlayoutwindow},\rtfsp
  43 \helpref{wxLayoutAlgorithm}{wxlayoutalgorithm}.
  44
  45 \latexignore{\rtfignore{\wxheading{Members}}}
  46
  47 \membersection{wxQueryLayoutInfoEvent::wxQueryLayoutInfoEvent}
  48
  49 \func{}{wxQueryLayoutInfoEvent}{\param{wxWindowID }{id = 0}}
  50
  51 Constructor.
  52
  53 \membersection{wxQueryLayoutInfoEvent::GetAlignment}\label{wxquerylayoutinfoeventgetalignment}
  54
  55 \constfunc{void}{GetAlignment}{\void}
  56
  57 Specifies the alignment of the window (which side of the remaining parent client area
  58 the window sticks to). One of wxLAYOUT\_TOP, wxLAYOUT\_LEFT, wxLAYOUT\_RIGHT, wxLAYOUT\_BOTTOM.
  59
  60 \membersection{wxQueryLayoutInfoEvent::GetFlags}\label{wxquerylayoutinfoeventgetflags}
  61
  62 \constfunc{int}{GetFlags}{\void}
  63
  64 Returns the flags associated with this event. Not currently used.
  65
  66 \membersection{wxQueryLayoutInfoEvent::GetOrientation}\label{wxquerylayoutinfoeventgetorientation}
  67
  68 \constfunc{wxLayoutOrientation}{GetOrientation}{\void}
  69
  70 Returns the orientation that the event handler specified to the event object. May be one of wxLAYOUT\_HORIZONTAL,
  71 wxLAYOUT\_VERTICAL.
  72
  73 \membersection{wxQueryLayoutInfoEvent::GetRequestedLength}\label{wxquerylayoutinfoeventgetrequestedlength}
  74
  75 \constfunc{int}{GetRequestedLength}{\void}
  76
  77 Returns the requested length of the window in the direction of the window orientation. This information
  78 is not yet used.
  79
  80 \membersection{wxQueryLayoutInfoEvent::GetSize}\label{wxquerylayoutinfoeventgetsize}
  81
  82 \constfunc{wxSize}{GetSize}{\void}
  83
  84 Returns the size that the event handler specified to the event object as being the requested size of the window.
  85
  86 \membersection{wxQueryLayoutInfoEvent::SetAlignment}\label{wxquerylayoutinfoeventsetalignment}
  87
  88 \func{void}{SetAlignment}{\param{wxLayoutAlignment }{alignment}}
  89
  90 Call this to specify the alignment of the window (which side of the remaining parent client area
  91 the window sticks to). May be one of wxLAYOUT\_TOP, wxLAYOUT\_LEFT, wxLAYOUT\_RIGHT, wxLAYOUT\_BOTTOM.
  92
  93 \membersection{wxQueryLayoutInfoEvent::SetFlags}\label{wxquerylayoutinfoeventsetflags}
  94
  95 \func{void}{SetFlags}{\param{int }{flags}}
  96
  97 Sets the flags associated with this event. Not currently used.
  98
  99 \membersection{wxQueryLayoutInfoEvent::SetOrientation}\label{wxquerylayoutinfoeventsetorientation}
 100
 101 \func{void}{SetOrientation}{\param{wxLayoutOrientation }{orientation}}
 102
 103 Call this to specify the orientation of the window. May be one of wxLAYOUT\_HORIZONTAL,
 104 wxLAYOUT\_VERTICAL.
 105
 106 \membersection{wxQueryLayoutInfoEvent::SetRequestedLength}\label{wxquerylayoutinfoeventsetrequestedlength}
 107
 108 \func{void}{SetRequestedLength}{\param{int}{ length}}
 109
 110 Sets the requested length of the window in the direction of the window orientation. This information
 111 is not yet used.
 112
 113 \membersection{wxQueryLayoutInfoEvent::SetSize}\label{wxquerylayoutinfoeventsetsize}
 114
 115 \func{void}{SetSize}{\param{const wxSize\& }{size}}
 116
 117 Call this to let the calling code know what the size of the window is.
 118