interface/position.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        position.h
   3 // Purpose:     documentation for wxPosition class
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxPosition
  11     @wxheader{position.h}
  12
  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.
  16
  17     @library{wxbase}
  18     @category{FIXME}
  19
  20     @seealso
  21     wxPoint, wxSize
  22 */
  23 class wxPosition
  24 {
  25 public:
  26     //@{
  27     /**
  28         Construct a new wxPosition, optionally setting the row and column. The
  29         default value is (0, 0).
  30     */
  31     wxPosition();
  32     wxPosition(int row, int col);
  33     //@}
  34
  35     /**
  36         A synonym for GetColumn().
  37     */
  38     int GetCol() const;
  39
  40     /**
  41         Get the current row value.
  42     */
  43     int GetColumn() const;
  44
  45     /**
  46         Get the current row value.
  47     */
  48     int GetRow() const;
  49
  50     //@{
  51     /**
  52
  53     */
  54     bool operator ==(const wxPosition& p) const;
  55     const bool operator !=(const wxPosition& p) const;
  56     const wxPosition&  operator +=(const wxPosition& p) const;
  57     wxPosition operator -=(const wxPosition& p) const;
  58     wxPosition operator +=(const wxSize& s) const;
  59     wxPosition operator -=(const wxSize& s) const;
  60     wxPosition operator +(const wxPosition& p) const;
  61     const wxPosition  operator -(const wxPosition& p) const;
  62     const wxPosition  operator +(const wxSize& s) const;
  63     const wxPosition  operator -(const wxSize& s) const;
  64     //@}
  65
  66     /**
  67         A synonym for SetColumn().
  68     */
  69     void SetCol(int column);
  70
  71     /**
  72         Set a new column value.
  73     */
  74     void SetColumn(int column);
  75
  76     /**
  77         Set a new row value.
  78     */
  79     void SetRow(int row);
  80 };