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

\section{\class{wxRect}}\label{wxrect}

A class for manipulating rectangles.

\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{See also}

\helpref{wxPoint}{wxpoint}, \helpref{wxSize}{wxsize}

\latexignore{\rtfignore{\wxheading{Members}}}

\membersection{wxRect::wxRect}

\func{}{wxRect}{\void}

Default constructor.

\func{}{wxRect}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}}

Creates a wxRect object from x, y, width and height values.

\func{}{wxRect}{\param{const wxPoint\&}{ topLeft}, \param{const wxPoint\&}{ bottomRight}}

Creates a wxRect object from top-left and bottom-right points.

\func{}{wxRect}{\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size}}

Creates a wxRect object from position and size values.

\membersection{wxRect::x}

\member{int}{x}

x member.

\membersection{wxRect::y}

\member{int}{y}

y member.

\membersection{wxRect::width}

\member{int}{width}

Width member.

\membersection{wxRect::height}

\member{int}{height}

Height member.

\membersection{wxRect::GetBottom}\label{wxrectgetbottom}

\constfunc{int}{GetBottom}{\void}

Gets the bottom point of the rectangle.

\membersection{wxRect::GetHeight}\label{wxrectgetheight}

\constfunc{int}{GetHeight}{\void}

Gets the height member.

\membersection{wxRect::GetLeft}\label{wxrectgetleft}

\constfunc{int}{GetLeft}{\void}

Gets the left point of the rectangle (the same as \helpref{wxRect::GetX}{wxrectgetx}).

\membersection{wxRect::GetPosition}\label{wxrectgetposition}

\constfunc{wxPoint}{GetPosition}{\void}

Gets the position.

\membersection{wxRect::GetRight}\label{wxrectgetright}

\constfunc{int}{GetRight}{\void}

Gets the right point of the rectangle.

\membersection{wxRect::GetSize}\label{wxrectgetsize}

\constfunc{wxSize}{GetSize}{\void}

Gets the size.

\membersection{wxRect::GetTop}\label{wxrectgettop}

\constfunc{int}{GetTop}{\void}

Gets the top point of the rectangle (the same as \helpref{wxRect::GetY}{wxrectgety}).

\membersection{wxRect::GetWidth}\label{wxrectgetwidth}

\constfunc{int}{GetWidth}{\void}

Gets the width member.

\membersection{wxRect::GetX}\label{wxrectgetx}

\constfunc{int}{GetX}{\void}

Gets the x member.

\membersection{wxRect::GetY}\label{wxrectgety}

\constfunc{int}{GetY}{\void}

Gets the y member.

\membersection{wxRect::SetHeight}\label{wxrectsetheight}

\func{void}{SetHeight}{\param{int}{ height}}

Sets the height.

\membersection{wxRect::SetWidth}\label{wxrectsetwidth}

\func{void}{SetWidth}{\param{int}{ width}}

Sets the width.

\membersection{wxRect::SetX}\label{wxrectsetx}

\func{void}{SetX}{\param{int}{ x}}

Sets the x position.

\membersection{wxRect::SetY}\label{wxrectsety}

\func{void}{SetY}{\param{int}{ y}}

Sets the y position.

\membersection{wxRect::operator $=$}

\func{void}{operator $=$}{\param{const wxRect\& }{rect}}

Assignment operator.

\membersection{wxRect::operator $==$}

\func{bool}{operator $==$}{\param{const wxRect\& }{rect}}

Equality operator.

\membersection{wxRect::operator $!=$}

\func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}

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