X-Git-Url: https://cloud.milkyroute.net/gitweb/dolphin.git/blobdiff_plain/d0f1df0cc6eb305fa0b76b41af65a422f42ba6dc..c1e71289082ec7416ac19c822393ea70f63d1b75:/src/kitemviews/kitemlistwidget.h diff --git a/src/kitemviews/kitemlistwidget.h b/src/kitemviews/kitemlistwidget.h index b1df7bff4..b87a3b34e 100644 --- a/src/kitemviews/kitemlistwidget.h +++ b/src/kitemviews/kitemlistwidget.h @@ -1,36 +1,46 @@ -/*************************************************************************** - * Copyright (C) 2011 by Peter Penz * - * * - * Based on the Itemviews NG project from Trolltech Labs: * - * http://qt.gitorious.org/qt-labs/itemviews-ng * - * * - * This program is free software; you can redistribute it and/or modify * - * it under the terms of the GNU General Public License as published by * - * the Free Software Foundation; either version 2 of the License, or * - * (at your option) any later version. * - * * - * This program is distributed in the hope that it will be useful, * - * but WITHOUT ANY WARRANTY; without even the implied warranty of * - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * - * GNU General Public License for more details. * - * * - * You should have received a copy of the GNU General Public License * - * along with this program; if not, write to the * - * Free Software Foundation, Inc., * - * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * - ***************************************************************************/ +/* + * SPDX-FileCopyrightText: 2011 Peter Penz + * + * Based on the Itemviews NG project from Trolltech Labs + * + * SPDX-License-Identifier: GPL-2.0-or-later + */ #ifndef KITEMLISTWIDGET_H #define KITEMLISTWIDGET_H -#include - -#include +#include "dolphin_export.h" +#include "kitemviews/kitemliststyleoption.h" +#include #include +#include +#include +class KItemListSelectionToggle; +class KItemListView; class QPropertyAnimation; +/** + * @brief Provides generic information for all KItemListWidgets + * for which the construction of any specific KItemListWidget isn't required. + * + * KItemListView only creates KItemListWidget instances for the visible + * area. For calculating the required size of all items the expected + * size for the invisible items must be accessible. KItemListWidgetInformant + * provides this information. + */ +class DOLPHIN_EXPORT KItemListWidgetInformant +{ +public: + KItemListWidgetInformant(); + virtual ~KItemListWidgetInformant(); + + virtual void calculateItemSizeHints(QVector> &logicalHeightHints, qreal &logicalWidthHint, const KItemListView *view) const = 0; + + virtual qreal preferredRoleColumnWidth(const QByteArray &role, int index, const KItemListView *view) const = 0; +}; + /** * @brief Widget that shows a visible item from the model. * @@ -38,36 +48,47 @@ class QPropertyAnimation; * All properties are set by KItemListView, for each property there is a corresponding * virtual protected method that allows to react on property changes. */ -class LIBDOLPHINPRIVATE_EXPORT KItemListWidget : public QGraphicsWidget +class DOLPHIN_EXPORT KItemListWidget : public QGraphicsWidget { Q_OBJECT public: - KItemListWidget(QGraphicsItem* parent); - virtual ~KItemListWidget(); + KItemListWidget(KItemListWidgetInformant *informant, QGraphicsItem *parent); + ~KItemListWidget() override; void setIndex(int index); int index() const; - void setData(const QHash& data, const QSet& roles = QSet()); + void setData(const QHash &data, const QSet &roles = QSet()); QHash data() const; + QVariant value(const QByteArray &key) const; /** - * Draws the hover-bounding-rectangle if the item is hovered. Overwrite this method + * Draws the hover-rectangle if the item is hovered. Overwrite this method * to show the data of the custom model provided by KItemListWidget::data(). * @reimp */ - virtual void paint(QPainter* painter, const QStyleOptionGraphicsItem* option, QWidget* widget = 0); + void paint(QPainter *painter, const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr) override; - void setVisibleRoles(const QList& roles); + void setVisibleRoles(const QList &roles); QList visibleRoles() const; - void setVisibleRolesSizes(const QHash rolesSizes); - QHash visibleRolesSizes() const; + /** + * Sets the width of a role that should be used if the alignment of the content + * should be done in columns. + */ + void setColumnWidth(const QByteArray &role, qreal width); + qreal columnWidth(const QByteArray &role) const; + + void setSidePadding(qreal leftPaddingWidth, qreal rightPaddingWidth); + qreal leftPadding() const; + qreal rightPadding() const; - void setStyleOption(const KItemListStyleOption& option); - const KItemListStyleOption& styleOption() const; + void setStyleOption(const KItemListStyleOption &option); + const KItemListStyleOption &styleOption() const; + // TODO: Hides QGraphicsItem::setSelected()/isSelected(). Replace + // this by using the default mechanism. void setSelected(bool selected); bool isSelected() const; @@ -77,26 +98,82 @@ public: void setHovered(bool hovered); bool isHovered() const; - void setAlternatingBackgroundColors(bool enable); - bool alternatingBackgroundColors() const; + /** Sets a purely visual pressed highlight effect. */ + void setPressed(bool enabled); + bool isPressed() const; + + void setExpansionAreaHovered(bool hover); + bool expansionAreaHovered() const; + + void setHoverPosition(const QPointF &pos); + + void setAlternateBackground(bool enable); + bool alternateBackground() const; + + void setEnabledSelectionToggle(bool enabled); + bool enabledSelectionToggle() const; + + /** + * Sets the sibling information for the item and all of its parents. + * The sibling information of the upper most parent is represented by + * the first bit, the sibling information of the item by the last bit. + * The sibling information is useful for drawing the branches in + * tree views. + */ + void setSiblingsInformation(const QBitArray &siblings); + QBitArray siblingsInformation() const; + + /** + * Allows the user to edit the role \a role. The signals + * roleEditingCanceled() or roleEditingFinished() will be + * emitted after editing. An ongoing editing gets canceled if + * the role is empty. Derived classes must implement + * editedRoleChanged(). + */ + void setEditedRole(const QByteArray &role); + QByteArray editedRole() const; + + /** + * Contains the actual icon size used to draw the icon. + * Also used during icon resizing animation. + */ + void setIconSize(int iconSize); + int iconSize() const; /** - * @return True if \a point is inside KItemListWidget::hoverBoundingRect(), - * KItemListWidget::textBoundingRect(), KItemListWidget::selectionToggleRect() + * @return True if \a point is inside KItemListWidget::selectionRectFull(), + * KItemListWidget::selectionToggleRect() * or KItemListWidget::expansionToggleRect(). * @reimp */ - virtual bool contains(const QPointF& point) const; + bool contains(const QPointF &point) const override; + + /** + * @return Rectangle for the area that contains the text-properties. + */ + virtual QRectF textRect() const = 0; /** - * @return Bounding rectangle for the area that shows the icon. + * @return Focus rectangle for indicating the current item. Per default + * textRect() will be returned. Overwrite this method if textRect() + * provides a larger rectangle than the actual text (e.g. to + * be aligned with the iconRect()). The textFocusRect() may not be + * outside the boundaries of textRect(). */ - virtual QRectF iconBoundingRect() const = 0; + virtual QRectF textFocusRect() const; /** - * @return Bounding rectangle for the area that contains the text-properties. + * Used for drawing the visuals, and situations where we want the behavior of the + * selection to match the visuals. + * + * @return The rectangle around selection. */ - virtual QRectF textBoundingRect() const = 0; + virtual QRectF selectionRectFull() const = 0; + + /** + * @return The core area of the item. All of it reacts exactly the same way to mouse clicks. + */ + virtual QRectF selectionRectCore() const = 0; /** * @return Rectangle for the selection-toggle that is used to select or deselect an item. @@ -112,16 +189,54 @@ public: */ virtual QRectF expansionToggleRect() const; + /** + * @return Pixmap that is used when dragging an item. Per default the current state of the + * widget is returned as pixmap. + */ + virtual QPixmap createDragPixmap(const QStyleOptionGraphicsItem *option, QWidget *widget = nullptr); + + /** + * Starts an animation that makes clear that the item will be activated soon. + * @param timeUntilActivation time in milliseconds until the item will activate + */ + virtual void startActivateSoonAnimation(int timeUntilActivation); + +Q_SIGNALS: + void roleEditingCanceled(int index, const QByteArray &role, const QVariant &value); + void roleEditingFinished(int index, const QByteArray &role, const QVariant &value); + protected: - virtual void dataChanged(const QHash& current, const QSet& roles = QSet()); - virtual void visibleRolesChanged(const QList& current, const QList& previous); - virtual void visibleRolesSizesChanged(const QHash& current, const QHash& previous); - virtual void styleOptionChanged(const KItemListStyleOption& current, const KItemListStyleOption& previous); + virtual void dataChanged(const QHash ¤t, const QSet &roles = QSet()); + virtual void visibleRolesChanged(const QList ¤t, const QList &previous); + virtual void columnWidthChanged(const QByteArray &role, qreal current, qreal previous); + virtual void sidePaddingChanged(qreal leftPaddingWidth, qreal rightPaddingWidth); + virtual void styleOptionChanged(const KItemListStyleOption ¤t, const KItemListStyleOption &previous); virtual void currentChanged(bool current); virtual void selectedChanged(bool selected); virtual void hoveredChanged(bool hovered); - virtual void alternatingBackgroundColorsChanged(bool enabled); - virtual void resizeEvent(QGraphicsSceneResizeEvent* event); + virtual void alternateBackgroundChanged(bool enabled); + virtual void siblingsInformationChanged(const QBitArray ¤t, const QBitArray &previous); + virtual void editedRoleChanged(const QByteArray ¤t, const QByteArray &previous); + virtual void iconSizeChanged(int current, int previous); + void resizeEvent(QGraphicsSceneResizeEvent *event) override; + void clearHoverCache(); + + /** + * Called when the user starts hovering this item. + */ + virtual void hoverSequenceStarted(); + + /** + * Called in regular intervals while the user is hovering this item. + * + * @param sequenceIndex An index that increases over time while the user hovers. + */ + virtual void hoverSequenceIndexChanged(int sequenceIndex); + + /** + * Called when the user stops hovering this item. + */ + virtual void hoverSequenceEnded(); /** * @return The current opacity of the hover-animation. When implementing a custom painting-code for a hover-state @@ -129,29 +244,51 @@ protected: */ qreal hoverOpacity() const; + int hoverSequenceIndex() const; + + const KItemListWidgetInformant *informant() const; + +private Q_SLOTS: + void slotHoverSequenceTimerTimeout(); + private: + void initializeSelectionToggle(); void setHoverOpacity(qreal opacity); - void clearHoverCache(); - void drawFocusIndicator(QPainter* painter); - void drawTextBackground(QPainter* painter); + void drawItemStyleOption(QPainter *painter, QWidget *widget, QStyle::State styleState); private: - Q_PROPERTY(qreal hoverOpacity READ hoverOpacity WRITE setHoverOpacity) - + KItemListWidgetInformant *m_informant; int m_index; bool m_selected; bool m_current; bool m_hovered; - bool m_alternatingBackgroundColors; + bool m_expansionAreaHovered; + bool m_alternateBackground; + bool m_enabledSelectionToggle; + bool m_clickHighlighted; QHash m_data; QList m_visibleRoles; - QHash m_visibleRolesSizes; + QHash m_columnWidths; + qreal m_leftPadding; + qreal m_rightPadding; KItemListStyleOption m_styleOption; + QBitArray m_siblingsInfo; qreal m_hoverOpacity; - mutable QPixmap* m_hoverCache; - QPropertyAnimation* m_hoverAnimation; + mutable QPixmap *m_hoverCache; + + int m_hoverSequenceIndex; + QTimer m_hoverSequenceTimer; + + KItemListSelectionToggle *m_selectionToggle; + + QByteArray m_editedRole; + int m_iconSize; }; -#endif +inline const KItemListWidgetInformant *KItemListWidget::informant() const +{ + return m_informant; +} +#endif