split wxEVT_GRID_CELL_CHANGE into wxEVT_GRID_CELL_CHANGING/ED pair for consistency...

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

diff --git a/include/wx/generic/headerctrlg.h b/include/wx/generic/headerctrlg.h
index 42fe827ea8ce55610a93b7d8557886b59ec6d179..28a73c24b0b18972a03f1008ef363db02a234332 100644 (file)
--- a/include/wx/generic/headerctrlg.h
+++ b/include/wx/generic/headerctrlg.h
@@ -56,6 +56,9 @@ private:
 
     virtual void DoScrollHorz(int dx);
 
 
     virtual void DoScrollHorz(int dx);
 

+    virtual void DoSetColumnsOrder(const wxArrayInt& order);
+    virtual wxArrayInt DoGetColumnsOrder() const;
+

     // override wxWindow methods which must be implemented by a new control
     virtual wxSize DoGetBestSize() const;
 
     // override wxWindow methods which must be implemented by a new control
     virtual wxSize DoGetBestSize() const;
 


@@ -68,10 +71,17 @@ private:
     void OnKeyDown(wxKeyEvent& event);
     void OnCaptureLost(wxMouseCaptureLostEvent& event);
 
     void OnKeyDown(wxKeyEvent& event);
     void OnCaptureLost(wxMouseCaptureLostEvent& event);
 

+    // move the column with given idx at given position (this doesn't generate
+    // any events but does refresh the display)
+    void DoMoveCol(unsigned int idx, unsigned int pos);
+

     // return the horizontal start position of the given column in physical
     // coordinates
     int GetColStart(unsigned int idx) const;
 
     // return the horizontal start position of the given column in physical
     // coordinates
     int GetColStart(unsigned int idx) const;
 

+    // and the end position
+    int GetColEnd(unsigned int idx) const;
+

     // refresh the given column [only]; idx must be valid
     void RefreshCol(unsigned int idx);
 
     // refresh the given column [only]; idx must be valid
     void RefreshCol(unsigned int idx);
 


@@ -86,22 +96,56 @@ private:
     // position is near the divider at the right end of this column (notice
     // that this means that we return column 0 even if the position is over
     // column 1 but close enough to the divider separating it from column 0)
     // position is near the divider at the right end of this column (notice
     // that this means that we return column 0 even if the position is over
     // column 1 but close enough to the divider separating it from column 0)

-    int FindColumnAtPos(int x, bool& onSeparator) const;
+    unsigned int FindColumnAtPoint(int x, bool *onSeparator = NULL) const;

 
     // return true if a drag resizing operation is currently in progress
     bool IsResizing() const;
 
 
     // return true if a drag resizing operation is currently in progress
     bool IsResizing() const;
 

+    // return true if a drag reordering operation is currently in progress
+    bool IsReordering() const;
+
+    // return true if any drag operation is currently in progress
+    bool IsDragging() const { return IsResizing() || IsReordering(); }
+

     // end any drag operation currently in progress (resizing or reordering)
     void EndDragging();
 
     // end any drag operation currently in progress (resizing or reordering)
     void EndDragging();
 

-    // and the resizing operation currently in progress and generate an event
-    // about it with its cancelled flag set if width is -1
-    void EndResizing(int width);
+    // cancel the drag operation currently in progress and generate an event
+    // about it
+    void CancelDragging();
+
+    // start (if m_colBeingResized is -1) or continue resizing the column
+    //
+    // this generates wxEVT_COMMAND_HEADER_BEGIN_RESIZE/RESIZING events and can
+    // cancel the operation if the user handler decides so
+    void StartOrContinueResizing(unsigned int col, int xPhysical);
+
+    // end the resizing operation currently in progress and generate an event
+    // about it with its cancelled flag set if xPhysical is -1
+    void EndResizing(int xPhysical);
+
+    // same functions as above but for column moving/reordering instead of
+    // resizing
+    void StartReordering(unsigned int col, int xPhysical);

 
 

-    // update the current position of the resizing marker if xPhysical is a
-    // valid physical coordinate value or remove it entirely if it is -1
+    // returns true if we did drag the column somewhere else or false if we
+    // didn't really move it -- in this case we consider that no reordering
+    // took place and that a normal column click event should be generated
+    bool EndReordering(int xPhysical);
+
+    // constrain the given position to be larger than the start position of the
+    // given column plus its minimal width and return the effective width
+    int ConstrainByMinWidth(unsigned int col, int& xPhysical);
+
+    // update the current position of the resizing marker

     void UpdateResizingMarker(int xPhysical);
 
     void UpdateResizingMarker(int xPhysical);
 

+    // update the information displayed while a column is being moved around
+    void UpdateReorderingMarker(int xPhysical);
+
+    // clear any overlaid markers
+    void ClearMarkers();
+

 
     // number of columns in the control currently
     unsigned int m_numColumns;
 
     // number of columns in the control currently
     unsigned int m_numColumns;


@@ -113,12 +157,24 @@ private:
     // progress
     unsigned int m_colBeingResized;
 
     // progress
     unsigned int m_colBeingResized;
 

+    // the column being moved or -1 if there is no reordering operation in
+    // progress
+    unsigned int m_colBeingReordered;
+
+    // the distance from the start of m_colBeingReordered and the mouse
+    // position when the user started to drag it
+    int m_dragOffset;
+

     // the horizontal scroll offset
     int m_scrollOffset;
 
     // the overlay display used during the dragging operations
     wxOverlay m_overlay;
 
     // the horizontal scroll offset
     int m_scrollOffset;
 
     // the overlay display used during the dragging operations
     wxOverlay m_overlay;
 

+    // the indices of the column appearing at the given position on the display
+    // (its size is always m_numColumns)
+    wxArrayInt m_colIndices;
+

 
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxHeaderCtrl)
 
     DECLARE_EVENT_TABLE()
     DECLARE_NO_COPY_CLASS(wxHeaderCtrl)