core/SideBar.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Sérgio Martins <sergio.martins@kdab.com>
 
  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 
  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
 
#ifndef KD_SIDEBAR_P_H
#define KD_SIDEBAR_P_H
 
#pragma once
 
#include "kddockwidgets/docks_export.h"
 
#include "kddockwidgets/KDDockWidgets.h"
#include "Controller.h"
 
namespace KDDockWidgets {
 
namespace Core {
 
class DockWidget;
class MainWindow;
 
class DOCKS_EXPORT SideBar : public Controller
{
    Q_OBJECT
public:
    explicit SideBar(SideBarLocation, MainWindow *parent = nullptr);
    ~SideBar() override;
 
    void addDockWidget(DockWidget *dw);
    void removeDockWidget(DockWidget *dw);
    bool containsDockWidget(DockWidget *) const;
 
    Qt::Orientation orientation() const;
 
    bool isVertical() const
    {
        return m_orientation == Qt::Vertical;
    }
 
    bool isEmpty() const;
 
    SideBarLocation location() const;
 
    MainWindow *mainWindow() const;
 
    void toggleOverlay(DockWidget *);
 
    Vector<QString> serialize() const;
 
    void clear();
 
    Vector<DockWidget *> dockWidgets() const;
 
    void onButtonClicked(DockWidget *dw);
 
private:
    void updateVisibility();
 
    class Private;
    Private *const d;
 
    MainWindow *const m_mainWindow;
    Vector<DockWidget *> m_dockWidgets;
    const SideBarLocation m_location;
    const Qt::Orientation m_orientation;
};
 
}
 
}
 
#endif