X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/9a75ba66de8f9dd3ebac0f41ec2e27be6d95aa73..a1a77e0c4b7bb9c4afc2acc3b9fd6f8e27baddc1:/docs/latex/wx/size.tex diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex index b1376b4f21..cbffe75fd1 100644 --- a/docs/latex/wx/size.tex +++ b/docs/latex/wx/size.tex @@ -1,3 +1,13 @@ +%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% +%% 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. @@ -54,10 +64,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 wxWidgets (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}. @@ -89,6 +99,16 @@ corresponding dimensions of the \arg{size}. +\membersection{wxSize::Scale}\label{wxsizescale} + +\func{void}{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} + + + \membersection{wxSize::Set}\label{wxsizeset} \func{void}{Set}{\param{int}{ width}, \param{int}{ height}} @@ -129,10 +149,34 @@ Sets the height. Sets the width. -\membersection{wxSize::operator $=$}\label{wxsizeassign} +\membersection{Operators}\label{wxsizeoperators} \func{void}{operator $=$}{\param{const wxSize\& }{sz}} Assignment operator. +\func{bool}{operator $==$}{\param{const wxSize\& }{sz}} + +\func{bool}{operator $!=$}{\param{const wxSize\& }{sz}} + +\func{wxSize}{operator $+$}{\param{const wxSize\& }{sz}} + +\func{wxSize}{operator $-$}{\param{const wxSize\& }{sz}} + +\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{int }{factor}} + +\func{wxSize}{operator $*$}{\param{int }{factor}} + +\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.