Added a couple of wxPerl notes.

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

diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex
index ca5c504568d86b1db1b448bb91f94aad02f96e7f..63216a5bbf71e8da9fcc10fdedaab0b0a1f103a5 100644 (file)
--- a/docs/latex/wx/rect.tex
+++ b/docs/latex/wx/rect.tex
@@ -4,7 +4,11 @@ A class for manipulating rectangles.
 
 \wxheading{Derived from}
 
-\helpref{wxObject}{wxobject}
+None
+
+\wxheading{Include files}
+
+<wx/gdicmn.h>
 
 \wxheading{See also}
 
@@ -18,7 +22,7 @@ A class for manipulating rectangles.
 
 Default constructor.
 
-\func{}{wxRect}{\param{const int}{ x}, \param{const int}{ y}, \param{const int}{ width}, \param{const int}{ height}}
+\func{}{wxRect}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}}
 
 Creates a wxRect object from x, y, width and height values.
 
@@ -34,13 +38,13 @@ Creates a wxRect object from position and size values.
 
 \member{int}{x}
 
-x member.
+x coordinate of the top-level corner of the rectangle.
 
 \membersection{wxRect::y}
 
 \member{int}{y}
 
-y member.
+y coordinate of the top-level corner of the rectangle.
 
 \membersection{wxRect::width}
 
@@ -54,6 +58,27 @@ Width member.
 
 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}
@@ -114,27 +139,74 @@ Gets the x member.
 
 Gets the y member.
 
+\membersection{wxRect::Inflate}\label{wxrectinflate}
+
+\func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
+
+\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
+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{const int}{ height}}
+\func{void}{SetHeight}{\param{int}{ height}}
 
 Sets the height.
 
 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 
-\func{void}{SetWidth}{\param{const int}{ width}}
+\func{void}{SetWidth}{\param{int}{ width}}
 
 Sets the width.
 
 \membersection{wxRect::SetX}\label{wxrectsetx}
 
-\func{void}{SetX}{\param{const int}{ x}}
+\func{void}{SetX}{\param{int}{ x}}
 
 Sets the x position.
 
 \membersection{wxRect::SetY}\label{wxrectsety}
 
-\func{void}{SetY}{\param{const int}{ y}}
+\func{void}{SetY}{\param{int}{ y}}
 
 Sets the y position.
 
@@ -156,4 +228,3 @@ Equality operator.
 
 Inequality operator.
 
-