wxWidgets/include/wx/dataview.h

/////////////////////////////////////////////////////////////////////////////
// Name:        wx/dataview.h
// Purpose:     wxDataViewCtrl base classes
// Author:      Robert Roebling
// Modified by:
// Created:     08.01.06
// RCS-ID:      $Id$
// Copyright:   (c) Robert Roebling
// Licence:     wxWindows licence
/////////////////////////////////////////////////////////////////////////////

#ifndef _WX_DATAVIEW_H_BASE_
#define _WX_DATAVIEW_H_BASE_

#include "wx/defs.h"

#if wxUSE_DATAVIEWCTRL

#include "wx/control.h"
#include "wx/textctrl.h"
#include "wx/bitmap.h"
#include "wx/variant.h"

// ----------------------------------------------------------------------------
// wxDataViewCtrl flags 
// ----------------------------------------------------------------------------

// ----------------------------------------------------------------------------
// wxDataViewCtrl globals
// ----------------------------------------------------------------------------

class WXDLLIMPEXP_CORE wxDataViewCtrl;
class WXDLLIMPEXP_CORE wxDataViewColumn;
class WXDLLIMPEXP_CORE wxDataViewCell;

extern WXDLLEXPORT_DATA(const wxChar) wxDataViewCtrlNameStr[];

// --------------------------------------------------------- 
// wxDataViewModel
// --------------------------------------------------------- 

class wxDataViewModel: public wxObject
{
public:
    wxDataViewModel() { }
    virtual ~wxDataViewModel() { }
    
protected:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewModel)
};

// --------------------------------------------------------- 
// wxDataViewListModelNotifier
// --------------------------------------------------------- 

class wxDataViewListModelNotifier
{
public:
    wxDataViewListModelNotifier() { }
    virtual ~wxDataViewListModelNotifier() { }
    
    virtual bool RowAppended() = 0;
    virtual bool RowPrepended() = 0;
    virtual bool RowInserted( size_t before ) = 0;
    virtual bool RowDeleted( size_t row ) = 0;
    virtual bool RowChanged( size_t row ) = 0;
    virtual bool ValueChanged( size_t col, size_t row ) = 0;
    virtual bool Cleared() = 0;
    virtual bool ValueChanged( wxDataViewColumn *view_column, size_t model_column, size_t row ) = 0;
};

// --------------------------------------------------------- 
// wxDataViewListModel
// --------------------------------------------------------- 

class wxDataViewListModel: public wxDataViewModel
{
public:
    wxDataViewListModel();
    virtual ~wxDataViewListModel();

    virtual size_t GetNumberOfRows() = 0;
    virtual size_t GetNumberOfCols() = 0;
    // return type as reported by wxVariant
    virtual wxString GetColType( size_t col ) = 0;
    // get value into a wxVariant
    virtual wxVariant GetValue( size_t col, size_t row ) = 0;
    // set value, call ValueChanged() afterwards!
    virtual bool SetValue( wxVariant &variant, size_t col, size_t row ) = 0;

    // delegated notifiers
    bool RowAppended();
    bool RowPrepended();
    bool RowInserted( size_t before );
    bool RowDeleted( size_t row );
    bool RowChanged( size_t row );
    bool ValueChanged( size_t col, size_t row );
    bool Cleared();

    // Used internally    
    void AddViewingColumn( wxDataViewColumn *view_column, size_t model_column );
    void RemoveViewingColumn( wxDataViewColumn *column );
    
    // Used internally    
    void SetNotifier( wxDataViewListModelNotifier *notifier );
    wxDataViewListModelNotifier* GetNotifier();
    
private:
    wxDataViewListModelNotifier *m_notifier;
    wxList                       m_viewingColumns;

protected:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewListModel)
};

// --------------------------------------------------------- 
// wxDataViewCellBase
// --------------------------------------------------------- 

enum wxDataViewCellMode
{
    wxDATAVIEW_CELL_INERT,
    wxDATAVIEW_CELL_ACTIVATABLE,
    wxDATAVIEW_CELL_EDITABLE
};

enum wxDataViewCellRenderState
{
    wxDATAVIEW_CELL_SELECTED    = 1,
    wxDATAVIEW_CELL_PRELIT      = 2,
    wxDATAVIEW_CELL_INSENSITIVE = 4,
    wxDATAVIEW_CELL_FOCUSED     = 8
};

class wxDataViewCellBase: public wxObject
{
public:
    wxDataViewCellBase( const wxString &varianttype, wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT );

    virtual bool SetValue( const wxVariant &value ) { return true; }
    virtual bool GetValue( wxVariant &value )       { return true; }
    virtual bool Validate( wxVariant &value )       { return true; }
    
    wxString GetVariantType()   { return m_variantType; }
    
    void SetOwner( wxDataViewColumn *owner )    { m_owner = owner; }
    wxDataViewColumn* GetOwner()                { return m_owner; }
    
protected:
    wxDataViewCellMode      m_mode;
    wxString                m_variantType;
    wxDataViewColumn       *m_owner;

protected:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCellBase)
};

// --------------------------------------------------------- 
// wxDataViewColumnBase
// --------------------------------------------------------- 

enum wxDataViewColumnFlags
{
    wxDATAVIEW_COL_RESIZABLE  = 1,
    wxDATAVIEW_COL_SORTABLE   = 2,
    wxDATAVIEW_COL_HIDDEN     = 4
};

class wxDataViewColumnBase: public wxObject
{
public:
    wxDataViewColumnBase( const wxString &title, wxDataViewCell *cell, size_t model_column, int flags = 0 );
    ~wxDataViewColumnBase();

    virtual void SetTitle( const wxString &title );
    virtual wxString GetTitle();
    
    wxDataViewCell* GetCell()               { return m_cell; }
    
    size_t GetModelColumn()                 { return m_model_column; }
    
    void SetOwner( wxDataViewCtrl *owner )  { m_owner = owner; }
    wxDataViewCtrl *GetOwner()              { return m_owner; }

private:
    wxDataViewCtrl          *m_ctrl;
    wxDataViewCell          *m_cell;
    int                      m_model_column;
    int                      m_flags;
    wxString                 m_title;
    wxDataViewCtrl          *m_owner;

protected:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewColumnBase)
};

// --------------------------------------------------------- 
// wxDataViewCtrlBase
// --------------------------------------------------------- 

class wxDataViewCtrlBase: public wxControl
{
public:
    wxDataViewCtrlBase();
    ~wxDataViewCtrlBase();
    
    virtual bool AssociateModel( wxDataViewListModel *model );
    wxDataViewListModel* GetModel();
    
    virtual bool AppendTextColumn( const wxString &label, size_t model_column );
    virtual bool AppendToggleColumn( const wxString &label, size_t model_column );
    virtual bool AppendProgressColumn( const wxString &label, size_t model_column );
    virtual bool AppendDateColumn( const wxString &label, size_t model_column );
    virtual bool AppendColumn( wxDataViewColumn *col );    
    virtual size_t GetNumberOfColumns();
    virtual bool DeleteColumn( size_t pos );
    virtual bool ClearColumns();
    virtual wxDataViewColumn* GetColumn( size_t pos );
    
private:
    wxDataViewListModel    *m_model;
    wxList                  m_cols;

protected:
    DECLARE_DYNAMIC_CLASS_NO_COPY(wxDataViewCtrlBase)
};

#if defined(__WXGTK20__)
    #include "wx/gtk/dataview.h"
#elif defined(__WXMAC__)
    #include "wx/mac/dataview.h"
#else
    #include "wx/generic/dataview.h"
#endif

#endif // wxUSE_DATAVIEWCTRL

#endif
    // _WX_DATAVIEW_H_BASE_