wxPython documentation updates

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

diff --git a/docs/latex/wx/size.tex b/docs/latex/wx/size.tex
index 2f9579b6e1631da8ad5580e462551cbb02d98242..fdf44933670633375a8793577dc4579010790918 100644 (file)
--- a/docs/latex/wx/size.tex
+++ b/docs/latex/wx/size.tex
@@ -1,12 +1,25 @@
 \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.
 
-\wxheading{Derivation}
+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}
 
 None
 
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
 \wxheading{See also}
 
 \helpref{wxPoint}{wxpoint}, \helpref{wxRealPoint}{wxrealpoint}
@@ -17,39 +30,39 @@ 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}
+\membersection{wxSize::GetWidth}\label{wxsizegetwidth}
 
-\member{int}{x}
+\constfunc{int}{GetWidth}{\void}
 
-x member.
+Gets the width member.
 
-\membersection{wxSize::y}
+\membersection{wxSize::GetHeight}\label{wxsizegetheight}
 
-\member{int}{ y}
+\constfunc{int}{GetHeight}{\void}
 
-y member.
+Gets the height member.
 
-\membersection{wxSize::GetX}\label{wxsizegetx}
+\membersection{wxSize::Set}\label{wxsizeset}
 
-\constfunc{int}{GetX}{\void}
+\func{void}{Set}{\param{int}{ width}, \param{int}{ height}}
 
-Gets the x member.
+Sets the width and height members.
 
-\membersection{wxSize::GetY}\label{wxsizegety}
+\membersection{wxSize::SetHeight}\label{wxsizesetheight}
 
-\constfunc{int}{GetY}{\void}
+\func{void}{SetHeight}{\param{int}{ height}}
 
-Gets the y member.
+Sets the height.
 
-\membersection{wxSize::Set}\label{wxsizeset}
+\membersection{wxSize::SetWidth}\label{wxsizesetwidth}
 
-\func{void}{Set}{\param{int}{ x}, \param{int}{ y}}
+\func{void}{SetWidth}{\param{int}{ width}}
 
-Sets the x and y members.
+Sets the width.
 
 \membersection{wxSize::operator $=$}