generate a size event from ShowWithEffect() for consistency with Show()

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

diff --git a/interface/wx/grid.h b/interface/wx/grid.h
index 9d1eeb0ebc151d242ffd95da581696f5b8870ace..47a223594c2ca876adc3390d385a54c7203cbc69 100644 (file)
--- a/interface/wx/grid.h
+++ b/interface/wx/grid.h
@@ -8,7 +8,6 @@
 
 /**
     @class wxGridCellFloatRenderer
 
 /**
     @class wxGridCellFloatRenderer

-    @wxheader{grid.h}

 
     This class may be used to format floating point data in a cell.
 
 
     This class may be used to format floating point data in a cell.
 


@@ -59,7 +58,6 @@ public:
 
 /**
     @class wxGridTableBase
 
 /**
     @class wxGridTableBase

-    @wxheader{grid.h}

 
     Grid table classes.
 
 
     Grid table classes.
 


@@ -279,7 +277,6 @@ public:
 
 /**
     @class wxGridCellEditor
 
 /**
     @class wxGridCellEditor

-    @wxheader{grid.h}

 
     This class is responsible for providing and manipulating
     the in-place edit controls for the grid.  Instances of wxGridCellEditor
 
     This class is responsible for providing and manipulating
     the in-place edit controls for the grid.  Instances of wxGridCellEditor


@@ -386,7 +383,6 @@ public:
 
 /**
     @class wxGridCellTextEditor
 
 /**
     @class wxGridCellTextEditor

-    @wxheader{grid.h}

 
     The editor for string/text data.
 
 
     The editor for string/text data.
 


@@ -415,7 +411,6 @@ public:
 
 /**
     @class wxGridCellStringRenderer
 
 /**
     @class wxGridCellStringRenderer

-    @wxheader{grid.h}

 
     This class may be used to format string data in a cell; it is the default
     for string cells.
 
     This class may be used to format string data in a cell; it is the default
     for string cells.


@@ -439,7 +434,6 @@ public:
 
 /**
     @class wxGridCellChoiceEditor
 
 /**
     @class wxGridCellChoiceEditor

-    @wxheader{grid.h}

 
     The editor for string data allowing to choose from a list of strings.
 
 
     The editor for string data allowing to choose from a list of strings.
 


@@ -478,7 +472,6 @@ public:
 
 /**
     @class wxGridEditorCreatedEvent
 
 /**
     @class wxGridEditorCreatedEvent

-    @wxheader{grid.h}

 
 
     @library{wxadv}
 
 
     @library{wxadv}


@@ -534,7 +527,6 @@ public:
 
 /**
     @class wxGridRangeSelectEvent
 
 /**
     @class wxGridRangeSelectEvent

-    @wxheader{grid.h}

 
 
     @library{wxadv}
 
 
     @library{wxadv}


@@ -619,7 +611,6 @@ public:
 
 /**
     @class wxGridCellRenderer
 
 /**
     @class wxGridCellRenderer

-    @wxheader{grid.h}

 
     This class is responsible for actually drawing the cell
     in the grid. You may pass it to the wxGridCellAttr (below) to change the
 
     This class is responsible for actually drawing the cell
     in the grid. You may pass it to the wxGridCellAttr (below) to change the


@@ -665,7 +656,6 @@ public:
 
 /**
     @class wxGridCellNumberEditor
 
 /**
     @class wxGridCellNumberEditor

-    @wxheader{grid.h}

 
     The editor for numeric integer data.
 
 
     The editor for numeric integer data.
 


@@ -705,7 +695,6 @@ public:
 
 /**
     @class wxGridSizeEvent
 
 /**
     @class wxGridSizeEvent

-    @wxheader{grid.h}

 
     This event class contains information about a row/column resize event.
 
 
     This event class contains information about a row/column resize event.
 


@@ -765,7 +754,6 @@ public:
 
 /**
     @class wxGridCellNumberRenderer
 
 /**
     @class wxGridCellNumberRenderer

-    @wxheader{grid.h}

 
     This class may be used to format integer data in a cell.
 
 
     This class may be used to format integer data in a cell.
 


@@ -788,7 +776,6 @@ public:
 
 /**
     @class wxGridCellAttr
 
 /**
     @class wxGridCellAttr

-    @wxheader{grid.h}

 
     This class can be used to alter the cells' appearance in
     the grid by changing their colour/font/... from default. An object of this
 
     This class can be used to alter the cells' appearance in
     the grid by changing their colour/font/... from default. An object of this


@@ -940,7 +927,6 @@ public:
 
 /**
     @class wxGridCellBoolRenderer
 
 /**
     @class wxGridCellBoolRenderer

-    @wxheader{grid.h}

 
     This class may be used to format boolean data in a cell.
     for string cells.
 
     This class may be used to format boolean data in a cell.
     for string cells.


@@ -964,7 +950,6 @@ public:
 
 /**
     @class wxGridEvent
 
 /**
     @class wxGridEvent

-    @wxheader{grid.h}

 
     This event class contains information about various grid events.
 
 
     This event class contains information about various grid events.
 


@@ -1035,7 +1020,6 @@ public:
 
 /**
     @class wxGridCellFloatEditor
 
 /**
     @class wxGridCellFloatEditor

-    @wxheader{grid.h}

 
     The editor for floating point numbers data.
 
 
     The editor for floating point numbers data.
 


@@ -1066,7 +1050,6 @@ public:
 
 /**
     @class wxGrid
 
 /**
     @class wxGrid

-    @wxheader{grid.h}

 
     wxGrid and its related classes are used for displaying and editing tabular
     data. They provide a rich set of features for display, editing, and
 
     wxGrid and its related classes are used for displaying and editing tabular
     data. They provide a rich set of features for display, editing, and


@@ -1868,11 +1851,24 @@ public:
 
     /**
         Returns an array of selected cols.
 
     /**
         Returns an array of selected cols.

+
+        Please notice that this method alone is not sufficient to find all the
+        selected columns, see the explanation in GetSelectedRows()
+        documentation for more details.

     */
     wxArrayInt GetSelectedCols() const;
 
     /**
         Returns an array of selected rows.
     */
     wxArrayInt GetSelectedCols() const;
 
     /**
         Returns an array of selected rows.

+
+        Note that this array contains only the rows which were individually
+        selected (using the mouse with the row header or combinations involving
+        @c Ctrl key for selecting individual rows). In particular if the user
+        selects many rows at once (e.g. by pressing @c Shift key) this array is
+        @b not updated because this could mean storing a very large number of
+        elements in it. So in general to find the current selection you need to
+        use both this method and GetSelectionBlockTopLeft() and
+        GetSelectionBlockBottomRight() ones.

     */
     wxArrayInt GetSelectedRows() const;
 
     */
     wxArrayInt GetSelectedRows() const;
 


@@ -2716,7 +2712,6 @@ public:
 
 /**
     @class wxGridCellBoolEditor
 
 /**
     @class wxGridCellBoolEditor

-    @wxheader{grid.h}

 
     The editor for boolean data.
 
 
     The editor for boolean data.
 


@@ -2755,7 +2750,6 @@ public:
 
 /**
     @class wxGridUpdateLocker
 
 /**
     @class wxGridUpdateLocker

-    @wxheader{grid.h}

 
     This small class can be used to prevent wxGrid from redrawing
     during its lifetime by calling wxGrid::BeginBatch
 
     This small class can be used to prevent wxGrid from redrawing
     during its lifetime by calling wxGrid::BeginBatch