X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..f973828cd9b31d3b80386fab5e6f7c4a106d97fc:/docs/latex/wx/size.tex?ds=sidebyside diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex index ef380c687c..738f5b2edd 100644 --- a/docs/latex/wx/size.tex +++ b/docs/latex/wx/size.tex @@ -1,7 +1,16 @@ \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. + +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} @@ -21,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} + + +\membersection{wxSize::GetWidth}\label{wxsizegetwidth} -x member. +\constfunc{int}{GetWidth}{\void} -\membersection{wxSize::y} +Gets the width member. -\member{int}{ y} +\membersection{wxSize::GetHeight}\label{wxsizegetheight} -y member. +\constfunc{int}{GetHeight}{\void} -\membersection{wxSize::GetX}\label{wxsizegetx} +Gets the height member. -\constfunc{int}{GetX}{\void} -Gets the x member. +\membersection{wxSize::IncTo}\label{wxsizeincto} -\membersection{wxSize::GetY}\label{wxsizegety} +\func{wxSize\&}{IncTo}{\param{const wxSize\& }{size}} -\constfunc{int}{GetY}{\void} +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 $=$}