\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxGBPosition::wxGBPosition}\label{wxgbpositionwxgbposition}
\func{}{wxGBPosition}{\void}
Construct a new wxGBPosition, optionally setting the row and column.
The default is (0,0).
-
\membersection{wxGBPosition::GetCol}\label{wxgbpositiongetcol}
\constfunc{int}{GetCol}{\void}
Is the wxGBPosition valid? (An invalid wxGBPosition is (-1,-1). )
-
\membersection{wxGBPosition::operator==}\label{wxgbpositionoperatorequal}
\constfunc{bool operator}{operator==}{\param{const wxGBPosition\& }{p}}
\section{\class{wxGBSizerItem}}\label{wxgbsizeritem}
-The wxGBSizerItem class is used by the
+The wxGBSizerItem class is used by the
\helpref{wxGridBagSizer}{wxgridbagsizer} for tracking the items in the
-sizer. It adds grid position and spanning information to the normal
+sizer. It adds grid position and spanning information to the normal
\helpref{wxSizerItem}{wxsizeritem} by adding
\helpref{wxGBPosition}{wxgbposition} and \helpref{wxGBSpan}{wxgbspan}
-attrbibutes. Most of the time you will not need to use a
+attrbibutes. Most of the time you will not need to use a
wxGBSizerItem directly in your code, but there are a couple of cases
where it is handy.
-
\wxheading{Derived from}
\helpref{wxSizerItem}{wxsizeritem}
<wx/gbsizer.h>
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxGBSizerItem::wxGBSizerItem}\label{wxgbsizeritemwxgbsizeritem}
\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}}
Construct a sizer item for tracking a spacer.
-
-
\func{}{wxGBSizerItem}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
Construct a sizer item for tracking a window.
-
-
\func{}{wxGBSizerItem}{\param{wxSizer* }{sizer}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{int }{flag}, \param{int }{border}, \param{wxObject* }{userData}}
Construct a sizer item for tracking a subsizer.
-
-
\membersection{wxGBSizerItem::GetEndPos}\label{wxgbsizeritemgetendpos}
\func{void}{GetEndPos}{\param{int\& }{row}, \param{int\& }{col}}
Get the row and column of the endpoint of this item
-
\membersection{wxGBSizerItem::GetPos}\label{wxgbsizeritemgetpos}
\constfunc{wxGBPosition}{GetPos}{\void}
Get the grid position of the item.
-
-
\membersection{wxGBSizerItem::GetSpan}\label{wxgbsizeritemgetspan}
\constfunc{wxGBSpan}{GetSpan}{\void}
Get the row and column spanning of the item.
-
-
\membersection{wxGBSizerItem::Intersects}\label{wxgbsizeritemintersects}
\func{bool}{Intersects}{\param{const wxGBSizerItem\& }{other}}
Returns true if this item and the other item instersect
-
\func{bool}{Intersects}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}}
Returns true if the given pos/span would intersect with this item.
-
\membersection{wxGBSizerItem::SetPos}\label{wxgbsizeritemsetpos}
\func{bool}{SetPos}{\param{const wxGBPosition\& }{pos}}
If the item is already a member of a sizer then first ensure that
there is no other item that would intersect with this one at the new
-position, then set the new position. Returns true if the change is
+position, then set the new position. Returns true if the change is
successful and after the next Layout the item will be moved.
-
\membersection{wxGBSizerItem::SetSpan}\label{wxgbsizeritemsetspan}
\func{bool}{SetSpan}{\param{const wxGBSpan\& }{span}}
If the item is already a member of a sizer then first ensure that
there is no other item that would intersect with this one with its new
-spanning size, then set the new spanning. Returns true if the change
+spanning size, then set the new spanning. Returns true if the change
is successful and after the next Layout the item will be resized.
+
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxGBSpan::wxGBSpan}\label{wxgbspanwxgbspan}
\func{}{wxGBSpan}{\void}
The default is (1,1). (Meaning that the item occupies one cell in
each direction.
-
\membersection{wxGBSpan::GetColspan}\label{wxgbspangetcolspan}
\constfunc{int}{GetColspan}{\void}
Get the current colspan value.
-
\membersection{wxGBSpan::GetRowspan}\label{wxgbspangetrowspan}
\constfunc{int}{GetRowspan}{\void}
Get the current rowspan value.
-
\membersection{wxGBSpan::SetColspan}\label{wxgbspansetcolspan}
\func{void}{SetColspan}{\param{int }{colspan}}
Set a new colspan value.
-
\membersection{wxGBSpan::SetRowspan}\label{wxgbspansetrowspan}
\func{void}{SetRowspan}{\param{int }{rowspan}}
Set a new rowspan value.
-
\membersection{wxGBSpan::operator!}\label{wxgbspanoperatorunknown}
\constfunc{bool}{operator!}{\param{const wxGBSpan\& }{o}}
Is the wxGBSpan valid? (An invalid wxGBPosition is (-1,-1). )
-
\membersection{wxGBSpan::operator==}\label{wxgbspanoperatorequal}
\constfunc{bool operator}{operator==}{\param{const wxGBSpan\& }{o}}
Compare equality of two wxGBSpans.
+
A \helpref{wxSizer}{wxsizer} that can lay out items in a virtual grid
like a \helpref{wxFlexGridSizer}{wxflexgridsizer} but in this case
-explicit positioning of the items is allowed using
+explicit positioning of the items is allowed using
\helpref{wxGBPosition}{wxgbposition}, and items can optionally span
more than one row and/or column using \helpref{wxGBSpan}{wxgbspan}.
-
\wxheading{Derived from}
\helpref{wxFlexGridSizer}{wxflexgridsizer}\\
\helpref{wxSizer}{wxsizer}\\
\helpref{wxObject}{wxobject}
-
\wxheading{Include files}
<wx/gbsizer.h>
-
\latexignore{\rtfignore{\wxheading{Members}}}
-
\membersection{wxGridBagSizer::wxGridBagSizer}\label{wxgridbagsizerwxgridbagsizer}
\func{}{wxGridBagSizer}{\param{int }{vgap = 0}, \param{int }{hgap = 0}}
Constructor, with optional parameters to specify the gap between the
rows and columns.
-
\membersection{wxGridBagSizer::Add}\label{wxgridbagsizeradd}
\func{bool}{Add}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span = wxDefaultSpan}, \param{int }{flag = 0}, \param{int }{border = 0}, \param{wxObject* }{userData = NULL}}
The Add methods return true if the item was successfully placed at the
given position, false if something was already there.
-
-
-
\membersection{wxGridBagSizer::CalcMin}\label{wxgridbagsizercalcmin}
\func{wxSize}{CalcMin}{\void}
Called when the managed size of the sizer is needed or when layout
needs done.
-
\membersection{wxGridBagSizer::CheckForIntersection}\label{wxgridbagsizercheckforintersection}
\func{bool}{CheckForIntersection}{\param{wxGBSizerItem* }{item}, \param{wxGBSizerItem* }{excludeItem = NULL}}
\func{bool}{CheckForIntersection}{\param{const wxGBPosition\& }{pos}, \param{const wxGBSpan\& }{span}, \param{wxGBSizerItem* }{excludeItem = NULL}}
Look at all items and see if any intersect (or would overlap) the given
-item. Returns true if so, false if there would be no overlap. If an
+item. Returns true if so, false if there would be no overlap. If an
excludeItem is given then it will not be checked for intersection, for
example it may be the item we are checking the position of.
-
-
\membersection{wxGridBagSizer::FindItem}\label{wxgridbagsizerfinditem}
\func{wxGBSizerItem*}{FindItem}{\param{wxWindow* }{window}}
Find the sizer item for the given window or subsizer, returns NULL if
not found. (non-recursive)
-
-
\membersection{wxGridBagSizer::FindItemAtPoint}\label{wxgridbagsizerfinditematpoint}
\func{wxGBSizerItem*}{FindItemAtPoint}{\param{const wxPoint\& }{pt}}
to the client coordinates of the window using the sizer for
layout. (non-recursive)
-
-
\membersection{wxGridBagSizer::FindItemAtPosition}\label{wxgridbagsizerfinditematposition}
\func{wxGBSizerItem*}{FindItemAtPosition}{\param{const wxGBPosition\& }{pos}}
Return the sizer item for the given grid cell, or NULL if there is no
item at that position. (non-recursive)
-
-
\membersection{wxGridBagSizer::FindItemWithData}\label{wxgridbagsizerfinditemwithdata}
\func{wxGBSizerItem*}{FindItemWithData}{\param{const wxObject* }{userData}}
Return the sizer item that has a matching user data (it only compares
pointer values) or NULL if not found. (non-recursive)
-
-
\membersection{wxGridBagSizer::GetCellSize}\label{wxgridbagsizergetcellsize}
\constfunc{wxSize}{GetCellSize}{\param{int }{row}, \param{int }{col}}
-Get the size of the specified cell, including hgap and vgap. Only
+Get the size of the specified cell, including hgap and vgap. Only
valid after a Layout.
-
-
\membersection{wxGridBagSizer::GetEmptyCellSize}\label{wxgridbagsizergetemptycellsize}
\constfunc{wxSize}{GetEmptyCellSize}{\void}
Get the size used for cells in the grid with no item.
-
-
\membersection{wxGridBagSizer::GetItemPosition}\label{wxgridbagsizergetitemposition}
\func{wxGBPosition}{GetItemPosition}{\param{wxWindow* }{window}}
Get the grid position of the specified item.
-
-
\membersection{wxGridBagSizer::GetItemSpan}\label{wxgridbagsizergetitemspan}
\func{wxGBSpan}{GetItemSpan}{\param{wxWindow* }{window}}
Get the row/col spanning of the specified item
-
-
\membersection{wxGridBagSizer::RecalcSizes}\label{wxgridbagsizerrecalcsizes}
\func{void}{RecalcSizes}{\void}
Called when the managed size of the sizer is needed or when layout
needs done.
-
\membersection{wxGridBagSizer::SetEmptyCellSize}\label{wxgridbagsizersetemptycellsize}
\func{void}{SetEmptyCellSize}{\param{const wxSize\& }{sz}}
Set the size used for cells in the grid with no item.
-
-
\membersection{wxGridBagSizer::SetItemPosition}\label{wxgridbagsizersetitemposition}
\func{bool}{SetItemPosition}{\param{wxWindow* }{window}, \param{const wxGBPosition\& }{pos}}
\func{bool}{SetItemPosition}{\param{size\_t }{index}, \param{const wxGBPosition\& }{pos}}
-Set the grid position of the specified item. Returns true on success.
+Set the grid position of the specified item. Returns true on success.
If the move is not allowed (because an item is already there) then
-false is returned.
-
-
+false is returned.
\membersection{wxGridBagSizer::SetItemSpan}\label{wxgridbagsizersetitemspan}
\func{bool}{SetItemSpan}{\param{size\_t }{index}, \param{const wxGBSpan\& }{span}}
Set the row/col spanning of the specified item. Returns true on
-success. If the move is not allowed (because an item is already there)
+success. If the move is not allowed (because an item is already there)
then false is returned.
-
-
This class represents a short sound (loaded from Windows WAV file), that
can be stored in memory and played. Currently this class is implemented
-on Windows and Unix (and uses either
-\urlref{Open Sound System}{http://www.opensound.com/oss.html} or
+on Windows and Unix (and uses either
+\urlref{Open Sound System}{http://www.opensound.com/oss.html} or
\urlref{Simple DirectMedia Layer}{http://www.libsdl.org/}).
\wxheading{Derived from}
The possible values for \arg{flags} are:
\begin{twocollist}
- \twocolitem{wxSOUND\_SYNC}{{\tt Play} will block and wait until the sound is
- replayed.}
- \twocolitem{wxSOUND\_ASYNC}{Sound is played asynchronously,
- {\tt Play} returns immediately}
- \twocolitem{wxSOUND\_ASYNC | wxSOUND\_LOOP}{Sound is played asynchronously
- and loops until another sound is played,
- \helpref{wxSound::Stop}{wxsoundstop} is called or the program terminates.}
+\twocolitem{wxSOUND\_SYNC}{{\tt Play} will block and wait until the sound is
+replayed.}
+\twocolitem{wxSOUND\_ASYNC}{Sound is played asynchronously,
+{\tt Play} returns immediately}
+\twocolitem{wxSOUND\_ASYNC | wxSOUND\_LOOP}{Sound is played asynchronously
+and loops until another sound is played,
+\helpref{wxSound::Stop}{wxsoundstop} is called or the program terminates.}
\end{twocollist}
The static form is shorthand for this code:
\func{static void}{Stop}{\void}
If a sound is played, this function stops it.
+
projects / wxWidgets.git / commitdiff
