make wxRearrangeDialog more customizable and add an example of customizing it to...

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

diff --git a/interface/wx/grid.h b/interface/wx/grid.h
index 9072c1992c1200cb1b40ea8b0c5d50847fd84322..763c62ecde01610a3c382553277b41a97a5629cd 100644 (file)
--- a/interface/wx/grid.h
+++ b/interface/wx/grid.h
@@ -186,7 +186,13 @@ public:
 
     /**
         Fetch the value from the table and prepare the edit control to begin
 
     /**
         Fetch the value from the table and prepare the edit control to begin

-        editing. Sets the focus to the edit control.
+        editing.
+
+        This function should save the original value of the grid cell at the
+        given @a row and @a col and show the control allowing the user to
+        change it.
+
+        @see EndEdit()

     */
     virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
 
     */
     virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
 


@@ -207,13 +213,28 @@ public:
     virtual void Destroy();
 
     /**
     virtual void Destroy();
 
     /**

-        Complete the editing of the current cell. If necessary, the control may
-        be destroyed.
+        End editing the cell.

 
 

-        @return @true if the value has changed.
+        This function must check if the current value of the editing control is
+        valid and different from the original value (available as @a oldval in
+        its string form and possibly saved internally using its real type by
+        BeginEdit()). If it isn't, it just returns @false, otherwise it fills
+        @a newval with the representation of the new value in the string form,
+        if necessary saves it using its real type internally, and returns @true.
+
+        If the user-defined wxEVT_GRID_CELL_CHANGING event handler doesn't veto
+        this change, ApplyEdit() will be called next.

     */
     virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
 
     */
     virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
 

+    /**
+        Effectively save the changes in the grid.
+
+        This function should save the value of the control in the grid. It is
+        called only after EndEdit() returns @true.
+     */
+    virtual void ApplyEdit(int row, int col, wxGrid* grid) = 0;
+

     /**
         Some types of controls on some platforms may need some help with the
         Return key.
     /**
         Some types of controls on some platforms may need some help with the
         Return key.


@@ -1047,7 +1068,7 @@ public:
     - wxGridCellFloatEditor
     - wxGridCellNumberEditor
     - wxGridCellTextEditor
     - wxGridCellFloatEditor
     - wxGridCellNumberEditor
     - wxGridCellTextEditor

-    
+

     Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
     wxGridEditorCreatedEvent for the documentation of all event types you can
     use with wxGrid.
     Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
     wxGridEditorCreatedEvent for the documentation of all event types you can
     use with wxGrid.


@@ -1644,7 +1665,7 @@ public:
         See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
         more information.
     */
         See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
         more information.
     */

-    const wxString GetCellValue(const wxGridCellCoords& coords) const;
+    const wxString& GetCellValue(const wxGridCellCoords& coords) const;

 
     /**
         Returns a pointer to the current default grid cell editor.
 
     /**
         Returns a pointer to the current default grid cell editor.


@@ -2014,6 +2035,11 @@ public:
     */
     int GetColSize(int col) const;
 
     */
     int GetColSize(int col) const;
 

+    /**
+        Returns @true if the specified column is not currently hidden.
+     */
+    bool IsColShown(int col) const;
+

     /**
         Returns the default height for column labels.
     */
     /**
         Returns the default height for column labels.
     */


@@ -2054,6 +2080,11 @@ public:
     */
     int GetRowSize(int row) const;
 
     */
     int GetRowSize(int row) const;
 

+    /**
+        Returns @true if the specified row is not currently hidden.
+     */
+    bool IsRowShown(int row) const;
+

     /**
         Sets the height of the column labels.
 
     /**
         Sets the height of the column labels.
 


@@ -2295,9 +2326,18 @@ public:
     */
     void SetColPos(int colID, int newPos);
 
     */
     void SetColPos(int colID, int newPos);
 

+    /**
+        Sets the positions of all columns at once.
+
+        This method takes an array containing the indices of the columns in
+        their display order, i.e. uses the same convention as
+        wxHeaderCtrl::SetColumnsOrder().
+    */
+    void SetColumnsOrder(const wxArrayInt& order);
+

     /**
         Resets the position of the columns to the default.
     /**
         Resets the position of the columns to the default.

-     */
+    */

     void ResetColPos();
 
     //@}
     void ResetColPos();
 
     //@}


@@ -2305,7 +2345,7 @@ public:
 
     /**
         @name Cursor Movement
 
     /**
         @name Cursor Movement

-     */
+    */

     //@{
 
     /**
     //@{
 
     /**


@@ -3166,6 +3206,71 @@ protected:
      */
     void UnsetSortingColumn();
     //@}
      */
     void UnsetSortingColumn();
     //@}

+
+    /**
+        @name Accessors for component windows.
+
+        Return the various child windows of wxGrid.
+
+        wxGrid is an empty parent window for 4 children representing the column
+        labels window (top), the row labels window (left), the corner window
+        (top left) and the main grid window. It may be necessary to use these
+        individual windows and not the wxGrid window itself if you need to
+        handle events for them (this can be done using wxEvtHandler::Connect()
+        or wxWindow::PushEventHandler()) or do something else requiring the use
+        of the correct window pointer. Notice that you should not, however,
+        change these windows (e.g. reposition them or draw over them) because
+        they are managed by wxGrid itself.
+     */
+    //@{
+
+    /**
+        Return the main grid window containing the grid cells.
+
+        This window is always shown.
+     */
+    wxWindow *GetGridWindow() const;
+
+    /**
+        Return the row labels window.
+
+        This window is not shown if the row labels were hidden using
+        HideRowLabels().
+     */
+    wxWindow *GetGridRowLabelWindow() const;
+
+    /**
+        Return the column labels window.
+
+        This window is not shown if the columns labels were hidden using
+        HideColLabels().
+
+        Depending on whether UseNativeColHeader() was called or not this can be
+        either a wxHeaderCtrl or a plain wxWindow.  This function returns a valid
+        window pointer in either case but in the former case you can also use
+        GetGridColHeader() to access it if you need wxHeaderCtrl-specific
+        functionality.
+     */
+    wxWindow *GetGridWindow() const;
+
+    /**
+        Return the window in the top left grid corner.
+
+        This window is shown only of both columns and row labels are shown and
+        normally doesn't contain anything. Clicking on it is handled by wxGrid
+        however and can be used to select the entire grid.
+     */
+    wxWindow *GetGridCornerLabelWindow() const;
+
+    /**
+        Return the header control used for column labels display.
+
+        This function can only be called if UseNativeColHeader() had been
+        called.
+     */
+    wxHeaderCtrl *GetGridColHeader() const;
+
+    //@}

 };
 
 
 };
 
 


@@ -3246,9 +3351,17 @@ public:
     documented below for brevity.
 
     @beginEventTable{wxGridEvent}
     documented below for brevity.
 
     @beginEventTable{wxGridEvent}

-    @event{EVT_GRID_CELL_CHANGE(func)}
-        The user changed the data in a cell. Processes a
-        @c wxEVT_GRID_CELL_CHANGE event type.
+    @event{EVT_GRID_CELL_CHANGING(func)}
+        The user is about to change the data in a cell. The new cell value as
+        string is available from GetString() event object method. This event
+        can be vetoed if the change is not allowed.
+        Processes a @c wxEVT_GRID_CELL_CHANGING event type.
+    @event{EVT_GRID_CELL_CHANGED(func)}
+        The user changed the data in a cell. The old cell value as string is
+        available from GetString() event object method. Notice that vetoing
+        this event still works for backwards compatibility reasons but any new
+        code should only veto EVT_GRID_CELL_CHANGING event and not this one.
+        Processes a @c wxEVT_GRID_CELL_CHANGED event type.

     @event{EVT_GRID_CELL_LEFT_CLICK(func)}
         The user clicked a cell with the left mouse button. Processes a
         @c wxEVT_GRID_CELL_LEFT_CLICK event type.
     @event{EVT_GRID_CELL_LEFT_CLICK(func)}
         The user clicked a cell with the left mouse button. Processes a
         @c wxEVT_GRID_CELL_LEFT_CLICK event type.


@@ -3293,7 +3406,6 @@ public:
         proceed in which case wxGrid::SetColPos() is used to reorder the
         columns display order without affecting the use of the column indices
         otherwise.
         proceed in which case wxGrid::SetColPos() is used to reorder the
         columns display order without affecting the use of the column indices
         otherwise.

-

         This event macro corresponds to @c wxEVT_GRID_COL_MOVE event type.
     @event{EVT_GRID_COL_SORT(func)}
         This event is generated when a column is clicked by the user and its
         This event macro corresponds to @c wxEVT_GRID_COL_MOVE event type.
     @event{EVT_GRID_COL_SORT(func)}
         This event is generated when a column is clicked by the user and its


@@ -3304,12 +3416,11 @@ public:
         (and not vetoed) the grid supposes that the table was indeed resorted
         and updates the column to indicate the new sort order and refreshes
         itself.
         (and not vetoed) the grid supposes that the table was indeed resorted
         and updates the column to indicate the new sort order and refreshes
         itself.

-

         This event macro corresponds to @c wxEVT_GRID_COL_SORT event type.
     @endEventTable
 
     @library{wxadv}
         This event macro corresponds to @c wxEVT_GRID_COL_SORT event type.
     @endEventTable
 
     @library{wxadv}

-    @category{grid}
+    @category{grid,events}

 */
 class wxGridEvent : public wxNotifyEvent
 {
 */
 class wxGridEvent : public wxNotifyEvent
 {


@@ -3391,7 +3502,7 @@ public:
     @endEventTable
 
     @library{wxadv}
     @endEventTable
 
     @library{wxadv}

-    @category{grid}
+    @category{grid,events}

 */
 class wxGridSizeEvent : public wxNotifyEvent
 {
 */
 class wxGridSizeEvent : public wxNotifyEvent
 {


@@ -3454,7 +3565,7 @@ public:
     @endEventTable
 
     @library{wxadv}
     @endEventTable
 
     @library{wxadv}

-    @category{grid}
+    @category{grid,events}

 */
 class wxGridRangeSelectEvent : public wxNotifyEvent
 {
 */
 class wxGridRangeSelectEvent : public wxNotifyEvent
 {


@@ -3545,7 +3656,7 @@ public:
     @endEventTable
 
     @library{wxadv}
     @endEventTable
 
     @library{wxadv}

-    @category{grid}
+    @category{grid,events}

 */
 class wxGridEditorCreatedEvent : public wxCommandEvent
 {
 */
 class wxGridEditorCreatedEvent : public wxCommandEvent
 {