From f4c43a177e90b0699097934d4bc40b3fc452becd Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Mon, 20 May 2002 15:28:12 +0000 Subject: [PATCH] added docs for a few missing methods (Inside, Deflate, Offset) git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@15611 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/latex/wx/rect.tex | 56 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 56 insertions(+) diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex index 4611502121..f99446bc73 100644 --- a/docs/latex/wx/rect.tex +++ b/docs/latex/wx/rect.tex @@ -58,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} @@ -124,12 +145,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. 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}} -- 2.47.2