struct CCL::IItemSelection

Overview

Item Selection interface. More…

#include <iitemmodel.h>

struct IItemSelection: public CCL::IUnknown
{
    // methods

    virtual void CCL_API clone (IItemSelection*& selection) const = 0;
    virtual tbool CCL_API isEmpty () const = 0;
    virtual tbool CCL_API isMultiple () const = 0;
    virtual tbool CCL_API isSelected (ItemIndexRef index) const = 0;
    virtual IItemSelectionIterator*CCL_API newIterator () const = 0;
    virtual void CCL_API select (ItemIndexRef index) = 0;
    virtual tbool CCL_API unselect (ItemIndexRef index) = 0;
    virtual void CCL_API unselectAll () = 0;
};

Inherited Members

public:
    // methods

    virtual tresult CCL_API queryInterface (UIDRef iid, void** ptr) = 0;
    virtual unsigned int CCL_API retain () = 0;
    virtual unsigned int CCL_API release () = 0;

Detailed Documentation

Item Selection interface.

Methods

virtual void CCL_API clone (IItemSelection*& selection) const = 0

Clone selection.

virtual tbool CCL_API isEmpty () const = 0

Check if selection is empty.

virtual tbool CCL_API isMultiple () const = 0

Check if multiple items are selected.

virtual tbool CCL_API isSelected (ItemIndexRef index) const = 0

Check if item is selected.

virtual IItemSelectionIterator*CCL_API newIterator () const = 0

Create an iterator over the selected items.

virtual void CCL_API select (ItemIndexRef index) = 0

Add an item to the selection.

virtual tbool CCL_API unselect (ItemIndexRef index) = 0

Remove an item from the selection.

virtual void CCL_API unselectAll () = 0

Unselect all items.