undefine _DEFINE_LIST before redefining it; also rename it to have WX prefix

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

diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex
index 44239884dd02cac10958f9152384307291856765..b762d63a6c5086d58a2f1947ef5f60e0ef209ca6 100644 (file)
--- a/docs/latex/wx/rect.tex
+++ b/docs/latex/wx/rect.tex
@@ -10,6 +10,10 @@ None
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize}
 \wxheading{See also}
 
 \helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize}


@@ -68,10 +72,40 @@ Width member.
 Height member.
 
 
 Height member.
 
 

+\membersection{wxRect::CentreIn}\label{wxrectcentrein}
+
+\constfunc{wxRect}{CentreIn}{\param{const wxRect\& }{r}, \param{int }{dir = wxBOTH}}
+
+\constfunc{wxRect}{CenterIn}{\param{const wxRect\& }{r}, \param{int }{dir = wxBOTH}}
+
+Returns the rectangle having the same size as this one but centered relatively
+to the given rectangle \arg{r}. By default, rectangle is centred in both
+directions but if \arg{dir} includes only \texttt{wxVERTICAL} or only 
+\texttt{wxHORIZONTAL} flag, then it is only centered in this direction while
+the other component of its position remains unchanged.
+
+
+\membersection{wxRect::Contains}\label{wxrectcontains}
+
+\constfunc{bool}{Contains}{\param{int }{x}, \param{int }{y}}
+
+\constfunc{bool}{Contains}{\param{const wxPoint\& }{pt}}
+
+Returns {\tt true} if the given point is inside the rectangle (or on its
+boundary) and {\tt false} otherwise.
+
+\constfunc{bool}{Contains}{\param{const wxRect\& }{rect}}
+
+Returns \true if the given rectangle is completely inside this rectangle
+(or touches its boundary) and \false otherwise.
+
+

 \membersection{wxRect::Deflate}\label{wxrectdeflate}
 
 \func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 
 \membersection{wxRect::Deflate}\label{wxrectdeflate}
 
 \func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 

+\func{void}{Deflate}{\param{const wxSize\& }{diff}}
+

 \func{void}{Deflate}{\param{wxCoord }{diff}}
 
 \constfunc{wxRect}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 \func{void}{Deflate}{\param{wxCoord }{diff}}
 
 \constfunc{wxRect}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}


@@ -119,14 +153,29 @@ Gets the position.
 
 \constfunc{wxPoint}{GetTopLeft}{\void}
 
 
 \constfunc{wxPoint}{GetTopLeft}{\void}
 

-Gets the topleft position of the rectangle. (Same as GetPosition).
+Gets the position of the top left corner of the rectangle, same as 
+\helpref{GetPosition}{wxrectgetposition}.
+
+
+\membersection{wxRect::GetTopRight}\label{wxrectgettopright}
+
+\constfunc{wxPoint}{GetTopRight}{\void}
+
+Gets the position of the top right corner.
+
+
+\membersection{wxRect::GetBottomLeft}\label{wxrectgetbottomleft}
+
+\constfunc{wxPoint}{GetBottomLeft}{\void}
+
+Gets the position of the bottom left corner.

 
 
 \membersection{wxRect::GetBottomRight}\label{wxrectgetbottomright}
 
 \constfunc{wxPoint}{GetBottomRight}{\void}
 
 
 
 \membersection{wxRect::GetBottomRight}\label{wxrectgetbottomright}
 
 \constfunc{wxPoint}{GetBottomRight}{\void}
 

-Gets the the bottom right position. Returns the bottom right point inside the rectangle.
+Gets the position of the bottom right corner.

 
 
 \membersection{wxRect::GetRight}\label{wxrectgetright}
 
 
 \membersection{wxRect::GetRight}\label{wxrectgetright}


@@ -142,6 +191,10 @@ Gets the right point of the rectangle.
 
 Gets the size.
 
 
 Gets the size.
 

+\wxheading{See also}
+
+\helpref{wxRect::SetSize}{wxrectsetsize}
+

 
 \membersection{wxRect::GetTop}\label{wxrectgettop}
 
 
 \membersection{wxRect::GetTop}\label{wxrectgettop}
 


@@ -175,6 +228,8 @@ Gets the y member.
 
 \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 
 
 \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 

+\func{void}{Inflate}{\param{const wxSize\& }{diff}}
+

 \func{void}{Inflate}{\param{wxCoord }{diff}}
 
 \constfunc{wxRect}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 \func{void}{Inflate}{\param{wxCoord }{diff}}
 
 \constfunc{wxRect}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}


@@ -217,22 +272,20 @@ means:
 \helpref{Deflate}{wxrectdeflate}
 
 
 \helpref{Deflate}{wxrectdeflate}
 
 

-\membersection{wxRect::Inside}\label{wxrectinside}
-
-\constfunc{bool}{Inside}{\param{int }{x}, \param{int }{y}}
+\membersection{wxRect::Intersects}\label{wxrectintersects}

 
 

-\constfunc{bool}{Inside}{\param{const wxPoint\& }{pt}}
+\constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}

 
 

-Returns {\tt true} if the given point is inside the rectangle (or on its
-boundary) and {\tt false} otherwise.
+Returns {\tt true} if this rectangle has a non-empty intersection with the
+rectangle {\it rect} and {\tt false} otherwise.

 
 
 
 

-\membersection{wxRect::Intersects}\label{wxrectintersects}
+\membersection{wxRect::IsEmpty}\label{wxrectisempty}

 
 

-\constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}
+\constfunc{bool}{IsEmpty}{}

 
 

-Returns {\tt true} if this rectangle has a non empty intersection with the
-rectangle {\it rect} and {\tt false} otherwise.
+Returns {\tt true} if this rectangle has a width or height less than or equal to 
+0 and {\tt false} otherwise.

 
 
 \membersection{wxRect::Offset}\label{wxrectoffset}
 
 
 \membersection{wxRect::Offset}\label{wxrectoffset}


@@ -253,6 +306,17 @@ bottom, otherwise it is moved to the left or top respectively.
 Sets the height.
 
 
 Sets the height.
 
 

+\membersection{wxRect::SetSize}\label{wxrectsetsize}
+
+\func{void}{SetSize}{\param{const wxSize\&}{ s}}
+
+Sets the size.
+
+\wxheading{See also}
+
+\helpref{wxRect::GetSize}{wxrectgetsize}
+
+

 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 
 \func{void}{SetWidth}{\param{int}{ width}}
 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 
 \func{void}{SetWidth}{\param{int}{ width}}


@@ -294,14 +358,32 @@ Assignment operator.
 
 \membersection{wxRect::operator $==$}\label{wxrectequal}
 
 
 \membersection{wxRect::operator $==$}\label{wxrectequal}
 

-\func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
+\func{bool}{operator $==$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}

 
 Equality operator.
 
 
 \membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 
 
 Equality operator.
 
 
 \membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 

-\func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
+\func{bool}{operator $!=$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}

 
 Inequality operator.
 
 
 Inequality operator.
 

+
+\func{wxRect}{operator $+$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}
+
+\func{wxRect\&}{operator $+=$}{\param{const wxRect\& }{r}}
+
+Like \helpref{Union}{wxrectunion} but don't treat empty rectangles specially.
+
+\wxheading{See also}
+
+\helpref{wxRect::Union}{wxrectunion}
+
+
+\func{wxRect}{operator $*$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}}
+
+\func{wxRect\&}{operator $*=$}{\param{const wxRect\& }{r}}
+
+Returns the intersection of two rectangles (which may be empty).
+