Clarified wxPropertyGrid::HitTest() docs

[wxWidgets.git] / include / wx / generic / gridsel.h

diff --git a/include/wx/generic/gridsel.h b/include/wx/generic/gridsel.h
index e30cbbac6b121716e579b7da674e3bbec3307013..f6d3a98c40236ad2975432a1a5d500aa3b0375c0 100644 (file)
--- a/include/wx/generic/gridsel.h
+++ b/include/wx/generic/gridsel.h
@@ -4,38 +4,69 @@
 // Author:      Stefan Neis
 // Modified by:
 // Created:     20/02/2000
-// RCS-ID:      $$
+// RCS-ID:      $Id$
 // Copyright:   (c) Stefan Neis
 // Licence:     wxWindows licence
 /////////////////////////////////////////////////////////////////////////////
 
-#include "wx/defs.h"
-
-#if defined(wxUSE_NEW_GRID) && (wxUSE_NEW_GRID)
+#ifndef _WX_GENERIC_GRIDSEL_H_
+#define _WX_GENERIC_GRIDSEL_H_
 
-#ifndef __WXGRIDSEL_H__
-#define __WXGRIDSEL_H__
+#include "wx/defs.h"
 
-#ifdef __GNUG__
-#pragma interface "gridsel.h"
-#endif
+#if wxUSE_GRID
 
 #include "wx/grid.h"
 
-class WXDLLEXPORT wxGridSelection{
+class WXDLLIMPEXP_ADV wxGridSelection
+{
 public:
-    enum wxGridSelectionModes {wxGridSelectCells,
-                              wxGridSelectRows,
-                              wxGridSelectColumns};
-    wxGridSelection( wxGrid * grid, wxGridSelection::wxGridSelectionModes sel =
-                    wxGridSelection::wxGridSelectCells );
+    wxGridSelection(wxGrid *grid,
+                    wxGrid::wxGridSelectionModes sel = wxGrid::wxGridSelectCells);
+
     bool IsSelection();
-    bool IsInSelection ( int row, int col );
-    void SelectRow( int row, bool addToSelected = FALSE );
-    void SelectCol( int col, bool addToSelected = FALSE );
-    void SelectBlock( int topRow, int leftCol, int bottomRow, int rightCol );
-    void SelectCell( int row, int col);
-    void ToggleCellSelection( int row, int col);
+    bool IsInSelection(int row, int col);
+    bool IsInSelection(const wxGridCellCoords& coords)
+    {
+        return IsInSelection(coords.GetRow(), coords.GetCol());
+    }
+
+    void SetSelectionMode(wxGrid::wxGridSelectionModes selmode);
+    wxGrid::wxGridSelectionModes GetSelectionMode() { return m_selectionMode; }
+    void SelectRow(int row, const wxKeyboardState& kbd = wxKeyboardState());
+    void SelectCol(int col, const wxKeyboardState& kbd = wxKeyboardState());
+    void SelectBlock(int topRow, int leftCol,
+                     int bottomRow, int rightCol,
+                     const wxKeyboardState& kbd = wxKeyboardState(),
+                     bool sendEvent = true );
+    void SelectBlock(const wxGridCellCoords& topLeft,
+                     const wxGridCellCoords& bottomRight,
+                     const wxKeyboardState& kbd = wxKeyboardState(),
+                     bool sendEvent = true )
+    {
+        SelectBlock(topLeft.GetRow(), topLeft.GetCol(),
+                    bottomRight.GetRow(), bottomRight.GetCol(),
+                    kbd, sendEvent);
+    }
+
+    void SelectCell(int row, int col,
+                    const wxKeyboardState& kbd = wxKeyboardState(),
+                    bool sendEvent = true);
+    void SelectCell(const wxGridCellCoords& coords,
+                    const wxKeyboardState& kbd = wxKeyboardState(),
+                    bool sendEvent = true)
+    {
+        SelectCell(coords.GetRow(), coords.GetCol(), kbd, sendEvent);
+    }
+
+    void ToggleCellSelection(int row, int col,
+                             const wxKeyboardState& kbd = wxKeyboardState());
+    void ToggleCellSelection(const wxGridCellCoords& coords,
+                             const wxKeyboardState& kbd = wxKeyboardState())
+    {
+        ToggleCellSelection(coords.GetRow(), coords.GetCol(), kbd);
+    }
+
     void ClearSelection();
 
     void UpdateRows( size_t pos, int numRows );
@@ -43,32 +74,43 @@ public:
 
 private:
     int BlockContain( int topRow1, int leftCol1,
-                      int bottomRow1, int rightCol1,
-                      int topRow2, int leftCol2,
-                      int bottomRow2, int rightCol2 );
+                       int bottomRow1, int rightCol1,
+                       int topRow2, int leftCol2,
+                       int bottomRow2, int rightCol2 );
       // returns 1, if Block1 contains Block2,
       //        -1, if Block2 contains Block1,
       //         0, otherwise
 
     int BlockContainsCell( int topRow, int leftCol,
-                          int bottomRow, int rightCol,
-                          int row, int col )
+                           int bottomRow, int rightCol,
+                           int row, int col )
       // returns 1, if Block contains Cell,
       //         0, otherwise
     {
         return ( topRow <= row && row <= bottomRow &&
-                leftCol <= col && col <= rightCol );
+                 leftCol <= col && col <= rightCol );
     }
 
-    wxGridCellCoordsArray      m_cellSelection;
-    wxGridCellCoordsArray      m_blockSelectionTopLeft;
-    wxGridCellCoordsArray      m_blockSelectionBottomRight;
-    wxArrayInt                 m_rowSelection;
-    wxArrayInt                         m_colSelection;
+    void SelectBlockNoEvent(int topRow, int leftCol,
+                            int bottomRow, int rightCol)
+    {
+        SelectBlock(topRow, leftCol, bottomRow, rightCol,
+                    wxKeyboardState(), false);
+    }
+
+    wxGridCellCoordsArray               m_cellSelection;
+    wxGridCellCoordsArray               m_blockSelectionTopLeft;
+    wxGridCellCoordsArray               m_blockSelectionBottomRight;
+    wxArrayInt                          m_rowSelection;
+    wxArrayInt                          m_colSelection;
+
+    wxGrid                              *m_grid;
+    wxGrid::wxGridSelectionModes        m_selectionMode;
+
+    friend class WXDLLIMPEXP_FWD_ADV wxGrid;
 
-    wxGrid                     *m_grid;
-    wxGridSelectionModes       m_selectionMode;
+    wxDECLARE_NO_COPY_CLASS(wxGridSelection);
 };
 
-#endif // #ifdef __WXGRIDSEL_H__
-#endif // #ifndef wxUSE_NEW_GRID
+#endif  // wxUSE_GRID
+#endif  // _WX_GENERIC_GRIDSEL_H_