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