docs/latex/wx/rect.tex

   1 \section{\class{wxRect}}\label{wxrect}
   2
   3 A class for manipulating rectangles.
   4
   5 \wxheading{Derived from}
   6
   7 None
   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
  23 Default constructor.
  24
  25 \func{}{wxRect}{\param{int}{ x}, \param{int}{ y}, \param{int}{ width}, \param{int}{ height}}
  26
  27 Creates a wxRect object from x, y, width and height values.
  28
  29 \func{}{wxRect}{\param{const wxPoint\&}{ topLeft}, \param{const wxPoint\&}{ bottomRight}}
  30
  31 Creates a wxRect object from top-left and bottom-right points.
  32
  33 \func{}{wxRect}{\param{const wxPoint\&}{ pos}, \param{const wxSize\&}{ size}}
  34
  35 Creates a wxRect object from position and size values.
  36
  37 \membersection{wxRect::x}
  38
  39 \member{int}{x}
  40
  41 x coordinate of the top-level corner of the rectangle.
  42
  43 \membersection{wxRect::y}
  44
  45 \member{int}{y}
  46
  47 y coordinate of the top-level corner of the rectangle.
  48
  49 \membersection{wxRect::width}
  50
  51 \member{int}{width}
  52
  53 Width member.
  54
  55 \membersection{wxRect::height}
  56
  57 \member{int}{height}
  58
  59 Height member.
  60
  61 \membersection{wxRect::GetBottom}\label{wxrectgetbottom}
  62
  63 \constfunc{int}{GetBottom}{\void}
  64
  65 Gets the bottom point of the rectangle.
  66
  67 \membersection{wxRect::GetHeight}\label{wxrectgetheight}
  68
  69 \constfunc{int}{GetHeight}{\void}
  70
  71 Gets the height member.
  72
  73 \membersection{wxRect::GetLeft}\label{wxrectgetleft}
  74
  75 \constfunc{int}{GetLeft}{\void}
  76
  77 Gets 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
  83 Gets the position.
  84
  85 \membersection{wxRect::GetRight}\label{wxrectgetright}
  86
  87 \constfunc{int}{GetRight}{\void}
  88
  89 Gets the right point of the rectangle.
  90
  91 \membersection{wxRect::GetSize}\label{wxrectgetsize}
  92
  93 \constfunc{wxSize}{GetSize}{\void}
  94
  95 Gets the size.
  96
  97 \membersection{wxRect::GetTop}\label{wxrectgettop}
  98
  99 \constfunc{int}{GetTop}{\void}
 100
 101 Gets 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
 107 Gets the width member.
 108
 109 \membersection{wxRect::GetX}\label{wxrectgetx}
 110
 111 \constfunc{int}{GetX}{\void}
 112
 113 Gets the x member.
 114
 115 \membersection{wxRect::GetY}\label{wxrectgety}
 116
 117 \constfunc{int}{GetY}{\void}
 118
 119 Gets the y member.
 120
 121 \membersection{wxRect::Inflate}\label{wxrectinflate}
 122
 123 \func{void}{Inflate}{\param{wxCoord }{dx}, \param{wxCoord }{dy}}
 124
 125 \func{void}{Inflate}{\param{wxCoord }{diff}}
 126
 127 Increase the rectangle size by {\it dx} in x direction and {\it dy} in y
 128 direction. Both (or one of) parameters may be negative to decrease the
 129 rectngle size.
 130
 131 The second form uses the same {\it diff} for both {\it dx} and {\it dy}.
 132
 133 \membersection{wxRect::SetHeight}\label{wxrectsetheight}
 134
 135 \func{void}{SetHeight}{\param{int}{ height}}
 136
 137 Sets the height.
 138
 139 \membersection{wxRect::SetWidth}\label{wxrectsetwidth}
 140
 141 \func{void}{SetWidth}{\param{int}{ width}}
 142
 143 Sets the width.
 144
 145 \membersection{wxRect::SetX}\label{wxrectsetx}
 146
 147 \func{void}{SetX}{\param{int}{ x}}
 148
 149 Sets the x position.
 150
 151 \membersection{wxRect::SetY}\label{wxrectsety}
 152
 153 \func{void}{SetY}{\param{int}{ y}}
 154
 155 Sets the y position.
 156
 157 \membersection{wxRect::operator $=$}
 158
 159 \func{void}{operator $=$}{\param{const wxRect\& }{rect}}
 160
 161 Assignment operator.
 162
 163 \membersection{wxRect::operator $==$}
 164
 165 \func{bool}{operator $==$}{\param{const wxRect\& }{rect}}
 166
 167 Equality operator.
 168
 169 \membersection{wxRect::operator $!=$}
 170
 171 \func{bool}{operator $!=$}{\param{const wxRect\& }{rect}}
 172
 173 Inequality operator.
 174