src/frontends/qt4/Dialog.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Dialog.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Angus Leeming
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef DIALOG_H
  13 #define DIALOG_H
  14
  15 #include "lfuns.h"
  16
  17 #include <QString>
  18 #include <string>
  19
  20 class QWidget;
  21
  22 namespace lyx {
  23
  24 class Buffer;
  25 class BufferView;
  26 class FuncRequest;
  27
  28 namespace frontend {
  29
  30 class GuiView;
  31
  32 /** \enum KernelDocType used to flag the different kinds of buffer
  33  *  without making the kernel header files available to the
  34  *  dialog's Controller or View.
  35  */
  36 enum KernelDocType
  37 {
  38         LATEX,
  39         LITERATE,
  40         DOCBOOK
  41 };
  42
  43
  44 /** \c Dialog collects the different parts of a Model-Controller-View
  45  *  split of a generic dialog together.
  46  */
  47 class Dialog
  48 {
  49 public:
  50         /// \param lv is the access point for the dialog to the LyX kernel.
  51         /// \param name is the identifier given to the dialog by its parent
  52         /// container.
  53         /// \param title is the window title used for decoration.
  54         Dialog(GuiView & lv, QString const & name, QString const & title);
  55
  56         virtual ~Dialog();
  57
  58         virtual QWidget * asQWidget() = 0;
  59         virtual QWidget const * asQWidget() const = 0;
  60
  61         /// Session key.
  62         /**
  63          * This key must be used for any session setting.
  64          **/
  65         QString sessionKey() const;
  66
  67         /// Save session settings.
  68         /**
  69          * This default implementation saves the geometry state.
  70          * Reimplement to save more settings.
  71          **/
  72         virtual void saveSession() const;
  73
  74         /// Restore session settings.
  75         /**
  76          * This default implementation restores the geometry state.
  77          * Reimplement to restore more settings.
  78          **/
  79         virtual void restoreSession();
  80
  81         /** \name Container Access
  82          *  These methods are publicly accessible because they are invoked
  83          *  by the parent container acting on commands from the LyX kernel.
  84          */
  85         //@{
  86         /// \param data is a string encoding of the data to be displayed.
  87         /// It is passed to the Controller to be translated into a useable form.
  88         virtual void showData(std::string const & data);
  89         virtual void updateData(std::string const & data);
  90         //@}
  91
  92         /** Check whether we may apply our data.
  93          *
  94          *  The buttons are disabled if not and (re-)enabled if yes.
  95          */
  96         virtual void checkStatus();
  97
  98         /** When applying, it's useful to know whether the dialog is about
  99          *  to close or not (no point refreshing the display for example).
 100          */
 101         virtual bool isClosing() const { return false; }
 102
 103         /** \c View part
 104          *  of a Model-Controller-View split of a generic dialog.
 105          *  These few methods are all that a generic dialog needs of a
 106          *  view.
 107          */
 108         //@{
 109         /** A request to modify the data structures stored by the
 110          *  accompanying Controller in preparation for their dispatch to
 111          *  the LyX kernel.
 112          */
 113         virtual void applyView() = 0;
 114
 115         /// Hide the dialog from sight
 116         void hideView();
 117
 118         /// Create the dialog if necessary, update it and display it.
 119         void showView();
 120
 121         /// Update the display of the dialog whilst it is still visible.
 122         virtual void updateView() = 0;
 123
 124         // Default Implementation does nothing.
 125         // Each dialog has to choose what control to enable or disable.
 126         virtual void enableView(bool /*enable*/) {}
 127
 128         /// \return true if the dialog is visible.
 129         virtual bool isVisibleView() const;
 130         //@}
 131
 132         /// Dialog identifier.
 133         QString name() const { return name_; }
 134
 135         //@{
 136         /** Enable the controller to initialise its data structures.
 137          *  \param data is a string encoding of the parameters to be displayed.
 138          *  \return true if the translation was successful.
 139          */
 140         virtual bool initialiseParams(std::string const & data) = 0;
 141
 142         /// Enable the controller to clean up its data structures.
 143         virtual void clearParams() = 0;
 144
 145         /// Enable the Controller to dispatch its data back to the LyX kernel.
 146         virtual void dispatchParams() = 0;
 147
 148         /** \return true if the dialog should be shown only when
 149          *  a buffer is open.
 150          */
 151         virtual bool isBufferDependent() const = 0;
 152
 153         /** \return true if the dialog can apply data also
 154          *  for ReadOnly buffers.
 155          *  This has to be distinguished from isBufferDependent()
 156          */
 157         virtual bool canApplyToReadOnly() const { return false; }
 158
 159         /** The lfun that is sent for applying the data.
 160          *
 161          * This method is used by the default implementation of canApply()
 162          * for buffer dependent dialogs that send one lfun when applying the
 163          * data.
 164          * It should be used in dispatchParams(), too for consistency reasons.
 165          *  \returns the lfun that is sent for applying the data.
 166          */
 167         virtual kb_action getLfun() const { return LFUN_INSET_APPLY; }
 168
 169         /** Check whether we may apply our data.
 170          *
 171          * The default implementation works for all dialogs that send one
 172          * lfun when applying the data. Dialogs that send none or more than
 173          * one lfun need to reimplement it.
 174          *  \returns whether the data can be applied or not.
 175          */
 176         virtual bool canApply() const;
 177
 178         /** \return true if the kernel should disconnect the dialog from
 179          *  a particular inset after the data has been applied to it.
 180          *  Clearly this makes sense only for dialogs modifying the contents
 181          *  of an inset :-)
 182          *  In practise, only a very few dialogs (e.g. the citation dialog)
 183          *  return true.
 184          */
 185         virtual bool disconnectOnApply() const { return false; }
 186
 187         /** \return true if Dialog::View::show() should not display the dialog
 188          *   after running update. Currently, only ControlSpellchecker
 189          *   makes use of that.
 190         */
 191         virtual bool exitEarly() const { return false; }
 192         //@}
 193
 194         /** \c Kernel part: a wrapper making the LyX kernel available to the dialog.
 195          * (Ie, it provides an interface to the Model part of the Model-Controller-
 196          *  View split.
 197          *  In an ideal world, it will shrink as more info is passed to the
 198          *  Dialog::show() and Dialog::update() methods.
 199          */
 200
 201
 202         /** This method is the primary purpose of the class. It provides
 203          *  the "gateway" by which the dialog can send a request (of a
 204          *  change in the data, for more information) to the kernel.
 205          *  \param fr is the encoding of the request.
 206          */
 207         void dispatch(FuncRequest const & fr) const;
 208
 209         /** The dialog has received a request from the user
 210          *  (who pressed the "Restore" button) to update contents.
 211          *  It must, therefore, ask the kernel to provide this information.
 212          *  \param name is used to identify the dialog to the kernel.
 213          */
 214         void updateDialog() const;
 215
 216         /** A request from the Controller that future changes to the data
 217          *  stored by the dialog are not applied to the inset currently
 218          *  connected to the dialog. Instead, they will be used to generate
 219          *  a new inset at the cursor position.
 220          *  \param name is used to identify the dialog to the kernel.
 221          */
 222         void disconnect() const;
 223
 224         /** \name Kernel Wrappers
 225          *  Simple wrapper functions to Buffer methods.
 226          */
 227         //@{
 228         bool isBufferAvailable() const;
 229         bool isBufferReadonly() const;
 230         std::string const bufferFilepath() const;
 231         //@}
 232
 233         /// The type of the current buffer.
 234         KernelDocType docType() const;
 235
 236         /** \name Kernel Nasties
 237          *  Unpleasantly public internals of the LyX kernel.
 238          *  We should aim to reduce/remove these from the interface.
 239          */
 240         //@{
 241         GuiView & lyxview() { return *lyxview_; }
 242         GuiView const & lyxview() const { return *lyxview_; }
 243
 244         Buffer & buffer();
 245         Buffer const & buffer() const;
 246
 247         BufferView * bufferview();
 248         BufferView const * bufferview() const;
 249         //@}
 250
 251 protected:
 252         ///
 253         void setTitle(QString const & title) { title_ = title; }
 254         ///
 255         virtual void apply();
 256
 257 private:
 258         /** The Dialog's name is the means by which a dialog identifies
 259          *  itself to the LyXView.
 260          */
 261         QString const name_;
 262         ///
 263         QString title_;
 264         ///
 265         GuiView * lyxview_;
 266
 267         /// intentionally unimplemented, therefore uncopiable
 268         Dialog(Dialog const &);
 269         void operator=(Dialog const &);
 270
 271 };
 272
 273
 274 } // namespace frontend
 275 } // namespace lyx
 276
 277 #endif // DIALOG_H