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