]>
Commit | Line | Data |
---|---|---|
23324ae1 FM |
1 | ///////////////////////////////////////////////////////////////////////////// |
2 | // Name: position.h | |
e54c96f1 | 3 | // Purpose: interface of wxPosition |
23324ae1 FM |
4 | // Author: wxWidgets team |
5 | // RCS-ID: $Id$ | |
6 | // Licence: wxWindows license | |
7 | ///////////////////////////////////////////////////////////////////////////// | |
8 | ||
9 | /** | |
10 | @class wxPosition | |
11 | @wxheader{position.h} | |
7c913512 | 12 | |
23324ae1 | 13 | This class represents the position of an item in any kind of grid of rows and |
b1b95a65 FM |
14 | columns such as wxGridBagSizer, or wxHVScrolledWindow. |
15 | ||
16 | @todo rename this class to wxItemPosition or such, wxPosition is too generic | |
7c913512 | 17 | |
23324ae1 | 18 | @library{wxbase} |
b1b95a65 | 19 | @category{data} |
7c913512 | 20 | |
e54c96f1 | 21 | @see wxPoint, wxSize |
23324ae1 | 22 | */ |
7c913512 | 23 | class wxPosition |
23324ae1 FM |
24 | { |
25 | public: | |
b1b95a65 | 26 | |
23324ae1 | 27 | /** |
b1b95a65 FM |
28 | Construct a new wxPosition, setting the row and column to the |
29 | default value of (0, 0). | |
23324ae1 FM |
30 | */ |
31 | wxPosition(); | |
b1b95a65 FM |
32 | |
33 | /** | |
34 | Construct a new wxPosition, setting the row and column to the | |
35 | value of (@a row, @a col). | |
36 | */ | |
7c913512 | 37 | wxPosition(int row, int col); |
23324ae1 FM |
38 | |
39 | /** | |
40 | A synonym for GetColumn(). | |
41 | */ | |
328f5751 | 42 | int GetCol() const; |
23324ae1 FM |
43 | |
44 | /** | |
45 | Get the current row value. | |
46 | */ | |
328f5751 | 47 | int GetColumn() const; |
23324ae1 FM |
48 | |
49 | /** | |
50 | Get the current row value. | |
51 | */ | |
328f5751 | 52 | int GetRow() const; |
23324ae1 | 53 | |
23324ae1 FM |
54 | /** |
55 | A synonym for SetColumn(). | |
56 | */ | |
57 | void SetCol(int column); | |
58 | ||
59 | /** | |
60 | Set a new column value. | |
61 | */ | |
62 | void SetColumn(int column); | |
63 | ||
64 | /** | |
65 | Set a new row value. | |
66 | */ | |
67 | void SetRow(int row); | |
b1b95a65 FM |
68 | |
69 | ||
70 | /** | |
71 | @name Miscellaneous operators | |
72 | ||
73 | @{ | |
74 | */ | |
75 | bool operator ==(const wxPosition& p) const; | |
76 | bool operator !=(const wxPosition& p) const; | |
77 | wxPosition& operator +=(const wxPosition& p) const; | |
78 | wxPosition& operator -=(const wxPosition& p) const; | |
79 | wxPosition& operator +=(const wxSize& s) const; | |
80 | wxPosition& operator -=(const wxSize& s) const; | |
81 | wxPosition& operator +(const wxPosition& p) const; | |
82 | wxPosition& operator -(const wxPosition& p) const; | |
83 | wxPosition& operator +(const wxSize& s) const; | |
84 | wxPosition& operator -(const wxSize& s) const; | |
85 | //@} | |
23324ae1 | 86 | }; |
e54c96f1 | 87 |