FxUIAbstractItemModel.h

Go to the documentation of this file.

//
// (C) Copyright 2005-2025 by Graebert GmbH.
//
// Permission to use, copy, modify, and distribute this software in
// object code form for any purpose and without fee is hereby granted, 
// provided that the above copyright notice appears in all copies and 
// that both that copyright notice and the limited warranty and
// restricted rights notice below appear in all supporting 
// documentation.
//
// GRAEBERT PROVIDES THIS PROGRAM "AS IS" AND WITH ALL FAULTS. 
// GRAEBERT SPECIFICALLY DISCLAIMS ANY IMPLIED WARRANTY OF
// MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE.  GRAEBERT GMBH 
// DOES NOT WARRANT THAT THE OPERATION OF THE PROGRAM WILL BE
// UNINTERRUPTED OR ERROR FREE.
 
#pragma once
 
#include "../UI/FxUIObject.h"
#include "FxUIModelIndex.h"
#include "../UI/FxUISignal.h"
#include "../Core/FxUIVariant.h"
 
 
class COMMONUI_API CFxUIAbstractItemModel : public CFxUIObject
{
public:
 
    explicit CFxUIAbstractItemModel( CFxUIObject *parent = nullptr ) :
        m_beginInsertRows( this ),
        m_beginRemoveRows( this ),
        m_endInsertRows( this ),
        m_endRemoveRows( this ),
        m_dataChanged( this ),
        m_layoutChanged( this ),
        m_beginResetModel( this ),
        m_endResetModel( this )
    {
        setParent( parent );
    };
 
    virtual ~CFxUIAbstractItemModel() {};
 
    virtual CFxUIModelIndex index( int row, int column, const CFxUIModelIndex &parent = CFxUIModelIndex() ) const = 0;
    virtual CFxUIModelIndex parent( const CFxUIModelIndex &child ) const = 0;
  
    virtual int rowCount( const CFxUIModelIndex &parent = CFxUIModelIndex() ) const = 0;
    virtual int columnCount( const CFxUIModelIndex &parent = CFxUIModelIndex() ) const = 0;
   
    virtual CFxUIVariant data( const CFxUIModelIndex &index, int role = CFxUIModelIndex::UIDataRole::DisplayRole ) const = 0;
    virtual bool setData( const CFxUIModelIndex &index, const CFxUIVariant &value, int role = CFxUIModelIndex::UIDataRole::EditRole ) { return false; };
    bool hasIndex( int row, int column, const CFxUIModelIndex &parent = CFxUIModelIndex() ) const 
    {
        if( row < 0 || column < 0 )
            return false;
        return row < rowCount( parent ) && column < columnCount( parent );
    };
 
    virtual CFxUIVariant headerData( int section,
                                     CFxUIModelIndex::UIOrientation orientation,
                                     int role = CFxUIModelIndex::UIDataRole::DisplayRole ) const;
 
    virtual CFxUIModelIndex::UIItemFlags flags( const CFxUIModelIndex &index ) const
    {
       if( !index.isValid() )
         return ( CFxUIModelIndex::UIItemFlags ) 0;
 
       return ( CFxUIModelIndex::UIItemFlags )( CFxUIModelIndex::UIItemFlags::ItemIsSelectable | 
                                            CFxUIModelIndex::UIItemFlags::ItemIsEnabled );
    };
 
    virtual void sort( int column, int order ) {};
 
    inline CFxUIModelIndex createIndex( int row, int column, void *data = nullptr ) const;
    inline CFxUIModelIndex createIndex( int row, int column, quintptr id ) const;
 
    CFxUISignal<void( const CFxUIModelIndex &parent, int first, int last )>& beginInsertRows()
    {
        return m_beginInsertRows;
    };
 
    CFxUISignal<void( const CFxUIModelIndex &parent, int first, int last )>& beginRemoveRows()
    {
        return m_beginRemoveRows;
    };
 
    CFxUISignal<void()>& endInsertRows()
    {
        return m_endInsertRows;
    };
 
    CFxUISignal<void()>& endRemoveRows()
    {
        return m_endRemoveRows;
    };
 
    CFxUISignal<void( const CFxUIModelIndex& topLeft, const CFxUIModelIndex& bottomRight )>& dataChanged()
    {
        return m_dataChanged;
    }
 
    CFxUISignal<void( void )>& layoutChanged()
    {
        return m_layoutChanged;
    }
 
    CFxUISignal<void( void )>& beginResetModel()
    {
        return m_beginResetModel;
    }
 
    CFxUISignal<void( void )>& endResetModel()
    {
        return m_endResetModel;
    }
 
    virtual void onBeginInsertRows( const CFxUIModelIndex &parent, int first, int last )
    {
        m_beginInsertRows.Emit( parent, first, last );
    };
 
    virtual void onBeginRemoveRows( const CFxUIModelIndex &parent, int first, int last )
    {
        m_beginRemoveRows.Emit( parent, first, last );
    };
 
    virtual void onEndInsertRows() 
    {
        m_endInsertRows.Emit();
    };
 
    virtual void onEndRemoveRows()
    {
        m_endRemoveRows.Emit();
    };
 
    virtual void onDataChanged( const CFxUIModelIndex& topLeft, const CFxUIModelIndex& bottomRight )
    {
        m_dataChanged.Emit( topLeft, bottomRight );
    }
 
    virtual void onLayoutChanged()
    {
        m_layoutChanged.Emit();
    }
 
    virtual void onBeginResetModel()
    {
        m_beginResetModel.Emit();
    }
 
    virtual void onEndResetModel()
    {
        m_endResetModel.Emit();
    }
 
protected:
    CFxUISignal<void( const CFxUIModelIndex &parent, int first, int last )> m_beginInsertRows;
    CFxUISignal<void()> m_endInsertRows;
    CFxUISignal<void( const CFxUIModelIndex &parent, int first, int last )> m_beginRemoveRows;
    CFxUISignal<void()> m_endRemoveRows;
    CFxUISignal<void( const CFxUIModelIndex& topLeft, const CFxUIModelIndex& bottomRight )> m_dataChanged;
    CFxUISignal<void( void )> m_layoutChanged;
    CFxUISignal<void( void )> m_beginResetModel;
    CFxUISignal<void( void )> m_endResetModel;
};
 
inline CFxUIModelIndex CFxUIAbstractItemModel::createIndex( int arow, int acolumn, void *adata ) const
{
    return CFxUIModelIndex( arow, acolumn, adata, this );
}
inline CFxUIModelIndex CFxUIAbstractItemModel::createIndex( int arow, int acolumn, quintptr aid ) const
{
    return CFxUIModelIndex( arow, acolumn, aid, this );
}
 
inline CFxUIModelIndex CFxUIModelIndex::parent() const
{
    return m ? m->parent( *this ) : CFxUIModelIndex();
}
 
inline CFxUIVariant CFxUIModelIndex::data( int arole ) const
{
    return m ? m->data( *this, arole ) : CFxUIVariant();
}
 
inline CFxUIModelIndex::UIItemFlags CFxUIModelIndex::flags() const
{
    return m ? m->flags( *this ) : CFxUIModelIndex::UIItemFlags();
}