]>
Commit | Line | Data |
---|---|---|
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 | ||
13 | A {\bf wxPoint} is a useful data structure for graphics operations. | |
14 | It simply contains integer {\it x} and {\it y} members. | |
15 | ||
16 | See also \helpref{wxRealPoint}{wxrealpoint} for a floating point version. | |
17 | ||
18 | \wxheading{Derived from} | |
19 | ||
20 | None | |
21 | ||
22 | \wxheading{Include files} | |
23 | ||
24 | <wx/gdicmn.h> | |
25 | ||
26 | \wxheading{See also} | |
27 | ||
28 | \helpref{wxRealPoint}{wxrealpoint} | |
29 | ||
30 | \latexignore{\rtfignore{\wxheading{Members}}} | |
31 | ||
32 | \membersection{wxPoint::wxPoint}\label{wxpointctor} | |
33 | ||
34 | \func{}{wxPoint}{\void} | |
35 | ||
36 | \func{}{wxPoint}{\param{int}{ x}, \param{int}{ y}} | |
37 | ||
38 | Create a point. | |
39 | ||
40 | \membersection{wxPoint::x}\label{wxpointx} | |
41 | ||
42 | \member{int}{x} | |
43 | ||
44 | x member. | |
45 | ||
46 | \membersection{wxPoint::y}\label{wxpointy} | |
47 | ||
48 | \member{int}{ y} | |
49 | ||
50 | y member. | |
51 | ||
52 | \membersection{Operators}\label{wxpointoperators} | |
53 | ||
54 | \func{void}{operator $=$}{\param{const wxPoint\& }{pt}} | |
55 | ||
56 | Assignment operator. | |
57 | ||
58 | ||
59 | \func{bool}{operator $==$}{\param{const wxPoint\& }{pt}} | |
60 | ||
61 | \func{bool}{operator $!=$}{\param{const wxPoint\& }{pt}} | |
62 | ||
63 | \func{wxPoint}{operator $+$}{\param{const wxPoint\& }{pt}} | |
64 | ||
65 | \func{wxPoint}{operator $-$}{\param{const wxPoint\& }{pt}} | |
66 | ||
67 | \func{wxPoint\&}{operator $+=$}{\param{const wxPoint\& }{pt}} | |
68 | ||
69 | \func{wxPoint\&}{operator $-=$}{\param{const wxPoint\& }{pt}} | |
70 | ||
71 | Operators for comparison, sum and subtraction between \helpref{wxPoint}{wxpoint} objects. | |
72 | ||
73 | ||
74 | \func{wxPoint}{operator $+$}{\param{const wxSize\& }{sz}} | |
75 | ||
76 | \func{wxPoint}{operator $-$}{\param{const wxSize\& }{sz}} | |
77 | ||
78 | \func{wxPoint\&}{operator $+=$}{\param{const wxSize\& }{sz}} | |
79 | ||
80 | \func{wxPoint\&}{operator $-=$}{\param{const wxSize\& }{sz}} | |
81 | ||
82 | Operators for sum and subtraction between a \helpref{wxPoint}{wxpoint} object and a | |
83 | \helpref{wxSize}{wxsize} object. |