X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9838df2cefc5b368bb11f98c784ecc78f45ecaf7..f973828cd9b31d3b80386fab5e6f7c4a106d97fc:/docs/latex/wx/size.tex diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex index 2f9579b6e1..738f5b2edd 100644 --- a/docs/latex/wx/size.tex +++ b/docs/latex/wx/size.tex @@ -1,12 +1,25 @@ \section{\class{wxSize}}\label{wxsize} A {\bf wxSize} is a useful data structure for graphics operations. -It simply contains integer {\it x} and {\it y} members. +It simply contains integer {\it width} and {\it height} members. -\wxheading{Derivation} +wxSize is used throughout wxWindows as well as wxPoint which, although almost +equivalent to wxSize, has a different meaning: wxPoint represents a position +while wxSize - the size. + +\pythonnote{wxPython defines aliases for the {\tt x} and {\tt y} members +named {\tt width} and {\tt height} since it makes much more sense for +sizes. +} + +\wxheading{Derived from} None +\wxheading{Include files} + + + \wxheading{See also} \helpref{wxPoint}{wxpoint}, \helpref{wxRealPoint}{wxrealpoint} @@ -17,39 +30,65 @@ None \func{}{wxSize}{\void} -\func{}{wxSize}{\param{int}{ x}, \param{int}{ y}} +\func{}{wxSize}{\param{int}{ width}, \param{int}{ height}} Creates a size object. -\membersection{wxSize::x} -\member{int}{x} +\membersection{wxSize::DecTo}\label{wxsizedecto} + +\func{wxSize\&}{DecTo}{\param{const wxSize\& }{size}} + +Decrements this object so that both of its dimensions are not greater than the +corresponding dimensions of the \arg{size}. + +\wxheading{See also} + +\helpref{IncTo}{wxsizeincto} + -x member. +\membersection{wxSize::GetWidth}\label{wxsizegetwidth} -\membersection{wxSize::y} +\constfunc{int}{GetWidth}{\void} -\member{int}{ y} +Gets the width member. -y member. +\membersection{wxSize::GetHeight}\label{wxsizegetheight} -\membersection{wxSize::GetX}\label{wxsizegetx} +\constfunc{int}{GetHeight}{\void} -\constfunc{int}{GetX}{\void} +Gets the height member. -Gets the x member. -\membersection{wxSize::GetY}\label{wxsizegety} +\membersection{wxSize::IncTo}\label{wxsizeincto} -\constfunc{int}{GetY}{\void} +\func{wxSize\&}{IncTo}{\param{const wxSize\& }{size}} + +Increments this object so that both of its dimensions are not less than the +corresponding dimensions of the \arg{size}. + +\wxheading{See also} + +\helpref{DecTo}{wxsizedecto} -Gets the y member. \membersection{wxSize::Set}\label{wxsizeset} -\func{void}{Set}{\param{int}{ x}, \param{int}{ y}} +\func{void}{Set}{\param{int}{ width}, \param{int}{ height}} + +Sets the width and height members. + +\membersection{wxSize::SetHeight}\label{wxsizesetheight} + +\func{void}{SetHeight}{\param{int}{ height}} + +Sets the height. + +\membersection{wxSize::SetWidth}\label{wxsizesetwidth} + +\func{void}{SetWidth}{\param{int}{ width}} -Sets the x and y members. +Sets the width. \membersection{wxSize::operator $=$}