FxUIModelIndex.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"
 
class CFxUIAbstractItemModel;
 
class COMMONUI_API CFxUIModelIndex
{
    friend class CFxUIAbstractItemModel;
public:
 
    enum UIDataRole {
        DisplayRole = 0,
        DecorationRole = 1,
        EditRole = 2,
        ToolTipRole = 3,
        FontRole = 6,
        BackgroundColorRole = 8,
        TextColorRole = 9,
 
        // Reserved
        UserRole = 0x0100
    };
 
    enum UIItemFlags {
        NoItemFlags = 0,
        ItemIsSelectable = 1,
        ItemIsEditable = 2,
        ItemIsEnabled = 32,
    };
 
 
    enum UIOrientation {
        Horizontal = 0x1,
        Vertical = 0x2
    };
 
    inline CFxUIModelIndex() : r( -1 ), c( -1 ), i( 0 ), m( nullptr ) {};
    // compiler-generated copy/move ctors/assignment operators are fine!
    inline int row() const { return r; };
    inline int column() const { return c; };
    inline quintptr internalId() const { return i; };
    inline void *internalPointer() const { return reinterpret_cast< void* >( i ); };
    inline CFxUIModelIndex parent() const;
    inline CFxUIVariant data( int role = UIDataRole::DisplayRole ) const;
    inline UIItemFlags flags() const;
    inline const CFxUIAbstractItemModel *model() const { return m; };
    inline bool isValid() const { return ( r >= 0 ) && ( c >= 0 ) && ( m != nullptr ); };
    inline bool operator==( const CFxUIModelIndex &other ) const
    {
        return ( other.r == r ) && ( other.i == i ) && ( other.c == c ) && ( other.m == m );
    };
    inline bool operator!=( const CFxUIModelIndex &other ) const
    {
        return !( *this == other );
    };
    inline bool operator<( const CFxUIModelIndex &other ) const
    {
        return  r < other.r
            || ( r == other.r && ( c < other.c
                                   || ( c == other.c && ( i < other.i
                                                          || ( i == other.i && std::less<const CFxUIAbstractItemModel *>()( m, other.m ) ) ) ) ) );
    };
private:
    inline CFxUIModelIndex( int arow, int acolumn, void *ptr, const CFxUIAbstractItemModel *amodel )
        : r( arow ), c( acolumn ), i( reinterpret_cast< quintptr >( ptr ) ), m( amodel ) 
    {
    };
    inline CFxUIModelIndex( int arow, int acolumn, quintptr id, const CFxUIAbstractItemModel *amodel )
        : r( arow ), c( acolumn ), i( id ), m( amodel ) 
    {
    };
 
    int r, c;
    qintptr i;
    const CFxUIAbstractItemModel *m;
};