X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/954b8ae60391d18b87a604e7919c87c0c6ae208b..852b6c3ce7baa055da25f5254f6ee2eee0cd79b7:/docs/latex/wx/size.tex diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex index ef380c687c..b1376b4f21 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 wxWidgets 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} @@ -17,45 +26,110 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxSize::wxSize} + +\membersection{wxSize::wxSize}\label{wxsizector} \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} -x member. +\membersection{wxSize::DecTo}\label{wxsizedecto} + +\func{void}{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::IsFullySpecified}\label{wxsizeisfullyspecified} + +\constfunc{bool}{IsFullySpecified}{\void} + +Returns \true if neither of the size object components is equal to $-1$, which +is used as default for the size values in wxWidgets (hence the predefined +\texttt{wxDefaultSize} has both of its components equal to $-1$). + +This method is typically used before calling +\helpref{SetDefaults}{wxsizesetdefaults}. + + +\membersection{wxSize::GetWidth}\label{wxsizegetwidth} + +\constfunc{int}{GetWidth}{\void} + +Gets the width member. + + +\membersection{wxSize::GetHeight}\label{wxsizegetheight} -\membersection{wxSize::y} +\constfunc{int}{GetHeight}{\void} -\member{int}{ y} +Gets the height member. -y member. -\membersection{wxSize::GetX}\label{wxsizegetx} -\constfunc{int}{GetX}{\void} +\membersection{wxSize::IncTo}\label{wxsizeincto} -Gets the x member. +\func{void}{IncTo}{\param{const wxSize\& }{size}} -\membersection{wxSize::GetY}\label{wxsizegety} +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} -\constfunc{int}{GetY}{\void} -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::SetDefaults}\label{wxsizesetdefaults} + +\func{void}{SetDefaults}{\param{const wxSize\& }{sizeDefault}} + +Combine this size object with another one replacing the default (i.e. equal +to $-1$) components of this object with those of the other. It is typically +used like this: +\begin{verbatim} + if ( !size.IsFullySpecified() ) + { + size.SetDefaults(GetDefaultSize()); + } +\end{verbatim} + +\wxheading{See also} + +\helpref{IsFullySpecified}{wxsizeisfullyspecified} + + +\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 width. -Sets the x and y members. -\membersection{wxSize::operator $=$} +\membersection{wxSize::operator $=$}\label{wxsizeassign} \func{void}{operator $=$}{\param{const wxSize\& }{sz}}