]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/point.tex
compilation fix for wxUSE_STL==1 in DoGetSibling()
[wxWidgets.git] / docs / latex / wx / point.tex
... / ...
CommitLineData
1%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
2%% Name: point.tex
3%% Purpose: wxPoint documentation
4%% Author: wxTeam
5%% Created:
6%% RCS-ID: $Id$
7%% Copyright: (c) wxTeam
8%% License: wxWindows license
9%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
10
11\section{\class{wxPoint}}\label{wxpoint}
12
13A {\bf wxPoint} is a useful data structure for graphics operations.
14It simply contains integer {\it x} and {\it y} members.
15
16See also \helpref{wxRealPoint}{wxrealpoint} for a floating point version.
17
18\wxheading{Derived from}
19
20None
21
22\wxheading{Include files}
23
24<wx/gdicmn.h>
25
26\wxheading{Library}
27
28\helpref{wxCore}{librarieslist}
29
30\wxheading{See also}
31
32\helpref{wxRealPoint}{wxrealpoint}
33
34\latexignore{\rtfignore{\wxheading{Members}}}
35
36\membersection{wxPoint::wxPoint}\label{wxpointctor}
37
38\func{}{wxPoint}{\void}
39
40\func{}{wxPoint}{\param{int}{ x}, \param{int}{ y}}
41
42Create a point.
43
44\membersection{wxPoint::x}\label{wxpointx}
45
46\member{int}{x}
47
48x member.
49
50\membersection{wxPoint::y}\label{wxpointy}
51
52\member{int}{ y}
53
54y member.
55
56\membersection{Operators}\label{wxpointoperators}
57
58\func{void}{operator $=$}{\param{const wxPoint\& }{pt}}
59
60Assignment operator.
61
62
63\func{bool}{operator $==$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
64
65\func{bool}{operator $!=$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
66
67\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
68
69\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{p1}, \param{const wxPoint\& }{p2}}
70
71\func{wxPoint\&}{operator $+=$}{\param{const wxPoint\& }{pt}}
72
73\func{wxPoint\&}{operator $-=$}{\param{const wxPoint\& }{pt}}
74
75Operators for comparison, sum and subtraction between \helpref{wxPoint}{wxpoint} objects.
76
77
78\func{wxPoint}{operator $+$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
79
80\func{wxPoint}{operator $-$}{\param{const wxPoint\& }{pt}, \param{const wxSize\& }{sz}}
81
82\func{wxPoint}{operator $+$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}
83
84\func{wxPoint}{operator $-$}{\param{const wxSize\& }{sz}, \param{const wxPoint\& }{pt}}
85
86\func{wxPoint\&}{operator $+=$}{\param{const wxSize\& }{sz}}
87
88\func{wxPoint\&}{operator $-=$}{\param{const wxSize\& }{sz}}
89
90Operators for sum and subtraction between a \helpref{wxPoint}{wxpoint} object and a
91\helpref{wxSize}{wxsize} object.
92