]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/point.tex
added vendor display name (for consistency with app display name &c) (patch 1831303)
[wxWidgets.git] / docs / latex / wx / point.tex
index 056b85c451e7fc0da3a37330416cb771e65a96d7..e13fcda20fc4d5038099545cf8f6e6225d35fe95 100644 (file)
@@ -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.
@@ -5,17 +15,25 @@ It simply contains integer {\it x} and {\it y} members.
 
 See also \helpref{wxRealPoint}{wxrealpoint} for a floating point version.
 
-\wxheading{Derivation}
+\wxheading{Derived from}
 
 None
 
+\wxheading{Include files}
+
+<wx/gdicmn.h>
+
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{See also}
 
 \helpref{wxRealPoint}{wxrealpoint}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxPoint::wxPoint}
+\membersection{wxPoint::wxPoint}\label{wxpointctor}
 
 \func{}{wxPoint}{\void}
 
@@ -23,15 +41,52 @@ None
 
 Create a point.
 
-\membersection{wxPoint::x}
+\membersection{wxPoint::x}\label{wxpointx}
 
 \member{int}{x}
 
 x member.
 
-\membersection{wxPoint::y}
+\membersection{wxPoint::y}\label{wxpointy}
 
 \member{int}{ y}
 
 y member.
 
+\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{wxPoint}{operator $-$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
+
+\func{wxPoint}{operator $+$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}
+
+\func{wxPoint}{operator $-$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}
+
+\func{wxPoint\&}{operator $+=$}{\param{const wxSize\& }{sz}}
+
+\func{wxPoint\&}{operator $-=$}{\param{const wxSize\& }{sz}}
+
+Operators for sum and subtraction between a \helpref{wxPoint}{wxpoint} object and a
+\helpref{wxSize}{wxsize} object.
+