Version: 3.1.3
wxDataViewCheckIconTextRenderer Class Reference

#include <wx/dataview.h>

+ Inheritance diagram for wxDataViewCheckIconTextRenderer:

Detailed Description

This renderer class shows a checkbox in addition to the icon and text shown by the base class and also allows the user to toggle this checkbox.

By default this class doesn't allow the user to put the checkbox into the third, i.e. indeterminate, state, even though it can display the state if the program returns the corresponding value from the associated model. Call Allow3rdStateForUser() explicitly if the user should be able to select the 3rd state interactively too.

This class is used internally by wxTreeListCtrl, and can be seen in action in the corresponding sample.

See also
wxDataViewIconTextRenderer, wxDataViewToggleRenderer

Library:  wxCore
Category:  wxDataViewCtrl Related Classes
Since
3.1.1

Public Member Functions

 wxDataViewCheckIconTextRenderer (wxDataViewCellMode mode=wxDATAVIEW_CELL_ACTIVATABLE, int align=wxDVR_DEFAULT_ALIGNMENT)
 Create a new renderer. More...
 
void Allow3rdStateForUser (bool allow=true)
 Allow the user to interactively select the 3rd state for the items rendered by this object. More...
 
- Public Member Functions inherited from wxDataViewRenderer
 wxDataViewRenderer (const wxString &varianttype, wxDataViewCellMode mode=wxDATAVIEW_CELL_INERT, int align=wxDVR_DEFAULT_ALIGNMENT)
 Constructor. More...
 
void EnableEllipsize (wxEllipsizeMode mode=wxELLIPSIZE_MIDDLE)
 Enable or disable replacing parts of the item text with ellipsis to make it fit the column width. More...
 
void DisableEllipsize ()
 Disable replacing parts of the item text with ellipsis. More...
 
virtual wxString GetAccessibleDescription () const =0
 This method returns a string describing the content of the renderer to the class implementing accessibility features in wxDataViewCtrl. More...
 
virtual int GetAlignment () const
 Returns the alignment. More...
 
wxEllipsizeMode GetEllipsizeMode () const
 Returns the ellipsize mode used by the renderer. More...
 
virtual wxDataViewCellMode GetMode () const
 Returns the cell mode. More...
 
wxDataViewColumnGetOwner () const
 Returns pointer to the owning wxDataViewColumn. More...
 
virtual bool GetValue (wxVariant &value) const =0
 This methods retrieves the value from the renderer in order to transfer the value back to the data model. More...
 
wxString GetVariantType () const
 Returns a string with the type of the wxVariant supported by this renderer. More...
 
virtual void SetAlignment (int align)
 Sets the alignment of the renderer's content. More...
 
void SetOwner (wxDataViewColumn *owner)
 Sets the owning wxDataViewColumn. More...
 
virtual bool SetValue (const wxVariant &value)=0
 Set the value of the renderer (and thus its cell) to value. More...
 
void SetValueAdjuster (wxDataViewValueAdjuster *transformer)
 Set the transformer object to be used to customize values before they are rendered. More...
 
virtual bool Validate (wxVariant &value)
 Before data is committed to the data model, it is passed to this method where it can be checked for validity. More...
 
virtual bool HasEditorCtrl () const
 
virtual wxWindowCreateEditorCtrl (wxWindow *parent, wxRect labelRect, const wxVariant &value)
 
virtual bool GetValueFromEditorCtrl (wxWindow *editor, wxVariant &value)
 
virtual bool StartEditing (const wxDataViewItem &item, wxRect labelRect)
 
virtual void CancelEditing ()
 
virtual bool FinishEditing ()
 
wxWindowGetEditorCtrl ()
 
- Public Member Functions inherited from wxObject
 wxObject ()
 Default ctor; initializes to NULL the internal reference data. More...
 
 wxObject (const wxObject &other)
 Copy ctor. More...
 
virtual ~wxObject ()
 Destructor. More...
 
virtual wxClassInfoGetClassInfo () const
 This virtual function is redefined for every class that requires run-time type information, when using the wxDECLARE_CLASS macro (or similar). More...
 
wxObjectRefDataGetRefData () const
 Returns the wxObject::m_refData pointer, i.e. the data referenced by this object. More...
 
bool IsKindOf (const wxClassInfo *info) const
 Determines whether this class is a subclass of (or the same class as) the given class. More...
 
bool IsSameAs (const wxObject &obj) const
 Returns true if this object has the same data pointer as obj. More...
 
void Ref (const wxObject &clone)
 Makes this object refer to the data in clone. More...
 
void SetRefData (wxObjectRefData *data)
 Sets the wxObject::m_refData pointer. More...
 
void UnRef ()
 Decrements the reference count in the associated data, and if it is zero, deletes the data. More...
 
void UnShare ()
 This is the same of AllocExclusive() but this method is public. More...
 
void operator delete (void *buf)
 The delete operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 
void * operator new (size_t size, const wxString &filename=NULL, int lineNum=0)
 The new operator is defined for debugging versions of the library only, when the identifier WXDEBUG is defined. More...
 

Static Public Member Functions

static wxString GetDefaultType ()
 

Additional Inherited Members

- Protected Member Functions inherited from wxDataViewRenderer
wxDataViewCtrlGetView () const
 
- Protected Member Functions inherited from wxObject
void AllocExclusive ()
 Ensure that this object's data is not shared with any other object. More...
 
virtual wxObjectRefDataCreateRefData () const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and returns it. More...
 
virtual wxObjectRefDataCloneRefData (const wxObjectRefData *data) const
 Creates a new instance of the wxObjectRefData-derived class specific to this object and initializes it copying data. More...
 
- Protected Attributes inherited from wxObject
wxObjectRefDatam_refData
 Pointer to an object which is the object's reference-counted data. More...
 

Constructor & Destructor Documentation

wxDataViewCheckIconTextRenderer::wxDataViewCheckIconTextRenderer ( wxDataViewCellMode  mode = wxDATAVIEW_CELL_ACTIVATABLE,
int  align = wxDVR_DEFAULT_ALIGNMENT 
)
explicit

Create a new renderer.

By default the renderer is activatable, i.e. allows the user to toggle the checkbox.

Member Function Documentation

void wxDataViewCheckIconTextRenderer::Allow3rdStateForUser ( bool  allow = true)

Allow the user to interactively select the 3rd state for the items rendered by this object.

As described in the class overview, this renderer can always display the 3rd ("indeterminate") checkbox state if the model contains cells with wxCHK_UNDETERMINED value, but it doesn't allow the user to set it by default. Call this method to allow this to happen.

Parameters
allowIf true, interactively clicking a checked cell switches it to the indeterminate value and clicking it again unchecks it. If false, clicking a checked cell switches to the unchecked value, skipping the indeterminate one.
static wxString wxDataViewCheckIconTextRenderer::GetDefaultType ( )
inlinestatic