X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/7b0c238d4a82d0b6553b6a06f4fbc218cb94d3dd..81c882b613b5d99ddb1e5ab69fcd7ebccc287025:/docs/latex/wx/size.tex diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex index 0742609895..69d051bba5 100644 --- a/docs/latex/wx/size.tex +++ b/docs/latex/wx/size.tex @@ -1,9 +1,19 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% Name: size.tex +%% Purpose: wxSize documentation +%% Author: wxTeam +%% Created: +%% RCS-ID: $Id$ +%% Copyright: (c) wxTeam +%% License: wxWindows license +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% + \section{\class{wxSize}}\label{wxsize} A {\bf wxSize} is a useful data structure for graphics operations. It simply contains integer {\it width} and {\it height} members. -wxSize is used throughout wxWindows as well as wxPoint which, although almost +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. @@ -27,7 +37,7 @@ None \latexignore{\rtfignore{\wxheading{Members}}} -\membersection{wxSize::wxSize} +\membersection{wxSize::wxSize}\label{wxsizector} \func{}{wxSize}{\void} @@ -37,9 +47,30 @@ Creates a size object. +\membersection{wxSize::DecBy}\label{wxsizedecby} + +\func{void}{DecBy}{\param{const wxSize\& }{size}} + +\func{void}{DecBy}{\param{int }{dx}, \param{int }{dy}} + +\func{void}{DecBy}{\param{int }{d}} + +Decreases the size in x- and y- directions + +\begin{enumerate} + \item By \arg{size.x} and \arg{size.y} for the first overload + \item By \arg{dx} and \arg{dy} for the second one + \item By \arg{d} and \arg{d} for the third one +\end{enumerate} + +\wxheading{See also} + +\helpref{IncBy}{wxsizeincby} + + \membersection{wxSize::DecTo}\label{wxsizedecto} -\func{wxSize\&}{DecTo}{\param{const wxSize\& }{size}} +\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}. @@ -54,10 +85,10 @@ corresponding dimensions of the \arg{size}. \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 wxWindows (hence the predefined +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 +This method is typically used before calling \helpref{SetDefaults}{wxsizesetdefaults}. @@ -75,10 +106,30 @@ Gets the width member. Gets the height member. +\membersection{wxSize::IncBy}\label{wxsizeincby} + +\func{void}{IncBy}{\param{const wxSize\& }{size}} + +\func{void}{IncBy}{\param{int }{dx}, \param{int }{dy}} + +\func{void}{IncBy}{\param{int }{d}} + +Increases the size in x- and y- directions + +\begin{enumerate} + \item By \arg{size.x} and \arg{size.y} for the first overload + \item By \arg{dx} and \arg{dy} for the second one + \item By \arg{d} and \arg{d} for the third one +\end{enumerate} + +\wxheading{See also} + +\helpref{DecBy}{wxsizedecby} + \membersection{wxSize::IncTo}\label{wxsizeincto} -\func{wxSize\&}{IncTo}{\param{const wxSize\& }{size}} +\func{void}{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}. @@ -89,6 +140,17 @@ corresponding dimensions of the \arg{size}. +\membersection{wxSize::Scale}\label{wxsizescale} + +\func{wxSize\&}{Scale}{\param{float}{ xscale}, \param{float}{ yscale}} + +Scales the dimensions of this object by the given factors. +If you want to scale both dimensions by the same factor you can also use +the \helpref{operator *=}{wxsizeoperators} + +Returns a reference to this object (so that you can concatenate other operations in the same line). + + \membersection{wxSize::Set}\label{wxsizeset} \func{void}{Set}{\param{int}{ width}, \param{int}{ height}} @@ -129,10 +191,37 @@ Sets the height. Sets the width. -\membersection{wxSize::operator $=$} +\membersection{Operators}\label{wxsizeoperators} \func{void}{operator $=$}{\param{const wxSize\& }{sz}} Assignment operator. +\func{bool}{operator $==$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}} + +\func{bool}{operator $!=$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}} + +\func{wxSize}{operator $+$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}} + +\func{wxSize}{operator $-$}{\param{const wxSize\& }{s1}, \param{const wxSize\& }{s2}} + +\func{wxSize\&}{operator $+=$}{\param{const wxSize\& }{sz}} + +\func{wxSize\&}{operator $-=$}{\param{const wxSize\& }{sz}} + +Operators for comparison, sum and subtraction between \helpref{wxSize}{wxsize} objects. + + +\func{wxSize}{operator $/$}{\param{const wxSize\& }{sz}, \param{int }{factor}} + +\func{wxSize}{operator $*$}{\param{const wxSize\& }{sz}, \param{int }{factor}} + +\func{wxSize}{operator $*$}{\param{int }{factor}, \param{const wxSize\& }{sz}} + +\func{wxSize\&}{operator $/=$}{\param{int }{factor}} + +\func{wxSize\&}{operator $*=$}{\param{int }{factor}} + +Operators for division and multiplication between a \helpref{wxSize}{wxsize} object and an integer. +