]> git.saurik.com Git - wxWidgets.git/blame - interface/position.h
more utils.h fixes
[wxWidgets.git] / interface / position.h
CommitLineData
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
FM
13 This class represents the position of an item in any kind of grid of rows and
14 columns such as wxGridBagSizer, or
15 wxHVScrolledWindow.
7c913512 16
23324ae1
FM
17 @library{wxbase}
18 @category{FIXME}
7c913512 19
e54c96f1 20 @see wxPoint, wxSize
23324ae1 21*/
7c913512 22class wxPosition
23324ae1
FM
23{
24public:
25 //@{
26 /**
27 Construct a new wxPosition, optionally setting the row and column. The
28 default value is (0, 0).
29 */
30 wxPosition();
7c913512 31 wxPosition(int row, int col);
23324ae1
FM
32 //@}
33
34 /**
35 A synonym for GetColumn().
36 */
328f5751 37 int GetCol() const;
23324ae1
FM
38
39 /**
40 Get the current row value.
41 */
328f5751 42 int GetColumn() const;
23324ae1
FM
43
44 /**
45 Get the current row value.
46 */
328f5751 47 int GetRow() const;
23324ae1
FM
48
49 //@{
50 /**
3c4f71cc 51
23324ae1 52 */
328f5751
FM
53 bool operator ==(const wxPosition& p) const;
54 const bool operator !=(const wxPosition& p) const;
55 const wxPosition& operator +=(const wxPosition& p) const;
56 wxPosition operator -=(const wxPosition& p) const;
57 wxPosition operator +=(const wxSize& s) const;
58 wxPosition operator -=(const wxSize& s) const;
59 wxPosition operator +(const wxPosition& p) const;
60 const wxPosition operator -(const wxPosition& p) const;
61 const wxPosition operator +(const wxSize& s) const;
62 const wxPosition operator -(const wxSize& s) const;
23324ae1
FM
63 //@}
64
65 /**
66 A synonym for SetColumn().
67 */
68 void SetCol(int column);
69
70 /**
71 Set a new column value.
72 */
73 void SetColumn(int column);
74
75 /**
76 Set a new row value.
77 */
78 void SetRow(int row);
79};
e54c96f1 80