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