#include "wx/control.h"
+#if wxUSE_HEADERCTRL
+
#include "wx/dynarray.h"
#include "wx/vector.h"
enum
{
// allow column drag and drop
- wxHD_DRAGDROP = 0x0001,
+ wxHD_ALLOW_REORDER = 0x0001,
+
+ // allow hiding (and showing back) the columns using the menu shown by
+ // right clicking the header
+ wxHD_ALLOW_HIDE = 0x0002,
// style used by default when creating the control
- wxHD_DEFAULT_STYLE = wxHD_DRAGDROP
+ wxHD_DEFAULT_STYLE = wxHD_ALLOW_REORDER
};
extern WXDLLIMPEXP_DATA_CORE(const char) wxHeaderCtrlNameStr[];
// set the number of columns in the control
//
// this also calls UpdateColumn() for all columns
- void SetColumnCount(unsigned int count) { DoSetCount(count); }
+ void SetColumnCount(unsigned int count);
// return the number of columns in the control as set by SetColumnCount()
unsigned int GetColumnCount() const { return DoGetCount(); }
DoUpdate(idx);
}
+
+ // columns order
+ // -------------
+
// set the columns order: the array defines the column index which appears
// the given position, it must have GetColumnCount() elements and contain
// all indices exactly once
// get the position at which this column is currently displayed
unsigned int GetColumnPos(unsigned int idx) const;
+ // reset the columns order to the natural one
+ void ResetColumnsOrder();
+
+ // helper function used by the generic version of this control and also
+ // wxGrid: reshuffles the array of column indices indexed by positions
+ // (i.e. using the same convention as for SetColumnsOrder()) so that the
+ // column with the given index is found at the specified position
+ static void MoveColumnInOrderArray(wxArrayInt& order,
+ unsigned int idx,
+ unsigned int pos);
+
+
+ // UI helpers
+ // ----------
+
+#if wxUSE_MENUS
+ // show the popup menu containing all columns with check marks for the ones
+ // which are currently shown and return true if something was done using it
+ // (in this case UpdateColumnVisibility() will have been called) or false
+ // if the menu was cancelled
+ //
+ // this is called from the default right click handler for the controls
+ // with wxHD_ALLOW_HIDE style
+ bool ShowColumnsMenu(const wxPoint& pt, const wxString& title = wxString());
+
+ // append the entries for all our columns to the given menu, with the
+ // currently visible columns being checked
+ //
+ // this is used by ShowColumnsMenu() but can also be used if you use your
+ // own custom columns menu but nevertheless want to show all the columns in
+ // it
+ //
+ // the ids of the items corresponding to the columns are consecutive and
+ // start from idColumnsBase
+ void AddColumnsItems(wxMenu& menu, int idColumnsBase = 0);
+#endif // wxUSE_MENUS
+
+ // show the columns customization dialog and return true if something was
+ // changed using it (in which case UpdateColumnVisibility() and/or
+ // UpdateColumnsOrder() will have been called)
+ //
+ // this is called by the control itself from ShowColumnsMenu() (which in
+ // turn is only called by the control if wxHD_ALLOW_HIDE style was
+ // specified) and if the control has wxHD_ALLOW_REORDER style as well
+ bool ShowCustomizeDialog();
+
// implementation only from now on
// -------------------------------
protected:
// this method must be implemented by the derived classes to return the
// information for the given column
- virtual wxHeaderColumnBase& GetColumn(unsigned int idx) = 0;
+ virtual const wxHeaderColumn& GetColumn(unsigned int idx) const = 0;
// this method is called from the default EVT_HEADER_SEPARATOR_DCLICK
// handler to update the fitting column width of the given column, it
return false;
}
+ // this method is called from ShowColumnsMenu() and must be overridden to
+ // update the internal column visibility (there is no need to call
+ // UpdateColumn() from here, this will be done internally)
+ virtual void UpdateColumnVisibility(unsigned int WXUNUSED(idx),
+ bool WXUNUSED(show))
+ {
+ wxFAIL_MSG( "must be overridden if called" );
+ }
+
+ // this method is called from ShowCustomizeDialog() to reorder all columns
+ // at once and should be implemented for controls using wxHD_ALLOW_REORDER
+ // style (there is no need to call SetColumnsOrder() from here, this is
+ // done by the control itself)
+ virtual void UpdateColumnsOrder(const wxArrayInt& WXUNUSED(order))
+ {
+ wxFAIL_MSG( "must be overridden if called" );
+ }
+
+ // this method can be overridden in the derived classes to do something
+ // (e.g. update/resize some internal data structures) before the number of
+ // columns in the control changes
+ virtual void OnColumnCountChanging(unsigned int WXUNUSED(count)) { }
+
+
+ // helper function for the derived classes: update the array of column
+ // indices after the number of columns changed
+ void DoResizeColumnIndices(wxArrayInt& colIndices, unsigned int count);
+
private:
// methods implementing our public API and defined in platform-specific
// implementations
// event handlers
void OnSeparatorDClick(wxHeaderCtrlEvent& event);
+#if wxUSE_MENUS
+ void OnRClick(wxHeaderCtrlEvent& event);
+#endif // wxUSE_MENUS
DECLARE_EVENT_TABLE()
};
protected:
// implement/override base class methods
- virtual wxHeaderColumnBase& GetColumn(unsigned int idx);
+ virtual const wxHeaderColumn& GetColumn(unsigned int idx) const;
virtual bool UpdateColumnWidthToFit(unsigned int idx, int widthTitle);
// and define another one to be overridden in the derived classes: it
unsigned int m_sortKey;
- DECLARE_NO_COPY_CLASS(wxHeaderCtrlSimple)
+ wxDECLARE_NO_COPY_CLASS(wxHeaderCtrlSimple);
};
// ----------------------------------------------------------------------------
: wxNotifyEvent(commandType, winid),
m_col(-1),
m_width(0),
- m_order(static_cast<unsigned int>(-1)),
- m_cancelled(false)
+ m_order(static_cast<unsigned int>(-1))
{
}
: wxNotifyEvent(event),
m_col(event.m_col),
m_width(event.m_width),
- m_order(event.m_order),
- m_cancelled(event.m_cancelled)
+ m_order(event.m_order)
{
}
unsigned int GetNewOrder() const { return m_order; }
void SetNewOrder(unsigned int order) { m_order = order; }
- // was the drag operation cancelled or did it complete successfully?
- bool IsCancelled() const { return m_cancelled; }
- void SetCancelled() { m_cancelled = true; }
-
virtual wxEvent *Clone() const { return new wxHeaderCtrlEvent(*this); }
protected:
// the new column position for end reorder event
unsigned int m_order;
- // was the drag operation cancelled?
- bool m_cancelled;
-
private:
DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHeaderCtrlEvent)
};
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_CLICK;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_RIGHT_CLICK;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_CLICK;
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_CLICK, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_RIGHT_CLICK, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_MIDDLE_CLICK, wxHeaderCtrlEvent );
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_DCLICK;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_RIGHT_DCLICK;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_DCLICK;
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_DCLICK, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_RIGHT_DCLICK, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_MIDDLE_DCLICK, wxHeaderCtrlEvent );
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK;
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK, wxHeaderCtrlEvent );
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_BEGIN_RESIZE;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_RESIZING;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_END_RESIZE;
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_BEGIN_RESIZE, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_RESIZING, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_END_RESIZE, wxHeaderCtrlEvent );
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_BEGIN_REORDER;
-extern WXDLLIMPEXP_CORE const wxEventType wxEVT_COMMAND_HEADER_END_REORDER;
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_BEGIN_REORDER, wxHeaderCtrlEvent );
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_END_REORDER, wxHeaderCtrlEvent );
+
+wxDECLARE_EXPORTED_EVENT( WXDLLIMPEXP_CORE, wxEVT_COMMAND_HEADER_DRAGGING_CANCELLED, wxHeaderCtrlEvent );
typedef void (wxEvtHandler::*wxHeaderCtrlEventFunction)(wxHeaderCtrlEvent&);
#define wxHeaderCtrlEventHandler(func) \
- (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent( \
- wxHeaderCtrlEventFunction, &func)
+ wxEVENT_HANDLER_CAST(wxHeaderCtrlEventFunction, func)
#define wx__DECLARE_HEADER_EVT(evt, id, fn) \
wx__DECLARE_EVT1(wxEVT_COMMAND_HEADER_ ## evt, id, wxHeaderCtrlEventHandler(fn))
#define EVT_HEADER_BEGIN_REORDER(id, fn) wx__DECLARE_HEADER_EVT(BEGIN_REORDER, id, fn)
#define EVT_HEADER_END_REORDER(id, fn) wx__DECLARE_HEADER_EVT(END_REORDER, id, fn)
+#define EVT_HEADER_DRAGGING_CANCELLED(id, fn) wx__DECLARE_HEADER_EVT(DRAGGING_CANCELLED, id, fn)
+
+#endif // wxUSE_HEADERCTRL
+
#endif // _WX_HEADERCTRL_H_
projects / wxWidgets.git / blobdiff