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$ | |
526954c5 | 6 | // Licence: wxWindows licence |
23324ae1 FM |
7 | ///////////////////////////////////////////////////////////////////////////// |
8 | ||
9 | /** | |
10 | @class wxPosition | |
7c913512 | 11 | |
23324ae1 | 12 | This class represents the position of an item in any kind of grid of rows and |
b1b95a65 FM |
13 | columns such as wxGridBagSizer, or wxHVScrolledWindow. |
14 | ||
23324ae1 | 15 | @library{wxbase} |
b1b95a65 | 16 | @category{data} |
7c913512 | 17 | |
e54c96f1 | 18 | @see wxPoint, wxSize |
23324ae1 | 19 | */ |
7c913512 | 20 | class wxPosition |
23324ae1 FM |
21 | { |
22 | public: | |
b1b95a65 | 23 | |
23324ae1 | 24 | /** |
b1b95a65 FM |
25 | Construct a new wxPosition, setting the row and column to the |
26 | default value of (0, 0). | |
23324ae1 FM |
27 | */ |
28 | wxPosition(); | |
b1b95a65 FM |
29 | |
30 | /** | |
31 | Construct a new wxPosition, setting the row and column to the | |
32 | value of (@a row, @a col). | |
33 | */ | |
7c913512 | 34 | wxPosition(int row, int col); |
23324ae1 FM |
35 | |
36 | /** | |
37 | A synonym for GetColumn(). | |
38 | */ | |
328f5751 | 39 | int GetCol() const; |
23324ae1 FM |
40 | |
41 | /** | |
42 | Get the current row value. | |
43 | */ | |
328f5751 | 44 | int GetColumn() const; |
23324ae1 FM |
45 | |
46 | /** | |
47 | Get the current row value. | |
48 | */ | |
328f5751 | 49 | int GetRow() const; |
23324ae1 | 50 | |
23324ae1 FM |
51 | /** |
52 | A synonym for SetColumn(). | |
53 | */ | |
54 | void SetCol(int column); | |
55 | ||
56 | /** | |
57 | Set a new column value. | |
58 | */ | |
59 | void SetColumn(int column); | |
60 | ||
61 | /** | |
62 | Set a new row value. | |
63 | */ | |
64 | void SetRow(int row); | |
b1b95a65 FM |
65 | |
66 | ||
67 | /** | |
68 | @name Miscellaneous operators | |
69 | ||
70 | @{ | |
71 | */ | |
bb6eb694 RD |
72 | bool operator ==(const wxPosition& pos) const; |
73 | bool operator !=(const wxPosition& pos) const; | |
c66a675a VZ |
74 | wxPosition& operator +=(const wxPosition& pos); |
75 | wxPosition& operator -=(const wxPosition& pos); | |
76 | wxPosition& operator +=(const wxSize& size); | |
77 | wxPosition& operator -=(const wxSize& size); | |
bb6eb694 RD |
78 | wxPosition operator +(const wxPosition& pos) const; |
79 | wxPosition operator -(const wxPosition& pos) const; | |
80 | wxPosition operator +(const wxSize& size) const; | |
81 | wxPosition operator -(const wxSize& size) const; | |
b1b95a65 | 82 | //@} |
23324ae1 | 83 | }; |
e54c96f1 | 84 |