X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/a89abd7f0c87793ec57ee793d2b38c4eba22ba4b..aea22172eff902cd6c1badf117c6c6564623938c:/docs/latex/wx/rect.tex diff --git a/docs/latex/wx/rect.tex b/docs/latex/wx/rect.tex index 8d86603975..729b214952 100644 --- a/docs/latex/wx/rect.tex +++ b/docs/latex/wx/rect.tex @@ -16,7 +16,8 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxRect::wxRect} + +\membersection{wxRect::wxRect}\label{wxrectctor} \func{}{wxRect}{\void} @@ -34,30 +35,39 @@ Creates a wxRect object from top-left and bottom-right points. Creates a wxRect object from position and size values. -\membersection{wxRect::x} +\func{}{wxRect}{\param{const wxSize\&}{ size}} + +Creates a wxRect object from size values at the origin. + + +\membersection{wxRect::x}\label{wxrectx} \member{int}{x} x coordinate of the top-level corner of the rectangle. -\membersection{wxRect::y} + +\membersection{wxRect::y}\label{wxrecty} \member{int}{y} y coordinate of the top-level corner of the rectangle. -\membersection{wxRect::width} + +\membersection{wxRect::width}\label{wxrectwidth} \member{int}{width} Width member. -\membersection{wxRect::height} + +\membersection{wxRect::height}\label{wxrectheight} \member{int}{height} Height member. + \membersection{wxRect::Deflate}\label{wxrectdeflate} \func{void}{Deflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}} @@ -79,66 +89,91 @@ new rectangle leaving this one unchanged. \helpref{Inflate}{wxrectinflate} + \membersection{wxRect::GetBottom}\label{wxrectgetbottom} \constfunc{int}{GetBottom}{\void} Gets the bottom point of the rectangle. + \membersection{wxRect::GetHeight}\label{wxrectgetheight} \constfunc{int}{GetHeight}{\void} Gets the height member. + \membersection{wxRect::GetLeft}\label{wxrectgetleft} \constfunc{int}{GetLeft}{\void} Gets the left point of the rectangle (the same as \helpref{wxRect::GetX}{wxrectgetx}). + \membersection{wxRect::GetPosition}\label{wxrectgetposition} \constfunc{wxPoint}{GetPosition}{\void} Gets the position. + +\membersection{wxRect::GetTopLeft}\label{wxrectgettopleft} + +\constfunc{wxPoint}{GetTopLeft}{\void} + +Gets the topleft position of the rectangle. (Same as GetPosition). + + +\membersection{wxRect::GetBottomRight}\label{wxrectgetbottomright} + +\constfunc{wxPoint}{GetBottomRight}{\void} + +Gets the the bottom right position. Returns the bottom right point inside the rectangle. + + \membersection{wxRect::GetRight}\label{wxrectgetright} \constfunc{int}{GetRight}{\void} Gets the right point of the rectangle. + \membersection{wxRect::GetSize}\label{wxrectgetsize} \constfunc{wxSize}{GetSize}{\void} Gets the size. + \membersection{wxRect::GetTop}\label{wxrectgettop} \constfunc{int}{GetTop}{\void} Gets the top point of the rectangle (the same as \helpref{wxRect::GetY}{wxrectgety}). + \membersection{wxRect::GetWidth}\label{wxrectgetwidth} \constfunc{int}{GetWidth}{\void} Gets the width member. + \membersection{wxRect::GetX}\label{wxrectgetx} \constfunc{int}{GetX}{\void} Gets the x member. + \membersection{wxRect::GetY}\label{wxrectgety} \constfunc{int}{GetY}{\void} Gets the y member. + \membersection{wxRect::Inflate}\label{wxrectinflate} \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}} @@ -160,7 +195,8 @@ new rectangle leaving this one unchanged. \helpref{Deflate}{wxrectdeflate} -\membersection{wxRect:Inside}\label{wxrectinside} + +\membersection{wxRect::Inside}\label{wxrectinside} \constfunc{bool}{Inside}{\param{int }{x}, \param{int }{y}} @@ -169,20 +205,14 @@ new rectangle leaving this one unchanged. Returns {\tt true} if the given point is inside the rectangle (or on its boundary) and {\tt false} otherwise. -\membersection{wxRect:Intersects}\label{wxrectintersects} + +\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::AlignIn}\label{wxrectalignin} - -\func{void}{AlignIn}{\param{const wxRect\& }{rect}, \param{int }{align}} - -Aligns the rectangle in another rectangle, according to the alignment flags. -Supports combinations of horizontal and vertical centering, plus left, right, -top and bottom justification. \membersection{wxRect::Offset}\label{wxrectoffset} @@ -194,43 +224,61 @@ 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}} Sets the height. + \membersection{wxRect::SetWidth}\label{wxrectsetwidth} \func{void}{SetWidth}{\param{int}{ width}} Sets the width. + \membersection{wxRect::SetX}\label{wxrectsetx} \func{void}{SetX}{\param{int}{ x}} Sets the x position. + \membersection{wxRect::SetY}\label{wxrectsety} \func{void}{SetY}{\param{int}{ y}} Sets the y position. -\membersection{wxRect::operator $=$} + +\membersection{wxRect::Union}\label{wxrectunion} + +\constfunc{wxRect}{Union}{\param{const wxRect\&}{ rect}} + +\func{wxRect\&}{Union}{\param{const wxRect\&}{ rect}} + +Modifies the rectangle to contain the bounding box of this rectangle and the +one passed in as parameter. The const version returns the new rectangle, the +other one modifies this rectangle in place. + + +\membersection{wxRect::operator $=$}\label{wxrectassign} \func{void}{operator $=$}{\param{const wxRect\& }{rect}} Assignment operator. -\membersection{wxRect::operator $==$} + +\membersection{wxRect::operator $==$}\label{wxrectequal} \func{bool}{operator $==$}{\param{const wxRect\& }{rect}} Equality operator. -\membersection{wxRect::operator $!=$} + +\membersection{wxRect::operator $!=$}\label{wxrectnotequal} \func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}