X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/43e8916ff3fd271e55c9daa6660cb8ea5ff7efe6..15f7c30516facfb272fc116aec4d3f9c3a9de085:/docs/latex/wx/rect.tex diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex index 30cba05bf7..b762d63a6c 100644 --- a/docs/latex/wx/rect.tex +++ b/docs/latex/wx/rect.tex @@ -10,6 +10,10 @@ None +\wxheading{Library} + +\helpref{wxCore}{librarieslist} + \wxheading{See also} \helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize} @@ -68,10 +72,40 @@ Width 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}} +\func{void}{Deflate}{\param{const wxSize\& }{diff}} + \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} -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} @@ -179,6 +228,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}} @@ -221,21 +272,11 @@ 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. - - \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 +Returns {\tt true} if this rectangle has a non-empty intersection with the rectangle {\it rect} and {\tt false} otherwise. @@ -317,14 +358,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). +