Set svn properties on recently added files.

[wxWidgets.git] / interface / wx / grid.h

diff --git a/interface/wx/grid.h b/interface/wx/grid.h
index ed3b3a8689d3eaaba3a9c9b3f324236e0d1280d6..4bda2cb709f31b1a666f2134180667875354eadd 100644 (file)
--- a/interface/wx/grid.h
+++ b/interface/wx/grid.h
@@ -265,7 +265,7 @@ public:
 
     /**
         The parameters string format is "width[,precision[,format]]" where
 
     /**
         The parameters string format is "width[,precision[,format]]" where

-        @c format should be choosen beween f|e|g|E|G (f is used by default)
+        @c format should be chosen between f|e|g|E|G (f is used by default)

     */
     virtual void SetParameters(const wxString& params);
 
     */
     virtual void SetParameters(const wxString& params);
 


@@ -656,7 +656,7 @@ public:
 
     /**
         The parameters string format is "width[,precision[,format]]" where
 
     /**
         The parameters string format is "width[,precision[,format]]" where

-        @c format should be choosen beween f|e|g|E|G (f is used by default)
+        @c format should be chosen between f|e|g|E|G (f is used by default)

     */
     virtual void SetParameters(const wxString& params);
 };
     */
     virtual void SetParameters(const wxString& params);
 };


@@ -1191,6 +1191,78 @@ public:
     //@}
 };
 
     //@}
 };
 

+/**
+    Represents coordinates of a grid cell.
+
+    An object of this class is simply a (row, column) pair.
+ */
+class wxGridCellCoords
+{
+public:
+    /**
+        Default constructor initializes the object to invalid state.
+
+        Initially the row and column are both invalid (-1) and so operator!()
+        for an uninitialized wxGridCellCoords returns false.
+     */
+    wxGridCellCoords();
+
+    /**
+        Constructor taking a row and a column.
+     */
+    wxGridCellCoords(int row, int col);
+
+    /**
+        Return the row of the coordinate.
+     */
+    int GetRow() const;
+
+    /**
+        Set the row of the coordinate.
+     */
+    void SetRow(int n);
+
+    /**
+        Return the column of the coordinate.
+     */
+    int GetCol() const;
+
+    /**
+        Set the column of the coordinate.
+     */
+    void SetCol(int n);
+
+    /**
+        Set the row and column of the coordinate.
+     */
+    void Set(int row, int col);
+
+    /**
+        Assignment operator for coordinate types.
+     */
+    wxGridCellCoords& operator=(const wxGridCellCoords& other);
+
+    /**
+        Equality operator.
+     */
+    bool operator==(const wxGridCellCoords& other) const;
+
+    /**
+        Inequality operator.
+     */
+     bool operator!=(const wxGridCellCoords& other) const;
+
+    /**
+        Checks whether the coordinates are invalid.
+
+        Returns false only if both row and column are -1. Notice that if either
+        row or column (but not both) are -1, this method returns true even if
+        the object is invalid. This is done because objects in such state
+        should actually never exist, i.e. either both coordinates should be -1
+        or none of them should be -1.
+     */
+    bool operator!() const;
+};

 
 /**
     @class wxGridTableBase
 
 /**
     @class wxGridTableBase


@@ -1457,6 +1529,9 @@ public:
     /**
         Delete rows from the table.
 
     /**
         Delete rows from the table.
 

+        Notice that currently deleting a row intersecting a multi-cell (see
+        SetCellSize()) is not supported and will result in a crash.
+

         @param pos
             The first row to delete.
         @param numRows
         @param pos
             The first row to delete.
         @param numRows


@@ -1775,6 +1850,50 @@ public:
         CellSpan_Main
     };
 
         CellSpan_Main
     };
 

+    /**
+        Rendering styles supported by wxGrid::Render() method.
+
+        @since 2.9.4
+     */
+    enum wxGridRenderStyle
+    {
+        /// Draw grid row header labels.
+        wxGRID_DRAW_ROWS_HEADER = 0x001,
+
+        /// Draw grid column header labels.
+        wxGRID_DRAW_COLS_HEADER = 0x002,
+
+        /// Draw grid cell border lines.
+        wxGRID_DRAW_CELL_LINES = 0x004,
+
+        /**
+            Draw a bounding rectangle around the rendered cell area.
+
+            Useful where row or column headers are not drawn or where there is
+            multi row or column cell clipping and therefore no cell border at
+            the rendered outer boundary.
+        */
+        wxGRID_DRAW_BOX_RECT = 0x008,
+
+        /**
+            Draw the grid cell selection highlight if a selection is present.
+
+            At present the highlight colour drawn depends on whether the grid
+            window loses focus before drawing begins.
+        */
+        wxGRID_DRAW_SELECTION = 0x010,
+
+        /**
+            The default render style.
+
+            Includes all except wxGRID_DRAW_SELECTION.
+         */
+        wxGRID_DRAW_DEFAULT = wxGRID_DRAW_ROWS_HEADER |
+                              wxGRID_DRAW_COLS_HEADER |
+                              wxGRID_DRAW_CELL_LINES |
+                              wxGRID_DRAW_BOX_RECT
+    };
+

     /**
         @name Constructors and Initialization
      */
     /**
         @name Constructors and Initialization
      */


@@ -2804,7 +2923,10 @@ public:
         Hides the specified column.
 
         To show the column later you need to call SetColSize() with non-0
         Hides the specified column.
 
         To show the column later you need to call SetColSize() with non-0

-        width or ShowCol().
+        width or ShowCol() to restore the previous column width.
+
+        Notice that this method shouldn't be called if the column is already
+        hidden.

 
         @param col
             The column index.
 
         @param col
             The column index.


@@ -2814,6 +2936,12 @@ public:
     /**
         Shows the previously hidden column by resizing it to non-0 size.
 
     /**
         Shows the previously hidden column by resizing it to non-0 size.
 

+        The column is shown again with the same width that it had before
+        HideCol() call.
+
+        Notice that this method shouldn't be called if the column is not
+        currently hidden.
+

         @see HideCol(), SetColSize()
      */
     void ShowCol(int col);
         @see HideCol(), SetColSize()
      */
     void ShowCol(int col);


@@ -2875,7 +3003,7 @@ public:
         Hides the specified row.
 
         To show the row later you need to call SetRowSize() with non-0
         Hides the specified row.
 
         To show the row later you need to call SetRowSize() with non-0

-        width or ShowRow().
+        width or ShowRow() to restore its original height.

 
         @param col
             The row index.
 
         @param col
             The row index.


@@ -2883,7 +3011,10 @@ public:
     void HideRow(int col);
 
     /**
     void HideRow(int col);
 
     /**

-        Shows the previously hidden row by resizing it to non-0 size.
+        Shows the previously hidden row.
+
+        The row is shown again with the same height that it had before
+        HideRow() call.

 
         @see HideRow(), SetRowSize()
      */
 
         @see HideRow(), SetRowSize()
      */


@@ -3927,6 +4058,39 @@ public:
      */
     void RefreshAttr(int row, int col);
 
      */
     void RefreshAttr(int row, int col);
 

+    /**
+        Draws part or all of a wxGrid on a wxDC for printing or display.
+
+        Pagination can be accomplished by using sequential Render() calls
+        with appropriate values in wxGridCellCoords topLeft and bottomRight.
+
+        @param dc
+            The wxDC to be drawn on.
+        @param pos
+            The position on the wxDC where rendering should begin. If not
+            specified drawing will begin at the wxDC MaxX() and MaxY().
+        @param size
+            The size of the area on the wxDC that the rendered wxGrid should
+            occupy. If not specified the drawing will be scaled to fit the
+            available dc width or height. The wxGrid's aspect ratio is
+            maintained whether or not size is specified.
+        @param topLeft
+            The top left cell of the block to be drawn. Defaults to ( 0, 0 ).
+        @param bottomRight
+            The bottom right cell of the block to be drawn. Defaults to row and
+            column counts.
+        @param style
+            A combination of values from wxGridRenderStyle.
+
+        @since 2.9.4
+     */
+    void Render( wxDC& dc,
+                 const wxPoint& pos = wxDefaultPosition,
+                 const wxSize& size = wxDefaultSize,
+                 const wxGridCellCoords& topLeft = wxGridCellCoords( -1, -1 ),
+                 const wxGridCellCoords& bottomRight = wxGridCellCoords( -1, -1 ),
+                 int style = wxGRID_DRAW_DEFAULT );
+

     /**
         Sets the cell attributes for all cells in the specified column.
 
     /**
         Sets the cell attributes for all cells in the specified column.