]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/rect.tex
minor corrections and note about Unicode (patch 1555691)
[wxWidgets.git] / docs / latex / wx / rect.tex
index 44239884dd02cac10958f9152384307291856765..f94ab4fc958d06f4952577fba6680b2b9c2a9960 100644 (file)
@@ -68,6 +68,19 @@ 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::Deflate}\label{wxrectdeflate}
 
 \func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
@@ -126,7 +139,7 @@ Gets the topleft position of the rectangle. (Same as GetPosition).
 
 \constfunc{wxPoint}{GetBottomRight}{\void}
 
-Gets the the bottom right position. Returns the bottom right point inside the rectangle.
+Gets the bottom right position. Returns the bottom right point inside the rectangle.
 
 
 \membersection{wxRect::GetRight}\label{wxrectgetright}
@@ -142,6 +155,10 @@ Gets the right point of the rectangle.
 
 Gets the size.
 
+\wxheading{See also}
+
+\helpref{wxRect::SetSize}{wxrectsetsize}
+
 
 \membersection{wxRect::GetTop}\label{wxrectgettop}
 
@@ -226,15 +243,27 @@ means:
 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}}
 
-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.
 
 
+\membersection{wxRect::IsEmpty}\label{wxrectisempty}
+
+\constfunc{bool}{IsEmpty}{}
+
+Returns {\tt true} if this rectangle has a width or height less than or equal to 
+0 and {\tt false} otherwise.
+
+
 \membersection{wxRect::Offset}\label{wxrectoffset}
 
 \func{void}{Offset}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
@@ -253,6 +282,17 @@ bottom, otherwise it is moved to the left or top respectively.
 Sets the height.
 
 
+\membersection{wxRect::SetSize}\label{wxrectsetsize}
+
+\func{void}{SetSize}{\param{const wxSize\&}{ s}}
+
+Sets the size.
+
+\wxheading{See also}
+
+\helpref{wxRect::GetSize}{wxrectgetsize}
+
+
 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 
 \func{void}{SetWidth}{\param{int}{ width}}