]> git.saurik.com Git - wxWidgets.git/blame_incremental - docs/latex/wx/rect.tex
Corrected event.h for wxKeyEvent/wxMouseEvent, and corresponding docs
[wxWidgets.git] / docs / latex / wx / rect.tex
... / ...
CommitLineData
1\section{\class{wxRect}}\label{wxrect}
2
3A class for manipulating rectangles.
4
5\wxheading{Derived from}
6
7None
8
9\wxheading{Include files}
10
11<wx/gdicmn.h>
12
13\wxheading{See also}
14
15\helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize}
16
17\latexignore{\rtfignore{\wxheading{Members}}}
18
19\membersection{wxRect::wxRect}
20
21\func{}{wxRect}{\void}
22
23Default constructor.
24
25\func{}{wxRect}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}}
26
27Creates a wxRect object from x, y, width and height values.
28
29\func{}{wxRect}{\param{const wxPoint\&}{ topLeft}, \param{const wxPoint\&}{ bottomRight}}
30
31Creates a wxRect object from top-left and bottom-right points.
32
33\func{}{wxRect}{\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size}}
34
35Creates a wxRect object from position and size values.
36
37\membersection{wxRect::x}
38
39\member{int}{x}
40
41x member.
42
43\membersection{wxRect::y}
44
45\member{int}{y}
46
47y member.
48
49\membersection{wxRect::width}
50
51\member{int}{width}
52
53Width member.
54
55\membersection{wxRect::height}
56
57\member{int}{height}
58
59Height member.
60
61\membersection{wxRect::GetBottom}\label{wxrectgetbottom}
62
63\constfunc{int}{GetBottom}{\void}
64
65Gets the bottom point of the rectangle.
66
67\membersection{wxRect::GetHeight}\label{wxrectgetheight}
68
69\constfunc{int}{GetHeight}{\void}
70
71Gets the height member.
72
73\membersection{wxRect::GetLeft}\label{wxrectgetleft}
74
75\constfunc{int}{GetLeft}{\void}
76
77Gets the left point of the rectangle (the same as \helpref{wxRect::GetX}{wxrectgetx}).
78
79\membersection{wxRect::GetPosition}\label{wxrectgetposition}
80
81\constfunc{wxPoint}{GetPosition}{\void}
82
83Gets the position.
84
85\membersection{wxRect::GetRight}\label{wxrectgetright}
86
87\constfunc{int}{GetRight}{\void}
88
89Gets the right point of the rectangle.
90
91\membersection{wxRect::GetSize}\label{wxrectgetsize}
92
93\constfunc{wxSize}{GetSize}{\void}
94
95Gets the size.
96
97\membersection{wxRect::GetTop}\label{wxrectgettop}
98
99\constfunc{int}{GetTop}{\void}
100
101Gets the top point of the rectangle (the same as \helpref{wxRect::GetY}{wxrectgety}).
102
103\membersection{wxRect::GetWidth}\label{wxrectgetwidth}
104
105\constfunc{int}{GetWidth}{\void}
106
107Gets the width member.
108
109\membersection{wxRect::GetX}\label{wxrectgetx}
110
111\constfunc{int}{GetX}{\void}
112
113Gets the x member.
114
115\membersection{wxRect::GetY}\label{wxrectgety}
116
117\constfunc{int}{GetY}{\void}
118
119Gets the y member.
120
121\membersection{wxRect::SetHeight}\label{wxrectsetheight}
122
123\func{void}{SetHeight}{\param{int}{ height}}
124
125Sets the height.
126
127\membersection{wxRect::SetWidth}\label{wxrectsetwidth}
128
129\func{void}{SetWidth}{\param{int}{ width}}
130
131Sets the width.
132
133\membersection{wxRect::SetX}\label{wxrectsetx}
134
135\func{void}{SetX}{\param{int}{ x}}
136
137Sets the x position.
138
139\membersection{wxRect::SetY}\label{wxrectsety}
140
141\func{void}{SetY}{\param{int}{ y}}
142
143Sets the y position.
144
145\membersection{wxRect::operator $=$}
146
147\func{void}{operator $=$}{\param{const wxRect\& }{rect}}
148
149Assignment operator.
150
151\membersection{wxRect::operator $==$}
152
153\func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
154
155Equality operator.
156
157\membersection{wxRect::operator $!=$}
158
159\func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
160
161Inequality operator.
162
163