dsimplelistview.h

// SPDX-FileCopyrightText: 2011 - 2022 UnionTech Software Technology Co., Ltd.
//
// SPDX-License-Identifier: LGPL-3.0-or-later
 
#ifndef DSIMPLELISTVIEW_H
#define DSIMPLELISTVIEW_H
 
#include <DObject>
#include <DSimpleListItem>
#include <dtkwidget_global.h>
#include <QPixmap>
#include <QTimer>
#include <QWidget>
 
DWIDGET_BEGIN_NAMESPACE
 
typedef bool (* SortAlgorithm) (const DSimpleListItem *item1, const DSimpleListItem *item2, bool descendingSort);
typedef bool (* SearchAlgorithm) (const DSimpleListItem *item, QString searchContent);
 
class DSimpleListViewPrivate;
class LIBDTKWIDGETSHARED_EXPORT DSimpleListView : public QWidget, public DTK_CORE_NAMESPACE::DObject
{
    Q_OBJECT
 
public:
    explicit DSimpleListView(QWidget *parent = 0);
    ~DSimpleListView();
 
    // DSimpleListView interfaces.
 
    /*
     * Set row height of DSimpleListView.
     *
     * \height the height of row
     */
    void setRowHeight(int height);
 
    /*
     * Set column titles, widths and height.
     * If you want some column use expand space, please set width with -1
     * Only allowed one -1 to set in width list.
     *
     * \titles a list to contains titles
     * \widths the width of column, list length same as titles list
     * \height height of titlebar, don't display titlebar if set height with 0
     */
    void setColumnTitleInfo(QList<QString> titles, QList<int> widths, int height);
 
    /*
     * Set column hide flags.
     * At least have false in hide flags list, and hide flags count must same as titles list.
     *
     * \toggleHideFlags the hide flags to control column wether toggle show/hide.
     * \alwaysVisibleColumn the column index that column is always visible, default is -1, mean no column can always visible.
     */
    void setColumnHideFlags(QList<bool> toggleHideFlags, int alwaysVisibleColumn=-1);
 
    /*
     * Set column sorting algorithms.
     * Note SortAlgorithm function type must be 'static', otherwise function pointer can't match type.
     *
     * \algorithms a list of SortAlgorithm, SortAlgorithm is function pointer, it's type is: 'bool (*) (const DSimpleListItem *item1, const DSimpleListItem *item2, bool descendingSort)'
     * \sortColumn default sort column, -1 mean don't sort any column default
     * \descendingSort whether sort column descending, default is false
     */
    void setColumnSortingAlgorithms(QList<SortAlgorithm> *algorithms, int sortColumn=-1, bool descendingSort=false);
 
    /*
     * Set search algorithm to filter match items.
     *
     * \algorithm the search algorithm, it's type is: 'bool (*) (const DSimpleListItem *item, QString searchContent)'
     */
    void setSearchAlgorithm(SearchAlgorithm algorithm);
 
    /*
     * Set radius to clip listview.
     *
     * \radius the radius of clip area, default is 0 pixel.
     */
    void setClipRadius(int radius);
 
    /*
     * Set frame details.
     *
     * \enableFrame draw frame if enableFrame is true, default is false
     * the frame color, default is black
     * \opacity the frame opacity, default is 0.1
     */
    void setFrame(bool enableFrame, QColor color=QColor("#000000"), double opacity=0.1);
 
    /*
     * Add DSimpleListItem list to ListView.
     * If user has click title to sort, sort items after add items to list.
     *
     * \items List of LiteItem*
     */
    void addItems(QList<DSimpleListItem*> items);
 
    /*
     * Remove DSimpleListItem from list.
     *
     * \item item to remove
     */
    void removeItem(DSimpleListItem* item);
 
    /*
     * Clear items from DSimpleListView.
     */
    void clearItems();
 
    /*
     * Add DSimpleListItem list to mark selected effect in ListView.
     *
     * \items List of DSimpleListItem* to mark selected
     * \recordLastSelection record last selection item to make selected operation continuously, default is true
     */
    void addSelections(QList<DSimpleListItem*> items, bool recordLastSelection=true);
 
    /*
     * Clear selection items from DSimpleListView.
     *
     * \clearLastSelection clear last selection item if option is true, default is true
     */
    void clearSelections(bool clearLastSelection=true);
 
    /*
     * Get selection items.
     *
     * \return List of DSimpleListItem* to mark selected
     */
    QList<DSimpleListItem*> getSelections();
 
    /*
     * Refresh all items in DSimpleListView.
     * This function is different that addItems is: it will clear items first before add new items.
     * This function will keep selection status and scroll offset when add items.
     *
     * \items List of DSimpleListItem* to add
     */
    void refreshItems(QList<DSimpleListItem*> items);
 
    /*
     * Search
     */
    void search(QString searchContent);
    
    /*
     * Set single selection.
     */
    void setSingleSelect(bool singleSelect);
    
    /*
     * Keep select items when click blank area.
     */
    void keepSelectWhenClickBlank(bool keep);
 
    // DSimpleListView operations.
    void selectAllItems();
    void selectFirstItem();
    void selectLastItem();
    void selectNextItem();
    void selectPrevItem();
 
    void shiftSelectPageDown();
    void shiftSelectPageUp();
    void shiftSelectToEnd();
    void shiftSelectToHome();
    void shiftSelectToNext();
    void shiftSelectToPrev();
 
    void scrollPageDown();
    void scrollPageUp();
 
    void ctrlScrollPageDown();
    void ctrlScrollPageUp();
    void ctrlScrollToEnd();
    void ctrlScrollToHome();
 
protected:
    virtual void leaveEvent(QEvent * event);
 
    QPixmap arrowDownDarkHoverImage;
    QPixmap arrowDownDarkNormalImage;
    QPixmap arrowDownDarkPressImage;
    QPixmap arrowDownHoverImage;
    QPixmap arrowDownLightHoverImage;
    QPixmap arrowDownLightNormalImage;
    QPixmap arrowDownLightPressImage;
    QPixmap arrowDownNormalImage;
    QPixmap arrowDownPressImage;
    QPixmap arrowUpDarkHoverImage;
    QPixmap arrowUpDarkNormalImage;
    QPixmap arrowUpDarkPressImage;
    QPixmap arrowUpHoverImage;
    QPixmap arrowUpLightHoverImage;
    QPixmap arrowUpLightNormalImage;
    QPixmap arrowUpLightPressImage;
    QPixmap arrowUpNormalImage;
    QPixmap arrowUpPressImage;
    QString backgroundColor = "#ffffff";
    QString scrollbarColor = "#ffffff";
    QString searchColor = "#000000";
    QString titleAreaColor = "#ffffff";
    QString titleColor = "#000000";
    QString titleLineColor = "#000000";
    QColor frameColor = QColor("#000000");
    double backgroundOpacity = 0.03;
    double frameOpacity = 0.1;
    double titleAreaOpacity = 0.02;
    int titleSize = 10;
    qreal scrollbarFrameHoverOpacity = 0;
    qreal scrollbarFrameNormalOpacity = 0;
    qreal scrollbarFramePressOpacity = 0;
    qreal scrollbarHoverOpacity = 0.7;
    qreal scrollbarNormalOpacity = 0.5;
    qreal scrollbarPressOpacity = 0.8;
 
Q_SIGNALS:
    void rightClickItems(QPoint pos, QList<DSimpleListItem*> items);
    void changeColumnVisible(int index, bool visible, QList<bool> columnVisibles);
    void changeSortingStatus(int index, bool sortingOrder);
    void changeHoverItem(QPoint pos, DSimpleListItem* item, int columnIndex);
 
    void mouseHoverChanged(DSimpleListItem* oldItem, DSimpleListItem* newItem, int columnIndex, QPoint pos);
    void mousePressChanged(DSimpleListItem* item, int columnIndex, QPoint pos);
    void mouseReleaseChanged(DSimpleListItem* item, int columnIndex, QPoint pos);
 
protected:
    bool eventFilter(QObject *, QEvent *event);
    void keyPressEvent(QKeyEvent *keyEvent);
    void mouseMoveEvent(QMouseEvent *mouseEvent);
    void mousePressEvent(QMouseEvent *mouseEvent);
    void mouseReleaseEvent(QMouseEvent *mouseEvent);
    void paintEvent(QPaintEvent *);
    void wheelEvent(QWheelEvent *event);
 
    void paintScrollbar(QPainter *painter);
 
    void selectPrevItemWithOffset(int scrollOffset);
    void selectNextItemWithOffset(int scrollOffset);
    void shiftSelectNextItemWithOffset(int scrollOffset);
    void shiftSelectPrevItemWithOffset(int scrollOffset);
 
    int getBottomRenderOffset();
    int getScrollbarY();
    int getScrollAreaHeight();
    int getScrollbarHeight();
 
    QList<int> getRenderWidths();
 
    void shiftSelectItemsWithBound(int selectionStartIndex, int selectionEndIndex);
    int adjustRenderOffset(int offset);
 
    void startScrollbarHideTimer();
 
    bool isMouseAtScrollArea(int x);
    bool isMouseAtTitleArea(int y);
 
    QList<bool> columnVisibles;
 
private Q_SLOTS:
    void hideScrollbar();
 
private:
    D_DECLARE_PRIVATE(DSimpleListView)
};
 
DWIDGET_END_NAMESPACE
 
#endif