[wxWidgets.git] / docs / latex / wx / gbspan.tex


\section{\class{wxGBSpan}}\label{wxgbspan}

This class is used to hold the row and column spanning attributes of
items in a \helpref{wxGridBagSizer}{wxgridbagsizer}.

\wxheading{Derived from}

No base class

\wxheading{Include files}

<wx/gbsizer.h>

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxGBSpan::wxGBSpan}\label{wxgbspanwxgbspan}

\func{}{wxGBSpan}{\void}

\func{}{wxGBSpan}{\param{int }{rowspan}, \param{int }{colspan}}

Construct a new wxGBSpan, optionally setting the rowspan and colspan.
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 wxGBSpan is (-1,-1). )

\membersection{wxGBSpan::operator==}\label{wxgbspanoperatorequal}

\constfunc{bool operator}{operator==}{\param{const wxGBSpan\& }{o}}

Compare equality of two wxGBSpans.
Commit	Line	Data
20b35a69 RD	1
	2	\section{\class{wxGBSpan}}\label{wxgbspan}
	3
	4	This class is used to hold the row and column spanning attributes of
	5	items in a \helpref{wxGridBagSizer}{wxgridbagsizer}.
	6
	7	\wxheading{Derived from}
	8
	9	No base class
	10
	11	\wxheading{Include files}
	12
	13	<wx/gbsizer.h>
	14
	15	\latexignore{\rtfignore{\wxheading{Members}}}
	16
20b35a69 RD	17	\membersection{wxGBSpan::wxGBSpan}\label{wxgbspanwxgbspan}
	18
	19	\func{}{wxGBSpan}{\void}
	20
	21	\func{}{wxGBSpan}{\param{int }{rowspan}, \param{int }{colspan}}
	22
	23	Construct a new wxGBSpan, optionally setting the rowspan and colspan.
	24	The default is (1,1). (Meaning that the item occupies one cell in
	25	each direction.
	26
20b35a69 RD	27	\membersection{wxGBSpan::GetColspan}\label{wxgbspangetcolspan}
	28
	29	\constfunc{int}{GetColspan}{\void}
	30
	31	Get the current colspan value.
	32
20b35a69 RD	33	\membersection{wxGBSpan::GetRowspan}\label{wxgbspangetrowspan}
	34
	35	\constfunc{int}{GetRowspan}{\void}
	36
	37	Get the current rowspan value.
	38
20b35a69 RD	39	\membersection{wxGBSpan::SetColspan}\label{wxgbspansetcolspan}
	40
	41	\func{void}{SetColspan}{\param{int }{colspan}}
	42
	43	Set a new colspan value.
	44
20b35a69 RD	45	\membersection{wxGBSpan::SetRowspan}\label{wxgbspansetrowspan}
	46
	47	\func{void}{SetRowspan}{\param{int }{rowspan}}
	48
	49	Set a new rowspan value.
	50
20b35a69 RD	51	\membersection{wxGBSpan::operator!}\label{wxgbspanoperatorunknown}
	52
	53	\constfunc{bool}{operator!}{\param{const wxGBSpan\& }{o}}
	54
ece83544	55	Is the wxGBSpan valid? (An invalid wxGBSpan is (-1,-1). )
20b35a69	56
20b35a69 RD	57	\membersection{wxGBSpan::operator==}\label{wxgbspanoperatorequal}
	58
	59	\constfunc{bool operator}{operator==}{\param{const wxGBSpan\& }{o}}
	60
	61	Compare equality of two wxGBSpans.
5a30d450	62