interface/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     @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     @see wxPoint, wxSize
  21 */
  22 class wxPosition
  23 {
  24 public:
  25     //@{
  26     /**
  27         Construct a new wxPosition, optionally setting the row and column. The
  28         default value is (0, 0).
  29     */
  30     wxPosition();
  31     wxPosition(int row, int col);
  32     //@}
  33
  34     /**
  35         A synonym for GetColumn().
  36     */
  37     int GetCol() const;
  38
  39     /**
  40         Get the current row value.
  41     */
  42     int GetColumn() const;
  43
  44     /**
  45         Get the current row value.
  46     */
  47     int GetRow() const;
  48
  49     //@{
  50     /**
  51
  52     */
  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;
  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 };
  80