FxUITableView.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 "FxUIBaseView.h"
#include "../Core/FxUIAbstractItemModel.h"
#include "../Core/FxUIModelIndex.h"
 
 
class COMMONUI_API CFxUIAbstractTableModel : public CFxUIAbstractItemModel
{
    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;
    
protected:
    virtual CFxUIModelIndex index( int row, int column, const CFxUIModelIndex &parent = CFxUIModelIndex() ) const override;
    virtual CFxUIModelIndex parent( const CFxUIModelIndex &child ) const override;
};

enum CFxUISortOrder {
    AscendingOrder,
    DescendingOrder
};

 
class COMMONUI_API CFxUITableView : public CFxUIBaseView
{
public:

    enum UISelectionBehavior
    {
        SelectItems, 
        SelectRows, 
        SelectColumns 
    };

    enum UISelectionMode
    {
        NoSelection,  
        SingleSelection, 
        MultiSelection, 
        ExtendedSelection, 
                           
        ContiguousSelection 
    };

    enum UIHeaderResizeMode
    {
        Interactive, 
        Stretch, 
        Fixed, 
        ResizeToContents, 
        Custom = Fixed 
    };

    enum UISelectionFlag {
        NoUpdate = 0x0000, 
        Clear = 0x0001, 
        Select = 0x0002, 
        Deselect = 0x0004, 
        Rows = 0x0020, 
        Columns = 0x0040, 
        ClearAndSelect = Clear | Select 
    };
 
    enum UIMouseClickEvent
    {
        None = 0,      
        Left = 1,    
        Middle = 2,  
        Right = 4    
    };
 
public:

    CFxUITableView();

    ~CFxUITableView();

    void setHorizontalHeaderResizeSection( CFxUITableView::UIHeaderResizeMode mode, int iColumn );

    void setHorizontalHeaderStretchLastSection( bool bEnable );

    void setVerticalHeaderStretchLastSection( bool bEnable );

    void setHorizontalScrollBarPolicy( CFxUIBaseView::UIScrollBarPolicy mode );

    void setVerticalScrollBarPolicy( CFxUIBaseView::UIScrollBarPolicy mode );

    void setSortingEnabled( bool bEnable );

    void sortByColumn( int column, int order );

    void setSelectionBehavior( CFxUITableView::UISelectionBehavior behavior );

    void setSelectionMode( CFxUITableView::UISelectionMode mode );

    void setColumnWidth( int iColumn, int iWidth );

    int columnWidth( int iColumn ) const;

    void setModel( CFxUIAbstractItemModel* model );
 
    CFxUIAbstractItemModel* getModel();

    void setCurrentIndex( CFxUIModelIndex index );

    CFxUIModelIndex currentIndex() const;
    
    void clearSelection();
    
    std::vector<CFxUIModelIndex> selectedIndexes() const;
    
    void selectRow( CFxUITableView::UISelectionFlag flag, CFxUIModelIndex index );
 

    void setVerticalHeaderHidden( bool bHide );

    void setHorzHeaderHidden( bool bHide );

    void setHorzScrollBarDisable( bool bDisable );

    void setColumnHidden( int iColumn, bool bHide );

    void openPersistentEditor( const CFxUIModelIndex &index );

    CFxUISignal<void( const CFxUIModelIndex& )>& itemClicked();

    CFxUISignal<void( CFxUIModelIndex , CFxUITableView::UIMouseClickEvent )>& mouseClicked();
    CFxUISignal<void(void)>& selectionChanged();

    void setShowGrid(bool visible, int mask = CFxUIModelIndex::Horizontal | CFxUIModelIndex::Vertical);

    bool showGrid();
 
    //...
 
};

 
class COMMONUI_API CFxUITableItemView : public CFxUIBaseView
{
};