1 /////////////////////////////////////////////////////////////////////////////
2 // Name: wx/mac/carbon/dataview.h
3 // Purpose: wxDataViewCtrl native implementation header
7 // Licence: wxWindows licence
8 /////////////////////////////////////////////////////////////////////////////
10 #ifndef __MACCARBONDATAVIEWCTRL_H__
11 #define __MACCARBONDATAVIEWCTRL_H__
13 #include <Carbon/carbon.h>
16 #include "wx/object.h"
18 #include "wx/control.h"
19 #include "wx/scrolwin.h"
22 // ---------------------------------------------------------
24 // ---------------------------------------------------------
26 class WXDLLIMPEXP_FWD_ADV wxDataViewCtrl
;
28 // ---------------------------------------------------------
30 // ---------------------------------------------------------
32 class WXDLLIMPEXP_ADV wxDataViewRenderer
: public wxDataViewRendererBase
36 // constructors / destructor
38 wxDataViewRenderer(wxString
const& varianttype
, wxDataViewCellMode mode
=wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
41 // inherited methods from wxDataViewRendererBase
43 virtual int GetAlignment(void) const
45 return this->m_alignment
;
47 virtual wxDataViewCellMode
GetMode(void) const
51 virtual bool GetValue(wxVariant
& value
) const
53 value
= this->m_value
;
57 virtual void SetAlignment(int WXUNUSED(align
)) // is always identical to the header alignment
60 virtual void SetMode(wxDataViewCellMode mode
);
61 virtual bool SetValue(wxVariant
const& newValue
)
63 this->m_value
= newValue
;
70 DataBrowserItemDataRef
GetDataReference(void) const
72 return this->m_dataReference
;
74 wxVariant
const& GetValue(void) const
79 virtual DataBrowserPropertyType
GetPropertyType(void) const = 0;
81 virtual bool Render(void) = 0; // a call to the appropriate data browser function filling the data reference with the stored datum;
82 // returns 'true' if the data value could be rendered, 'false' otherwise
84 void SetDataReference(DataBrowserItemDataRef
const& newDataReference
)
86 this->m_dataReference
= newDataReference
;
93 DataBrowserItemDataRef m_dataReference
; // data reference of the data browser; the data will be assigned to this reference during rendering
95 int m_alignment
; // contains the alignment flags
97 wxDataViewCellMode m_mode
; // storing the mode that determines how the cell is going to be shown
99 wxVariant m_value
; // value that is going to be rendered
102 // wxWidget internal stuff
104 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewRenderer
)
107 // ---------------------------------------------------------
108 // wxDataViewCustomRenderer
109 // ---------------------------------------------------------
111 class WXDLLIMPEXP_ADV wxDataViewCustomRenderer
: public wxDataViewRenderer
115 // constructors / destructor
117 wxDataViewCustomRenderer(wxString
const& varianttype
=wxT("string"), wxDataViewCellMode mode
=wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
119 virtual ~wxDataViewCustomRenderer(void);
122 // methods handling render space
124 virtual wxSize
GetSize() const = 0;
127 // methods handling user actions
129 virtual bool Render(wxRect cell
, wxDC
* dc
, int state
) = 0;
131 virtual bool Activate(wxRect
WXUNUSED(cell
), wxDataViewModel
*WXUNUSED(model
), unsigned int WXUNUSED(col
), unsigned int WXUNUSED(row
))
136 virtual bool LeftClick(wxPoint
WXUNUSED(cursor
), wxRect
WXUNUSED(cell
), wxDataViewModel
*WXUNUSED(model
), unsigned int WXUNUSED(col
), unsigned int WXUNUSED(row
))
141 virtual bool RightClick(wxPoint
WXUNUSED(cursor
), wxRect
WXUNUSED(cell
), wxDataViewModel
*WXUNUSED(model
), unsigned int WXUNUSED(col
), unsigned int WXUNUSED(row
))
146 virtual bool StartDrag(wxPoint
WXUNUSED(cursor
), wxRect
WXUNUSED(cell
), wxDataViewModel
*WXUNUSED(model
), unsigned int WXUNUSED(col
), unsigned int WXUNUSED(row
))
154 virtual void CancelEditing()
158 virtual wxControl
* CreateEditorCtrl(wxWindow
* WXUNUSED(parent
), wxRect
WXUNUSED(labelRect
), const wxVariant
& WXUNUSED(value
))
163 virtual bool FinishEditing()
168 wxControl
* GetEditorCtrl(void) const
170 return this->m_editorCtrlPtr
;
172 virtual bool GetValueFromEditorCtrl(wxControl
* WXUNUSED(editor
), wxVariant
& WXUNUSED(value
))
177 virtual bool HasEditorCtrl(void)
182 virtual bool StartEditing(const wxDataViewItem
&WXUNUSED(item
), wxRect
WXUNUSED(labelRect
))
188 // device context handling
190 virtual wxDC
* GetDC(void); // creates a device context and keeps it
195 virtual bool Render(void); // declared in wxDataViewRenderer but will not be used here, therefore calling this function will
196 // return 'true' without having done anything
198 virtual DataBrowserPropertyType
GetPropertyType(void) const
200 return kDataBrowserCustomType
;
203 void SetDC(wxDC
* newDCPtr
); // this method takes ownership of the pointer
210 wxControl
* m_editorCtrlPtr
; // pointer to an in-place editor control
215 // wxWidget internal stuff
217 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCustomRenderer
)
220 // ---------------------------------------------------------
221 // wxDataViewTextRenderer
222 // ---------------------------------------------------------
224 class WXDLLIMPEXP_ADV wxDataViewTextRenderer
: public wxDataViewRenderer
228 // constructors / destructor
230 wxDataViewTextRenderer(wxString
const& varianttype
=wxT("string"), wxDataViewCellMode mode
=wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
233 // inherited functions from wxDataViewRenderer
235 virtual bool Render(void);
240 virtual DataBrowserPropertyType
GetPropertyType(void) const
242 return kDataBrowserTextType
;
247 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewTextRenderer
)
250 // ---------------------------------------------------------
251 // wxDataViewBitmapRenderer
252 // ---------------------------------------------------------
254 class WXDLLIMPEXP_ADV wxDataViewBitmapRenderer
: public wxDataViewRenderer
258 // constructors / destructor
260 wxDataViewBitmapRenderer(wxString
const& varianttype
=wxT("wxBitmap"), wxDataViewCellMode mode
=wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
263 // inherited functions from wxDataViewRenderer
265 virtual bool Render(void);
270 virtual DataBrowserPropertyType
GetPropertyType(void) const
272 return kDataBrowserIconType
;
277 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewBitmapRenderer
)
280 // ---------------------------------------------------------
281 // wxDataViewToggleRenderer
282 // ---------------------------------------------------------
284 class WXDLLIMPEXP_ADV wxDataViewIconTextRenderer
: public wxDataViewRenderer
287 wxDataViewIconTextRenderer(wxString
const& varianttype
= wxT("wxDataViewIconText"), wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
290 // inherited functions from wxDataViewRenderer
292 virtual bool Render(void);
297 virtual DataBrowserPropertyType
GetPropertyType(void) const
299 return kDataBrowserIconAndTextType
;
304 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewIconTextRenderer
)
307 // ---------------------------------------------------------
308 // wxDataViewToggleRenderer
309 // ---------------------------------------------------------
311 class WXDLLIMPEXP_ADV wxDataViewToggleRenderer
: public wxDataViewRenderer
314 wxDataViewToggleRenderer(wxString
const& varianttype
= wxT("bool"), wxDataViewCellMode mode
= wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
317 // inherited functions from wxDataViewRenderer
319 virtual bool Render(void);
324 virtual DataBrowserPropertyType
GetPropertyType(void) const
326 return kDataBrowserCheckboxType
;
331 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewToggleRenderer
)
334 // ---------------------------------------------------------
335 // wxDataViewProgressRenderer
336 // ---------------------------------------------------------
338 class WXDLLIMPEXP_ADV wxDataViewProgressRenderer
: public wxDataViewRenderer
341 wxDataViewProgressRenderer(wxString
const& label
= wxEmptyString
, wxString
const& varianttype
=wxT("long"),
342 wxDataViewCellMode mode
=wxDATAVIEW_CELL_INERT
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
345 // inherited functions from wxDataViewRenderer
347 virtual bool Render(void);
352 virtual DataBrowserPropertyType
GetPropertyType(void) const
354 return kDataBrowserProgressBarType
;
359 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewProgressRenderer
)
362 // ---------------------------------------------------------
363 // wxDataViewDateRenderer
364 // ---------------------------------------------------------
366 class WXDLLIMPEXP_ADV wxDataViewDateRenderer
: public wxDataViewRenderer
369 wxDataViewDateRenderer(wxString
const& varianttype
=wxT("datetime"), wxDataViewCellMode mode
=wxDATAVIEW_CELL_ACTIVATABLE
, int align
=wxDVR_DEFAULT_ALIGNMENT
);
372 // inherited functions from wxDataViewRenderer
374 virtual bool Render(void);
379 virtual DataBrowserPropertyType
GetPropertyType(void) const
381 return kDataBrowserDateTimeType
;
386 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewDateRenderer
)
389 // ---------------------------------------------------------
391 // ---------------------------------------------------------
393 class WXDLLIMPEXP_ADV wxDataViewColumn
: public wxDataViewColumnBase
397 // constructors / destructor
399 wxDataViewColumn(wxString
const& title
, wxDataViewRenderer
* renderer
, unsigned int model_column
, int width
=80, wxAlignment align
=wxALIGN_CENTER
,
400 int flags
=wxDATAVIEW_COL_RESIZABLE
);
401 wxDataViewColumn(wxBitmap
const& bitmap
, wxDataViewRenderer
* renderer
, unsigned int model_column
, int width
=80, wxAlignment align
=wxALIGN_CENTER
,
402 int flags
=wxDATAVIEW_COL_RESIZABLE
);
405 // inherited methods from wxDataViewColumnBase
407 virtual wxAlignment
GetAlignment(void) const
409 return this->m_alignment
;
411 virtual int GetFlags(void) const
413 return this->m_flags
;
415 virtual int GetMaxWidth(void) const
417 return this->m_maxWidth
;
419 virtual int GetMinWidth(void) const
421 return this->m_minWidth
;
423 virtual wxString
GetTitle(void) const
425 return this->m_title
;
427 virtual int GetWidth(void) const
429 return this->m_width
;
432 virtual bool IsHidden(void) const
434 return false; // not implemented
436 virtual bool IsResizeable(void) const
438 return ((this->m_flags
& wxDATAVIEW_COL_RESIZABLE
) != 0);
440 virtual bool IsSortable(void) const
442 return ((this->m_flags
& wxDATAVIEW_COL_SORTABLE
) != 0);
444 virtual bool IsSortOrderAscending(void) const
446 return this->m_ascending
;
449 virtual void SetAlignment(wxAlignment align
);
450 virtual void SetBitmap (wxBitmap
const& bitmap
);
451 virtual void SetFlags (int flags
);
452 virtual void SetHidden(bool WXUNUSED(hidden
))
455 virtual void SetMaxWidth (int maxWidth
);
456 virtual void SetMinWidth (int minWidth
);
457 virtual void SetResizeable(bool resizeable
);
458 virtual void SetSortable (bool sortable
);
459 virtual void SetSortOrder (bool ascending
);
460 virtual void SetTitle (wxString
const& title
);
461 virtual void SetWidth (int width
);
466 DataBrowserPropertyID
GetPropertyID(void) const
468 return this->m_propertyID
;
471 void SetPropertyID(DataBrowserPropertyID newID
)
473 this->m_propertyID
= newID
;
481 bool m_ascending
; // sorting order
483 DataBrowserPropertyID m_propertyID
; // each column is identified by its unique property ID (NOT by the column index)
485 int m_flags
; // flags for the column
486 int m_maxWidth
; // maximum width for the column
487 int m_minWidth
; // minimum width for the column
488 int m_width
; // column width
490 wxAlignment m_alignment
; // column header alignment
492 wxString m_title
; // column title
494 // wxWidget internal stuff:
495 DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumn
)
498 // ---------------------------------------------------------
500 // ---------------------------------------------------------
501 class WXDLLIMPEXP_ADV wxDataViewCtrl
: public wxDataViewCtrlBase
504 // Constructors / destructor:
509 wxDataViewCtrl(wxWindow
*parent
, wxWindowID id
, wxPoint
const& pos
= wxDefaultPosition
, wxSize
const& size
= wxDefaultSize
, long style
= 0,
510 wxValidator
const& validator
= wxDefaultValidator
)
513 this->Create(parent
, id
, pos
, size
, style
, validator
);
516 // explicit control creation
517 bool Create(wxWindow
*parent
, wxWindowID id
, wxPoint
const& pos
=wxDefaultPosition
, wxSize
const& size
=wxDefaultSize
, long style
=0,
518 wxValidator
const& validator
=wxDefaultValidator
);
520 virtual wxControl
* GetMainWindow(void) // should disappear as it is not of any use for the native implementation
525 // inherited methods from 'wxDataViewCtrlBase':
526 virtual bool AssociateModel(wxDataViewModel
* model
);
528 virtual bool AppendColumn(wxDataViewColumn
* columnPtr
);
529 virtual bool ClearColumns(void);
530 virtual bool DeleteColumn(wxDataViewColumn
* columnPtr
);
531 virtual wxDataViewColumn
* GetColumn(unsigned int pos
) const;
532 virtual unsigned int GetColumnCount(void) const;
534 virtual void Collapse(wxDataViewItem
const& item
);
535 virtual void EnsureVisible(wxDataViewItem
const& item
, wxDataViewColumn
const* columnPtr
=NULL
);
536 virtual void Expand(wxDataViewItem
const& item
);
538 virtual unsigned int GetCount(void) const;
539 virtual wxRect
GetItemRect(wxDataViewItem
const& item
, wxDataViewColumn
const* columnPtr
) const;
540 virtual wxDataViewItem
GetSelection(void) const;
541 virtual int GetSelections(wxDataViewItemArray
& sel
) const;
543 virtual void HitTest(wxPoint
const& point
, wxDataViewItem
& item
, wxDataViewColumn
*& columnPtr
) const;
545 virtual bool IsSelected(wxDataViewItem
const& item
) const;
547 virtual void SelectAll(void);
548 virtual void Select(wxDataViewItem
const& item
);
549 virtual void SetSelections(wxDataViewItemArray
const& sel
);
551 virtual void Unselect(wxDataViewItem
const& item
);
552 virtual void UnselectAll(void);
558 // adds all children of the passed parent to the control; if 'parentItem' is invalid the root(s) is/are added:
559 void AddChildrenLevel(wxDataViewItem
const& parentItem
);
561 // returns a pointer to a column;
562 // in case the pointer cannot be found NULL is returned:
563 wxDataViewColumn
* GetColumnPtr(DataBrowserPropertyID propertyID
) const;
565 // checks if currently a delete process is running:
566 bool IsDeleting(void) const
568 return this->m_Deleting
;
571 // with CG, we need to get the context from an kEventControlDraw event
572 // unfortunately, the DataBrowser callbacks don't provide the context
573 // and we need it, so we need to set/remove it before and after draw
574 // events so we can access it in the callbacks.
575 void MacSetDrawingContext(void* context
)
577 this->m_cgContext
= context
;
579 void* MacGetDrawingContext(void) const
581 return this->m_cgContext
;
584 /// sets the flag indicating a deletion process:
585 void SetDeleting(bool deleting
)
587 this->m_Deleting
= deleting
;
591 // inherited methods from wxDataViewCtrlBase:
592 virtual void DoSetExpanderColumn(void);
593 virtual void DoSetIndent(void);
596 void OnSize(wxSizeEvent
&event
);
600 WX_DECLARE_HASH_MAP(DataBrowserPropertyID
,wxDataViewColumn
*,wxIntegerHash
,wxIntegerEqual
,ColumnPointerHashMapType
);
602 // initializing of local variables:
609 bool m_Deleting
; // flag indicating if a delete process is running; this flag is necessary because the notifier indicating an item deletion in the model may be called
610 // after the actual deletion of the item; then, the callback function "wxMacDataViewDataBrowserListViewControl::DataBrowserGetSetItemDataProc" may
611 // try to update data into variables that are already deleted; this flag will ignore all variable update requests during item deletion
613 void* m_cgContext
; // pointer to core graphics context
615 ColumnPointerHashMapType m_ColumnPointers
; // all column pointers are stored in a hash map with the property ID as a key
617 // wxWidget internal stuff:
618 DECLARE_DYNAMIC_CLASS(wxDataViewCtrl
)
619 DECLARE_NO_COPY_CLASS(wxDataViewCtrl
)
620 DECLARE_EVENT_TABLE()
624 #endif // __MACDATAVIEWCTRL_H__