interface/wx/position.h

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