]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/rect.tex
suppress VC7.1 64 bit correctness warnings
[wxWidgets.git] / docs / latex / wx / rect.tex
index 79b426e33929aa41c2aadf3dea83951dfedc3e23..3a55f65f9b4703c679772ef29d5cbed6839bd460 100644 (file)
@@ -16,7 +16,7 @@ None
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxRect::wxRect}
+\membersection{wxRect::wxRect}\label{wxrectctor}
 
 \func{}{wxRect}{\void}
 
@@ -34,30 +34,51 @@ Creates a wxRect object from top-left and bottom-right points.
 
 Creates a wxRect object from position and size values.
 
-\membersection{wxRect::x}
+\membersection{wxRect::x}\label{wxrectx}
 
 \member{int}{x}
 
-x member.
+x coordinate of the top-level corner of the rectangle.
 
-\membersection{wxRect::y}
+\membersection{wxRect::y}\label{wxrecty}
 
 \member{int}{y}
 
-y member.
+y coordinate of the top-level corner of the rectangle.
 
-\membersection{wxRect::width}
+\membersection{wxRect::width}\label{wxrectwidth}
 
 \member{int}{width}
 
 Width member.
 
-\membersection{wxRect::height}
+\membersection{wxRect::height}\label{wxrectheight}
 
 \member{int}{height}
 
 Height member.
 
+\membersection{wxRect::Deflate}\label{wxrectdeflate}
+
+\func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
+
+\func{void}{Deflate}{\param{wxCoord }{diff}}
+
+\constfunc{wxRect}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
+
+Decrease the rectangle size by {\it dx} in x direction and {\it dy} in y
+direction. Both (or one of) parameters may be negative to increase the
+rectngle size. This method is the opposite of \helpref{Inflate}{wxrectinflate}.
+
+The second form uses the same {\it diff} for both {\it dx} and {\it dy}.
+
+The first two versions modify the rectangle in place, the last one returns a
+new rectangle leaving this one unchanged.
+
+\wxheading{See also}
+
+\helpref{Inflate}{wxrectinflate}
+
 \membersection{wxRect::GetBottom}\label{wxrectgetbottom}
 
 \constfunc{int}{GetBottom}{\void}
@@ -82,6 +103,18 @@ Gets the left point of the rectangle (the same as \helpref{wxRect::GetX}{wxrectg
 
 Gets the position.
 
+\membersection{wxRect::GetTopLeft}\label{wxrectgettopleft}
+
+\constfunc{wxPoint}{GetTopLeft}{\void}
+
+Gets the topleft position of the rectangle. (Same as GetPosition).
+
+\membersection{wxRect::GetBottomRight}\label{wxrectgetbottomright}
+
+\constfunc{wxPoint}{GetBottomRight}{\void}
+
+Gets the the bottom right position. Returns the bottom right point inside the rectangle.
+
 \membersection{wxRect::GetRight}\label{wxrectgetright}
 
 \constfunc{int}{GetRight}{\void}
@@ -124,12 +157,47 @@ Gets the y member.
 
 \func{void}{Inflate}{\param{wxCoord }{diff}}
 
+\constfunc{wxRect}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
+
 Increase the rectangle size by {\it dx} in x direction and {\it dy} in y
 direction. Both (or one of) parameters may be negative to decrease the
-rectngle size.
+rectangle size.
 
 The second form uses the same {\it diff} for both {\it dx} and {\it dy}.
 
+The first two versions modify the rectangle in place, the last one returns a
+new rectangle leaving this one unchanged.
+
+\wxheading{See also}
+
+\helpref{Deflate}{wxrectdeflate}
+
+\membersection{wxRect:Inside}\label{wxrectinside}
+
+\constfunc{bool}{Inside}{\param{int }{x}, \param{int }{y}}
+
+\constfunc{bool}{Inside}{\param{const wxPoint\& }{pt}}
+
+Returns {\tt true} if the given point is inside the rectangle (or on its
+boundary) and {\tt false} otherwise.
+
+\membersection{wxRect:Intersects}\label{wxrectintersects}
+
+\constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}}
+
+Returns {\tt true} if this rectangle has a non empty intersection with the
+rectangle {\it rect} and {\tt false} otherwise.
+
+\membersection{wxRect::Offset}\label{wxrectoffset}
+
+\func{void}{Offset}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
+
+\func{void}{Offset}{\param{const wxPoint\& }{pt}}
+
+Moves the rectangle by the specified offset. If {\it dx} is positive, the
+rectangle is moved to the right, if {\it dy} is positive, it is moved to the
+bottom, otherwise it is moved to the left or top respectively.
+
 \membersection{wxRect::SetHeight}\label{wxrectsetheight}
 
 \func{void}{SetHeight}{\param{int}{ height}}
@@ -154,22 +222,21 @@ Sets the x position.
 
 Sets the y position.
 
-\membersection{wxRect::operator $=$}
+\membersection{wxRect::operator $=$}\label{wxrectassign}
 
 \func{void}{operator $=$}{\param{const wxRect\& }{rect}}
 
 Assignment operator.
 
-\membersection{wxRect::operator $==$}
+\membersection{wxRect::operator $==$}\label{wxrectequal}
 
 \func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
 
 Equality operator.
 
-\membersection{wxRect::operator $!=$}
+\membersection{wxRect::operator $!=$}\label{wxrectnotequal}
 
 \func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
 
 Inequality operator.
 
-