src/frontends/qt4/DockView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file DockView.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef DOCK_VIEW_H
  13 #define DOCK_VIEW_H
  14
  15 #include "Dialog.h"
  16 #include "GuiView.h"
  17
  18 #include <QDockWidget>
  19
  20 namespace lyx {
  21 namespace frontend {
  22
  23 /// Dock Widget container for LyX dialogs.
  24 /**
  25  * This template class that encapsulates a given Widget inside a
  26  * QDockWidget and presents a Dialog interface
  27  * FIXME: create a DockView.cpp file
  28  **/
  29 class DockView : public QDockWidget, public Dialog
  30 {
  31 public:
  32         DockView(
  33                 GuiView & parent, ///< the main window where to dock.
  34                 QString const & name, ///< dialog identifier.
  35                 QString const & title, ///< dialog title.
  36                 Qt::DockWidgetArea area = Qt::LeftDockWidgetArea, ///< Position of the dock (and also drawer)
  37                 Qt::WindowFlags flags = 0
  38         )
  39                 : QDockWidget(&parent, flags), Dialog(parent, name, title)
  40         {
  41                 setObjectName(name);
  42                 if (flags & Qt::Drawer)
  43                         setFeatures(QDockWidget::NoDockWidgetFeatures);
  44                 parent.addDockWidget(area, this);
  45         }
  46
  47         virtual ~DockView() {}
  48
  49         virtual QWidget * asQWidget() { return this; }
  50         virtual QWidget const * asQWidget() const { return this; }
  51
  52         /// We don't want to restore geometry session for dock widgets.
  53         void restoreSession() {}
  54
  55         /// Dialog inherited methods
  56         //@{
  57         void applyView() {}
  58         bool isClosing() const { return false; }
  59         //@}
  60 };
  61
  62 } // frontend
  63 } // lyx
  64
  65 #endif // DOCK_VIEW_H