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