added alpha support to wxCocoa, also fixed compilation after alpha changes hopefully

[wxWidgets.git] / docs / latex / wx / size.tex

diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex
index 22bf9c998c91d8370b4ea1a9b83a945e6ba69e74..cbffe75fd10485e0b0093657ce4d13846d87049c 100644 (file)
--- 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.
 
 \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.
 
 equivalent to wxSize, has a different meaning: wxPoint represents a position
 while wxSize - the size.
 


@@ -27,7 +37,7 @@ None
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 

-\membersection{wxSize::wxSize}
+\membersection{wxSize::wxSize}\label{wxsizector}

 
 \func{}{wxSize}{\void}
 
 
 \func{}{wxSize}{\void}
 


@@ -39,7 +49,7 @@ Creates a size object.
 
 \membersection{wxSize::DecTo}\label{wxsizedecto}
 
 
 \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}.
 
 Decrements this object so that both of its dimensions are not greater than the
 corresponding dimensions of the \arg{size}.


@@ -51,13 +61,13 @@ corresponding dimensions of the \arg{size}.
 
 \membersection{wxSize::IsFullySpecified}\label{wxsizeisfullyspecified}
 
 
 \membersection{wxSize::IsFullySpecified}\label{wxsizeisfullyspecified}
 

-\constfunc{IsFullySpecified}{\void}
+\constfunc{bool}{IsFullySpecified}{\void}

 
 Returns \true if neither of the size object components is equal to $-1$, which
 
 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$).
 
 \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}.
 
 
 \helpref{SetDefaults}{wxsizesetdefaults}.
 
 


@@ -78,7 +88,7 @@ Gets the height member.
 
 \membersection{wxSize::IncTo}\label{wxsizeincto}
 
 
 \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}.
 
 Increments this object so that both of its dimensions are not less than the
 corresponding dimensions of the \arg{size}.


@@ -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}}
 \membersection{wxSize::Set}\label{wxsizeset}
 
 \func{void}{Set}{\param{int}{ width}, \param{int}{ height}}


@@ -129,10 +149,34 @@ Sets the height.
 Sets the width.
 
 
 Sets the width.
 
 

-\membersection{wxSize::operator $=$}
+\membersection{Operators}\label{wxsizeoperators}

 
 \func{void}{operator $=$}{\param{const wxSize\& }{sz}}
 
 Assignment operator.
 
 
 
 \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.