core/TitleBar.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2020 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.
*/
 
#pragma once
 
#include "Controller.h"
#include "../core/Draggable_p.h"
#include "kddockwidgets/docks_export.h"
#include "DockWidget.h"
 
namespace KDDockWidgets {
namespace QtWidgets {
class TitleBar;
}
}
 
namespace KDDockWidgets::Core {
 
class Group;
class FloatingWindow;
class TabBar;
 
class DOCKS_EXPORT TitleBar : public Controller, public Draggable
{
    Q_OBJECT
public:
    explicit TitleBar(FloatingWindow *parent);
 
    explicit TitleBar(Group *parent);
 
    explicit TitleBar(Core::View *);
 
    virtual ~TitleBar() override;
 
    bool isMDI() const override;
    std::unique_ptr<WindowBeingDragged> makeWindow() override;
    bool isWindow() const override;
    Core::DockWidget *singleDockWidget() const override final;
 
    void setTitle(const QString &title);
    QString title() const;
 
    bool isFloating() const;
 
    bool isStandalone() const;
 
    DockWidget::List dockWidgets() const;
 
    Icon icon() const;
    void setIcon(const Icon &icon);
 
    bool supportsFloatingButton() const;
 
    bool supportsMaximizeButton() const;
 
    bool supportsMinimizeButton() const;
 
    bool supportsAutoHideButton() const;
 
#ifdef DOCKS_TESTING_METHODS
    bool isFloatButtonVisible() const;
    bool isCloseButtonVisible() const;
    bool isCloseButtonEnabled() const;
#endif
 
    bool hasIcon() const;
 
    bool isFocused() const;
 
    bool titleBarIsFocusable() const;
 
    Core::Group *group() const;
 
    FloatingWindow *floatingWindow() const;
 
    MainWindow *mainWindow() const;
 
    TabBar *tabBar() const;
 
    void focus(Qt::FocusReason reason);
 
    void updateButtons();
    QString floatButtonToolTip() const;
 
    bool onDoubleClicked();
    void onCloseClicked();
    void onFloatClicked();
    void onMaximizeClicked();
    void onMinimizeClicked();
    void onAutoHideClicked();
    void toggleMaximized();
 
    // TODO: Refactor into a QHash<Button,State> ?
    bool closeButtonEnabled() const;
    void setCloseButtonVisible(bool);
    bool floatButtonVisible() const;
    bool maximizeButtonVisible() const;
    void setCloseButtonEnabled(bool);
    void setFloatButtonVisible(bool);
 
    TitleBarButtonType maximizeButtonType() const;
 
    void setUserHiddenButtons(TitleBarButtonTypes);
    bool buttonIsUserHidden(TitleBarButtonType) const;
 
    bool buttonIsUserHidden(TitleBarButtonType, bool enabled) const;
 
    void setHideDisabledButtons(TitleBarButtonTypes);
    bool buttonHidesIfDisabled(TitleBarButtonType) const;
 
    class Private;
    Private *dptr() const;
 
protected:
    bool isOverlayed() const;
 
private:
    friend class ::TestDocks;
    friend class Core::Group;
    friend class KDDockWidgets::QtWidgets::TitleBar;
 
    void updateAutoHideButton();
    void updateMaximizeButton();
 
    void updateFloatButton();
    void updateCloseButton();
    bool supportsFloatUnfloat() const;
    void setFloatButtonToolTip(const QString &);
    void init();
 
    Private *const d;
 
    Point m_pressPos;
    QString m_title;
    Icon m_icon;
 
    Core::Group *const m_group;
    FloatingWindow *const m_floatingWindow;
    const bool m_supportsAutoHide;
    const bool m_isStandalone;
    bool m_closeButtonEnabled = true;
    bool m_closeButtonVisible = true;
    bool m_floatButtonVisible = true;
    bool m_maximizeButtonVisible = false;
    TitleBarButtonType m_maximizeButtonType = TitleBarButtonType::Maximize;
    QString m_floatButtonToolTip;
};
 
}