sidebar.h

Go to the documentation of this file.

/* ============================================================
 *
 * This file is a part of digiKam project
 * https://www.digikam.org
 *
 * Date        : 2005-03-22
 * Description : a widget to manage sidebar in GUI.
 *
 * Copyright (C) 2005-2006 by Joern Ahrens <joern dot ahrens at kdemail dot net>
 * Copyright (C) 2006-2022 by Gilles Caulier <caulier dot gilles at gmail dot com>
 * Copyright (C) 2008-2013 by Marcel Wiesweg <marcel dot wiesweg at gmx dot de>
 * Copyright (C) 2001-2003 by Joseph Wenninger <jowenn at kde dot org>
 *
 * 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, 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.
 *
 * ============================================================ */
 
#ifndef DIGIKAM_SIDE_BAR_H
#define DIGIKAM_SIDE_BAR_H
 
// Qt includes
 
#include <QPixmap>
#include <QSplitter>
#include <QPushButton>
#include <QWidget>
#include <QList>
#include <QStyleOptionToolButton>
#include <QBoxLayout>
 
// Local includes
 
#include "digikam_export.h"
#include "statesavingobject.h"
 
class KConfigGroup;
 
namespace Digikam
{
 
class DMultiTabBarButton;
class DMultiTabBarTab;
 
class DIGIKAM_EXPORT DMultiTabBar : public QWidget
{
    Q_OBJECT
 
public:
 
    enum TextStyle
    {
        ActiveIconText = 0, 
        AllIconsText   = 2  
    };
 
public:
 
    explicit DMultiTabBar(Qt::Edge pos, QWidget* const parent = nullptr);
    ~DMultiTabBar() override;
 
    void appendButton(const QPixmap& pic,
                      int id = -1,
                      QMenu* const popup = nullptr,
                      const QString& not_used_yet = QString());
 
    void removeButton(int id);
 
    void appendTab(const QPixmap& pic,
                   int id = -1,
                   const QString& text = QString());
 
    void removeTab(int id);
 
    void setTab(int id, bool state);
 
    bool isTabRaised(int id)           const;
 
    DMultiTabBarButton* button(int id) const;
 
    DMultiTabBarTab* tab(int id)       const;
 
    void setPosition(Qt::Edge pos);
 
    Qt::Edge position()                const;
 
    void setStyle(TextStyle style);
 
    TextStyle tabStyle()               const;
 
protected:
 
    void updateSeparator();
 
    virtual void fontChange(const QFont&);
 
private:
 
    friend class DMultiTabBarButton;
 
    class Private;
    Private* const d;
};
 
// -------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT DMultiTabBarButton: public QPushButton
{
    Q_OBJECT
 
public:
 
    ~DMultiTabBarButton()         override;
 
    int id() const;
 
public Q_SLOTS:
 
    void setText(const QString& text);
 
Q_SIGNALS:
 
    void signalClicked(int id);
 
protected Q_SLOTS:
 
    virtual void slotClicked();
 
protected:
 
    DMultiTabBarButton(const QPixmap& pic,
                       const QString&,
                       int id,
                       QWidget* const parent);
 
    void hideEvent(QHideEvent*)   override;
    void showEvent(QShowEvent*)   override;
    void paintEvent(QPaintEvent*) override;
 
private:
 
    friend class DMultiTabBar;
 
    int m_id;
};
 
// -------------------------------------------------------------------------------------
 
class DIGIKAM_EXPORT DMultiTabBarTab: public DMultiTabBarButton
{
    Q_OBJECT
 
public:
 
    ~DMultiTabBarTab()            override;
 
    QSize sizeHint()        const override;
    QSize minimumSizeHint() const override;
 
public Q_SLOTS:
 
    void setPosition(Qt::Edge);
 
    void setStyle(DMultiTabBar::TextStyle);
 
    void setState(bool state);
 
    void setIcon(const QString&);
    void setIcon(const QPixmap&);
 
protected:
 
    void    computeMargins (int* hMargin, int* vMargin)        const;
    QSize   computeSizeHint(bool withText)                     const;
    bool    shouldDrawText()                                   const;
    bool    isVertical()                                       const;
    QPixmap iconPixmap()                                       const;
    void    initButtonStyleOption(QStyleOptionToolButton* opt) const;
 
    friend class DMultiTabBarFrame;
 
    DMultiTabBarTab(const QPixmap& pic,
                    const QString&,
                    int id,
                    QWidget* const parent,
                    Qt::Edge pos,
                    DMultiTabBar::TextStyle style);
 
    void paintEvent(QPaintEvent*) override;
 
private:
 
    class Private;
    Private* const d;
};
 
// -------------------------------------------------------------------------------------
 
class DMultiTabBarFrame: public QFrame
{
    Q_OBJECT
 
public:
 
    explicit DMultiTabBarFrame(QWidget* const parent, Qt::Edge pos);
    ~DMultiTabBarFrame()                override;
 
    void appendTab(const QPixmap&, int = -1, const QString& = QString());
    DMultiTabBarTab* tab(int) const;
    void removeTab(int);
    void setPosition(Qt::Edge pos);
    void setStyle(DMultiTabBar::TextStyle style);
    void showActiveTabTexts(bool show);
    QList<DMultiTabBarTab*>* tabs();
 
protected:
 
    virtual void contentsMousePressEvent(QMouseEvent*);
    void mousePressEvent(QMouseEvent*)  override;
 
private:
 
    friend class DMultiTabBar;
 
    class Private;
    Private* const d;
};
 
// -------------------------------------------------------------------------------------
 
class SidebarSplitter;
 
class DIGIKAM_EXPORT Sidebar : public DMultiTabBar,
                               public StateSavingObject
{
    Q_OBJECT
 
public:
 
    explicit Sidebar(QWidget* const parent,
                     SidebarSplitter* const sp,
                     Qt::Edge side = Qt::LeftEdge,
                     bool minimizedDefault = false);
 
    ~Sidebar()                              override;
 
    SidebarSplitter* splitter()       const;
 
    void appendTab(QWidget* const w, const QIcon& pic, const QString& title);
 
    void deleteTab(QWidget* const w);
 
    void setActiveTab(QWidget* const w);
 
    void activeNextTab();
 
    void activePreviousTab();
 
    QWidget* getActiveTab()           const;
 
    void shrink();
 
    void expand();
 
    void backup();
 
    void backup(const QList<QWidget*>& thirdWidgetsToBackup, QList<int>* const sizes);
 
    void restore();
 
    void restore(const QList<QWidget*>& thirdWidgetsToRestore, const QList<int>& sizes);
 
    bool isExpanded()                 const;
 
protected:
 
    void doLoadState()                      override;
 
    void doSaveState()                      override;
 
private:
 
    bool eventFilter(QObject* o, QEvent* e) override;
    void switchTabAndStackToTab(int tab);
 
private Q_SLOTS:
 
    void slotClicked(int tab);
 
    void slotExpandTimer();
    void slotDragSwitchTimer();
 
    void slotSplitterBtnClicked();
 
Q_SIGNALS:
 
    void signalChangedTab(QWidget* w);
 
    void signalViewChanged();
 
private:
 
    friend class SidebarSplitter;
 
    class Private;
    Private* const d;
};
 
// -----------------------------------------------------------------------------
 
class DIGIKAM_EXPORT SidebarSplitter : public QSplitter
{
    Q_OBJECT
 
public:
 
    const static QString DEFAULT_CONFIG_KEY;
 
    explicit SidebarSplitter(QWidget* const parent = nullptr);
    explicit SidebarSplitter(Qt::Orientation orientation, QWidget* const parent = nullptr);
 
    ~SidebarSplitter()                    override;
 
    void saveState(KConfigGroup& group);
 
    void saveState(KConfigGroup& group, const QString& key);
 
    void restoreState(KConfigGroup& group);
 
    void restoreState(KConfigGroup& group, const QString& key);
 
    int size(Sidebar* const bar)    const;
    int size(QWidget* const widget) const;
 
    void setSize(Sidebar* const bar, int size);
    void setSize(QWidget* const widget, int size);
 
    void addSplitterCollapserButton(QWidget* const widget);
 
private Q_SLOTS:
 
    void slotSplitterMoved(int pos, int index);
 
private:
 
    friend class Sidebar;
 
    class Private;
    Private* const d;
};
 
} // namespace Digikam
 
#endif // DIGIKAM_SIDE_BAR_H