1 ///////////////////////////////////////////////////////////////////////////////
2 // Name: wx/headerctrl.h
3 // Purpose: wxHeaderCtrlBase class: interface of wxHeaderCtrl
4 // Author: Vadim Zeitlin
7 // Copyright: (c) 2008 Vadim Zeitlin <vadim@wxwidgets.org>
8 // Licence: wxWindows licence
9 ///////////////////////////////////////////////////////////////////////////////
11 #ifndef _WX_HEADERCTRL_H_
12 #define _WX_HEADERCTRL_H_
14 #include "wx/control.h"
16 #include "wx/dynarray.h"
17 #include "wx/vector.h"
19 #include "wx/headercol.h"
21 // notice that the classes in this header are defined in the core library even
22 // although currently they're only used by wxGrid which is in wxAdv because we
23 // plan to use it in wxListCtrl which is in core too in the future
24 class WXDLLIMPEXP_FWD_CORE wxHeaderCtrlEvent
;
26 // ----------------------------------------------------------------------------
28 // ----------------------------------------------------------------------------
32 // allow column drag and drop
33 wxHD_DRAGDROP
= 0x0001,
35 // style used by default when creating the control
36 wxHD_DEFAULT_STYLE
= wxHD_DRAGDROP
39 extern WXDLLIMPEXP_DATA_CORE(const char) wxHeaderCtrlNameStr
[];
41 // ----------------------------------------------------------------------------
42 // wxHeaderCtrlBase defines the interface of a header control
43 // ----------------------------------------------------------------------------
45 class WXDLLIMPEXP_CORE wxHeaderCtrlBase
: public wxControl
49 Derived classes must provide default ctor as well as a ctor and
50 Create() function with the following signatures:
52 wxHeaderCtrl(wxWindow *parent,
53 wxWindowID winid = wxID_ANY,
54 const wxPoint& pos = wxDefaultPosition,
55 const wxSize& size = wxDefaultSize,
56 long style = wxHD_DEFAULT_STYLE,
57 const wxString& name = wxHeaderCtrlNameStr);
59 bool Create(wxWindow *parent,
60 wxWindowID winid = wxID_ANY,
61 const wxPoint& pos = wxDefaultPosition,
62 const wxSize& size = wxDefaultSize,
63 long style = wxHD_DEFAULT_STYLE,
64 const wxString& name = wxHeaderCtrlNameStr);
67 // column-related methods
68 // ----------------------
70 // set the number of columns in the control
72 // this also calls UpdateColumn() for all columns
73 void SetColumnCount(unsigned int count
) { DoSetCount(count
); }
75 // return the number of columns in the control as set by SetColumnCount()
76 unsigned int GetColumnCount() const { return DoGetCount(); }
78 // return whether the control has any columns
79 bool IsEmpty() const { return DoGetCount() == 0; }
81 // update the column with the given index
82 void UpdateColumn(unsigned int idx
)
84 wxCHECK_RET( idx
< GetColumnCount(), "invalid column index" );
89 // set the columns order: the array defines the column index which appears
90 // the given position, it must have GetColumnCount() elements and contain
91 // all indices exactly once
92 void SetColumnsOrder(const wxArrayInt
& order
);
93 wxArrayInt
GetColumnsOrder() const;
95 // get the index of the column at the given display position
96 unsigned int GetColumnAt(unsigned int pos
) const;
98 // get the position at which this column is currently displayed
99 unsigned int GetColumnPos(unsigned int idx
) const;
102 // implementation only from now on
103 // -------------------------------
105 // the user doesn't need to TAB to this control
106 virtual bool AcceptsFocusFromKeyboard() const { return false; }
108 // this method is only overridden in order to synchronize the control with
109 // the main window when it is scrolled, the derived class must implement
111 virtual void ScrollWindow(int dx
, int dy
, const wxRect
*rect
= NULL
);
114 // this method must be implemented by the derived classes to return the
115 // information for the given column
116 virtual wxHeaderColumnBase
& GetColumn(unsigned int idx
) = 0;
118 // this method is called from the default EVT_HEADER_SEPARATOR_DCLICK
119 // handler to update the fitting column width of the given column, it
120 // should return true if the width was really updated
121 virtual bool UpdateColumnWidthToFit(unsigned int WXUNUSED(idx
),
122 int WXUNUSED(widthTitle
))
128 // methods implementing our public API and defined in platform-specific
130 virtual void DoSetCount(unsigned int count
) = 0;
131 virtual unsigned int DoGetCount() const = 0;
132 virtual void DoUpdate(unsigned int idx
) = 0;
134 virtual void DoScrollHorz(int dx
) = 0;
136 virtual void DoSetColumnsOrder(const wxArrayInt
& order
) = 0;
137 virtual wxArrayInt
DoGetColumnsOrder() const = 0;
139 // this window doesn't look nice with the border so don't use it by default
140 virtual wxBorder
GetDefaultBorder() const { return wxBORDER_NONE
; }
143 void OnSeparatorDClick(wxHeaderCtrlEvent
& event
);
145 DECLARE_EVENT_TABLE()
148 // ----------------------------------------------------------------------------
149 // wxHeaderCtrl: port-specific header control implementation, notice that this
150 // is still an ABC which is meant to be used as part of another
151 // control, see wxHeaderCtrlSimple for a standalone version
152 // ----------------------------------------------------------------------------
154 #if defined(__WXMSW__) && !defined(__WXUNIVERSAL__)
155 #include "wx/msw/headerctrl.h"
157 #define wxHAS_GENERIC_HEADERCTRL
158 #include "wx/generic/headerctrlg.h"
161 // ----------------------------------------------------------------------------
162 // wxHeaderCtrlSimple: concrete header control which can be used standalone
163 // ----------------------------------------------------------------------------
165 class WXDLLIMPEXP_CORE wxHeaderCtrlSimple
: public wxHeaderCtrl
171 wxHeaderCtrlSimple() { Init(); }
172 wxHeaderCtrlSimple(wxWindow
*parent
,
173 wxWindowID winid
= wxID_ANY
,
174 const wxPoint
& pos
= wxDefaultPosition
,
175 const wxSize
& size
= wxDefaultSize
,
176 long style
= wxHD_DEFAULT_STYLE
,
177 const wxString
& name
= wxHeaderCtrlNameStr
)
181 Create(parent
, winid
, pos
, size
, style
, name
);
184 // managing the columns
185 // --------------------
187 // insert the column at the given position, using GetColumnCount() as
188 // position appends it at the end
189 void InsertColumn(const wxHeaderColumnSimple
& col
, unsigned int idx
)
191 wxCHECK_RET( idx
<= GetColumnCount(), "invalid column index" );
196 // append the column to the end of the control
197 void AppendColumn(const wxHeaderColumnSimple
& col
)
199 DoInsert(col
, GetColumnCount());
202 // delete the column at the given index
203 void DeleteColumn(unsigned int idx
)
205 wxCHECK_RET( idx
< GetColumnCount(), "invalid column index" );
210 // delete all the existing columns
211 void DeleteAllColumns();
217 // show or hide the column, notice that even when a column is hidden we
218 // still account for it when using indices
219 void ShowColumn(unsigned int idx
, bool show
= true)
221 wxCHECK_RET( idx
< GetColumnCount(), "invalid column index" );
223 DoShowColumn(idx
, show
);
226 void HideColumn(unsigned int idx
)
228 ShowColumn(idx
, false);
231 // indicate that the column is used for sorting
232 void ShowSortIndicator(unsigned int idx
, bool ascending
= true)
234 wxCHECK_RET( idx
< GetColumnCount(), "invalid column index" );
236 DoShowSortIndicator(idx
, ascending
);
239 // remove the sort indicator completely
240 void RemoveSortIndicator();
243 // implement/override base class methods
244 virtual wxHeaderColumnBase
& GetColumn(unsigned int idx
);
245 virtual bool UpdateColumnWidthToFit(unsigned int idx
, int widthTitle
);
247 // and define another one to be overridden in the derived classes: it
248 // should return the best width for the given column contents or -1 if not
249 // implemented, we use it to implement UpdateColumnWidthToFit()
250 virtual int GetBestFittingWidth(unsigned int WXUNUSED(idx
)) const
256 // functions implementing our public API
257 void DoInsert(const wxHeaderColumnSimple
& col
, unsigned int idx
);
258 void DoDelete(unsigned int idx
);
259 void DoShowColumn(unsigned int idx
, bool show
);
260 void DoShowSortIndicator(unsigned int idx
, bool ascending
);
262 // common part of all ctors
265 // bring the column count in sync with the number of columns we store
266 void UpdateColumnCount() { SetColumnCount(m_cols
.size()); }
269 // all our current columns
270 typedef wxVector
<wxHeaderColumnSimple
> Columns
;
273 // the column currently used for sorting or -1 if none
274 unsigned int m_sortKey
;
277 DECLARE_NO_COPY_CLASS(wxHeaderCtrlSimple
)
280 // ----------------------------------------------------------------------------
281 // wxHeaderCtrl events
282 // ----------------------------------------------------------------------------
284 class WXDLLIMPEXP_CORE wxHeaderCtrlEvent
: public wxNotifyEvent
287 wxHeaderCtrlEvent(wxEventType commandType
= wxEVT_NULL
, int winid
= 0)
288 : wxNotifyEvent(commandType
, winid
),
291 m_order(static_cast<unsigned int>(-1)),
296 wxHeaderCtrlEvent(const wxHeaderCtrlEvent
& event
)
297 : wxNotifyEvent(event
),
299 m_width(event
.m_width
),
300 m_order(event
.m_order
),
301 m_cancelled(event
.m_cancelled
)
305 // the column which this event pertains to: valid for all header events
306 int GetColumn() const { return m_col
; }
307 void SetColumn(int col
) { m_col
= col
; }
309 // the width of the column: valid for column resizing/dragging events only
310 int GetWidth() const { return m_width
; }
311 void SetWidth(int width
) { m_width
= width
; }
313 // the new position of the column: for end reorder events only
314 unsigned int GetNewOrder() const { return m_order
; }
315 void SetNewOrder(unsigned int order
) { m_order
= order
; }
317 // was the drag operation cancelled or did it complete successfully?
318 bool IsCancelled() const { return m_cancelled
; }
319 void SetCancelled() { m_cancelled
= true; }
321 virtual wxEvent
*Clone() const { return new wxHeaderCtrlEvent(*this); }
324 // the column affected by the event
327 // the current width for the dragging events
330 // the new column position for end reorder event
331 unsigned int m_order
;
333 // was the drag operation cancelled?
337 DECLARE_DYNAMIC_CLASS_NO_ASSIGN(wxHeaderCtrlEvent
)
341 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_CLICK
;
342 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_RIGHT_CLICK
;
343 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_CLICK
;
345 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_DCLICK
;
346 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_RIGHT_DCLICK
;
347 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_MIDDLE_DCLICK
;
349 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_SEPARATOR_DCLICK
;
351 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_BEGIN_RESIZE
;
352 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_RESIZING
;
353 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_END_RESIZE
;
355 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_BEGIN_REORDER
;
356 extern WXDLLIMPEXP_CORE
const wxEventType wxEVT_COMMAND_HEADER_END_REORDER
;
358 typedef void (wxEvtHandler::*wxHeaderCtrlEventFunction
)(wxHeaderCtrlEvent
&);
360 #define wxHeaderCtrlEventHandler(func) \
361 (wxObjectEventFunction)(wxEventFunction)wxStaticCastEvent( \
362 wxHeaderCtrlEventFunction, &func)
364 #define wx__DECLARE_HEADER_EVT(evt, id, fn) \
365 wx__DECLARE_EVT1(wxEVT_COMMAND_HEADER_ ## evt, id, wxHeaderCtrlEventHandler(fn))
367 #define EVT_HEADER_CLICK(id, fn) wx__DECLARE_HEADER_EVT(CLICK, id, fn)
368 #define EVT_HEADER_RIGHT_CLICK(id, fn) wx__DECLARE_HEADER_EVT(RIGHT_CLICK, id, fn)
369 #define EVT_HEADER_MIDDLE_CLICK(id, fn) wx__DECLARE_HEADER_EVT(MIDDLE_CLICK, id, fn)
371 #define EVT_HEADER_DCLICK(id, fn) wx__DECLARE_HEADER_EVT(DCLICK, id, fn)
372 #define EVT_HEADER_RIGHT_DCLICK(id, fn) wx__DECLARE_HEADER_EVT(RIGHT_DCLICK, id, fn)
373 #define EVT_HEADER_MIDDLE_DCLICK(id, fn) wx__DECLARE_HEADER_EVT(MIDDLE_DCLICK, id, fn)
375 #define EVT_HEADER_SEPARATOR_DCLICK(id, fn) wx__DECLARE_HEADER_EVT(SEPARATOR_DCLICK, id, fn)
377 #define EVT_HEADER_BEGIN_RESIZE(id, fn) wx__DECLARE_HEADER_EVT(BEGIN_RESIZE, id, fn)
378 #define EVT_HEADER_RESIZING(id, fn) wx__DECLARE_HEADER_EVT(RESIZING, id, fn)
379 #define EVT_HEADER_END_RESIZE(id, fn) wx__DECLARE_HEADER_EVT(END_RESIZE, id, fn)
381 #define EVT_HEADER_BEGIN_REORDER(id, fn) wx__DECLARE_HEADER_EVT(BEGIN_REORDER, id, fn)
382 #define EVT_HEADER_END_REORDER(id, fn) wx__DECLARE_HEADER_EVT(END_REORDER, id, fn)
384 #endif // _WX_HEADERCTRL_H_