]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/gbsizeritem.tex
change configure to better detect gstreamer. Check create is valid in mediaplayer...
[wxWidgets.git] / docs / latex / wx / gbsizeritem.tex
CommitLineData
20b35a69
RD
1
2\section{\class{wxGBSizerItem}}\label{wxgbsizeritem}
3
5a30d450 4The wxGBSizerItem class is used by the
20b35a69 5\helpref{wxGridBagSizer}{wxgridbagsizer} for tracking the items in the
5a30d450 6sizer. It adds grid position and spanning information to the normal
20b35a69
RD
7\helpref{wxSizerItem}{wxsizeritem} by adding
8\helpref{wxGBPosition}{wxgbposition} and \helpref{wxGBSpan}{wxgbspan}
5a30d450 9attrbibutes. Most of the time you will not need to use a
20b35a69
RD
10wxGBSizerItem directly in your code, but there are a couple of cases
11where it is handy.
12
20b35a69
RD
13\wxheading{Derived from}
14
15\helpref{wxSizerItem}{wxsizeritem}
16
17\wxheading{Include files}
18
19<wx/gbsizer.h>
20
20b35a69
RD
21\latexignore{\rtfignore{\wxheading{Members}}}
22
20b35a69
RD
23\membersection{wxGBSizerItem::wxGBSizerItem}\label{wxgbsizeritemwxgbsizeritem}
24
25\func{}{wxGBSizerItem}{\param{int }{width}, \param{int }{height}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
26
27Construct a sizer item for tracking a spacer.
28
20b35a69
RD
29\func{}{wxGBSizerItem}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
30
31Construct a sizer item for tracking a window.
32
20b35a69
RD
33\func{}{wxGBSizerItem}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
34
35Construct a sizer item for tracking a subsizer.
36
20b35a69
RD
37\membersection{wxGBSizerItem::GetEndPos}\label{wxgbsizeritemgetendpos}
38
39\func{void}{GetEndPos}{\param{int\& }{row}, \param{int\& }{col}}
40
41Get the row and column of the endpoint of this item
42
20b35a69
RD
43\membersection{wxGBSizerItem::GetPos}\label{wxgbsizeritemgetpos}
44
45\constfunc{wxGBPosition}{GetPos}{\void}
46
47\constfunc{void}{GetPos}{\param{int\& }{row}, \param{int\& }{col}}
48
49Get the grid position of the item.
50
20b35a69
RD
51\membersection{wxGBSizerItem::GetSpan}\label{wxgbsizeritemgetspan}
52
53\constfunc{wxGBSpan}{GetSpan}{\void}
54
55\constfunc{void}{GetSpan}{\param{int\& }{rowspan}, \param{int\& }{colspan}}
56
57Get the row and column spanning of the item.
58
20b35a69
RD
59\membersection{wxGBSizerItem::Intersects}\label{wxgbsizeritemintersects}
60
61\func{bool}{Intersects}{\param{const wxGBSizerItem\& }{other}}
62
63Returns true if this item and the other item instersect
64
20b35a69
RD
65\func{bool}{Intersects}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}}
66
67Returns true if the given pos/span would intersect with this item.
68
20b35a69
RD
69\membersection{wxGBSizerItem::SetPos}\label{wxgbsizeritemsetpos}
70
71\func{bool}{SetPos}{\param{const wxGBPosition\& }{pos}}
72
73If the item is already a member of a sizer then first ensure that
74there is no other item that would intersect with this one at the new
5a30d450 75position, then set the new position. Returns true if the change is
20b35a69
RD
76successful and after the next Layout the item will be moved.
77
20b35a69
RD
78\membersection{wxGBSizerItem::SetSpan}\label{wxgbsizeritemsetspan}
79
80\func{bool}{SetSpan}{\param{const wxGBSpan\& }{span}}
81
82If the item is already a member of a sizer then first ensure that
83there is no other item that would intersect with this one with its new
5a30d450 84spanning size, then set the new spanning. Returns true if the change
20b35a69 85is successful and after the next Layout the item will be resized.
5a30d450 86