src/dolphindockwidget.h

   1 /***************************************************************************
   2  *   Copyright (C) 2010 by Peter Penz <peter.penz19@gmail.com>             *
   3  *                                                                         *
   4  *   This program is free software; you can redistribute it and/or modify  *
   5  *   it under the terms of the GNU General Public License as published by  *
   6  *   the Free Software Foundation; either version 2 of the License, or     *
   7  *   (at your option) any later version.                                   *
   8  *                                                                         *
   9  *   This program is distributed in the hope that it will be useful,       *
  10  *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
  11  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
  12  *   GNU General Public License for more details.                          *
  13  *                                                                         *
  14  *   You should have received a copy of the GNU General Public License     *
  15  *   along with this program; if not, write to the                         *
  16  *   Free Software Foundation, Inc.,                                       *
  17  *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA            *
  18  ***************************************************************************/
  19
  20 #ifndef DOLPHIN_DOCK_WIDGET_H
  21 #define DOLPHIN_DOCK_WIDGET_H
  22
  23 #include <QDockWidget>
  24
  25 /**
  26  * @brief Extends QDockWidget to be able to get locked.
  27  */
  28 class DolphinDockWidget : public QDockWidget
  29 {
  30     Q_OBJECT
  31
  32 public:
  33     explicit DolphinDockWidget(const QString& title, QWidget* parent = nullptr, Qt::WindowFlags flags = nullptr);
  34     explicit DolphinDockWidget(QWidget* parent = nullptr, Qt::WindowFlags flags = nullptr);
  35     ~DolphinDockWidget() override;
  36
  37     /**
  38      * @param lock If \a lock is true, the title bar of the dock-widget will get hidden so
  39      *             that it is not possible for the user anymore to move or undock the dock-widget.
  40      */
  41     void setLocked(bool lock);
  42     bool isLocked() const;
  43
  44 private:
  45     bool m_locked;
  46     QWidget* m_dockTitleBar;
  47 };
  48
  49 #endif