X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/869b59fc9114983483acd4d16e86e78997d4faca..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/rect.tex diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex index f94ab4fc95..4885f61c97 100644 --- a/docs/latex/wx/rect.tex +++ b/docs/latex/wx/rect.tex @@ -81,10 +81,27 @@ directions but if \arg{dir} includes only \texttt{wxVERTICAL} or only 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}} +\func{void}{Deflate}{\param{const wxSize\& }{diff}} + \func{void}{Deflate}{\param{wxCoord }{diff}} \constfunc{wxRect}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}} @@ -132,14 +149,29 @@ Gets the position. \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} -Gets 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} @@ -192,6 +224,8 @@ Gets the y member. \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}} @@ -234,20 +268,6 @@ means: \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. - -\constfunc{bool}{Inside}{\param{const wxRect\& }{rect}} - -Returns \true if the given rectangle is completely inside this rectangle -(or touches its boundary) and \false otherwise. - \membersection{wxRect::Intersects}\label{wxrectintersects} \constfunc{bool}{Intersects}{\param{const wxRect\& }{rect}} @@ -334,14 +354,32 @@ Assignment operator. \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} -\func{bool}{operator $!=$}{\param{const wxRect\& }{rect}} +\func{bool}{operator $!=$}{\param{const wxRect\& }{r1}, \param{const wxRect\& }{r2}} 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). +