added null pointer check and assert

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

diff --git a/docs/latex/wx/point.tex b/docs/latex/wx/point.tex
index 1d6f9042a53376a3dafe5c5bd627a288b5a68a76..e13fcda20fc4d5038099545cf8f6e6225d35fe95 100644 (file)
--- a/docs/latex/wx/point.tex
+++ b/docs/latex/wx/point.tex
@@ -1,3 +1,13 @@
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% Name:        point.tex
+%% Purpose:     wxPoint documentation
+%% Author:      wxTeam
+%% Created:
+%% RCS-ID:      $Id$
+%% Copyright:   (c) wxTeam
+%% License:     wxWindows license
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+

 \section{\class{wxPoint}}\label{wxpoint}
 
 A {\bf wxPoint} is a useful data structure for graphics operations.
 \section{\class{wxPoint}}\label{wxpoint}
 
 A {\bf wxPoint} is a useful data structure for graphics operations.


@@ -13,6 +23,10 @@ None
 
 <wx/gdicmn.h>
 
 
 <wx/gdicmn.h>
 

+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+

 \wxheading{See also}
 
 \helpref{wxRealPoint}{wxrealpoint}
 \wxheading{See also}
 
 \helpref{wxRealPoint}{wxrealpoint}


@@ -39,16 +53,40 @@ x member.
 
 y member.
 
 
 y member.
 

-\membersection{wxPoint::operator $==$}\label{wxpointequal}
+\membersection{Operators}\label{wxpointoperators}
+
+\func{void}{operator $=$}{\param{const wxPoint\& }{pt}}
+
+Assignment operator.
+
+
+\func{bool}{operator $==$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
+
+\func{bool}{operator $!=$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
+
+\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
+
+\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
+
+\func{wxPoint\&}{operator $+=$}{\param{const wxPoint\& }{pt}}
+
+\func{wxPoint\&}{operator $-=$}{\param{const wxPoint\& }{pt}}
+
+Operators for comparison, sum and subtraction between \helpref{wxPoint}{wxpoint} objects.
+
+
+\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}

 
 

-\func{bool}{operator $==$}{\param{const wxPoint\& }{pt}}
+\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}

 
 

-Equality operator: returns \true if two points are the same.
+\func{wxPoint}{operator $+$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}

 
 

+\func{wxPoint}{operator $-$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}

 
 

-\membersection{wxPoint::operator $!=$}\label{wxpointnotequal}
+\func{wxPoint\&}{operator $+=$}{\param{const wxSize\& }{sz}}

 
 

-\func{bool}{operator $!=$}{\param{const wxPoint\& }{pt}}
+\func{wxPoint\&}{operator $-=$}{\param{const wxSize\& }{sz}}

 
 

-Inequality operator: returns \true if two points are different.
+Operators for sum and subtraction between a \helpref{wxPoint}{wxpoint} object and a
+\helpref{wxSize}{wxsize} object.