src/frontends/controllers/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 "Kernel.h"
  16 #include "lfuns.h"
  17
  18 #include "support/docstring.h"
  19
  20 #include <boost/utility.hpp>
  21 #include <boost/scoped_ptr.hpp>
  22
  23 namespace lyx {
  24 namespace frontend {
  25
  26 class LyXView;
  27
  28 /** \c Dialog collects the different parts of a Model-Controller-View
  29  *  split of a generic dialog together.
  30  */
  31 class Dialog /*: boost::noncopyable*/ {
  32 public:
  33         /// \param lv is the access point for the dialog to the LyX kernel.
  34         /// \param name is the identifier given to the dialog by its parent
  35         /// container.
  36         Dialog(LyXView & lv, std::string const & name);
  37         virtual ~Dialog();
  38
  39         /** The Dialog's name is the means by which a dialog identifies
  40          *  itself to the kernel.
  41          */
  42         std::string const & name() const { return name_; }
  43
  44         /** \name Container Access
  45          *  These methods are publicly accessible because they are invoked
  46          *  by the parent container acting on commands from the LyX kernel.
  47          */
  48         //@{
  49         /// \param data is a string encoding of the data to be displayed.
  50         /// It is passed to the Controller to be translated into a useable form.
  51         void show(std::string const & data);
  52         void update(std::string const & data);
  53
  54         void hide();
  55         bool isVisible() const;
  56
  57         // Override in GuiDialog
  58         virtual void preShow() {}
  59         virtual void postShow() {}
  60         virtual void preUpdate() {}
  61         virtual void postUpdate() {}
  62
  63         virtual void OkButton() {}
  64         virtual void ApplyButton() {}
  65         virtual void CancelButton() {}
  66         virtual void RestoreButton() {}
  67
  68         /** This function is called, for example, if the GUI colours
  69          *  have been changed.
  70          */
  71         void redraw();
  72         //@}
  73
  74         /** Check whether we may apply our data.
  75          *
  76          *  The buttons are disabled if not and (re-)enabled if yes.
  77          */
  78         void checkStatus();
  79
  80         /** When applying, it's useful to know whether the dialog is about
  81          *  to close or not (no point refreshing the display for example).
  82          */
  83         bool isClosing() const { return is_closing_; }
  84
  85         /** The LyX kernel is made available through this wrapper class.
  86          *  In an ideal world, it will shrink as more info is passed to the
  87          *  show() and update() methods.
  88          */
  89         Kernel & kernel() { return kernel_; }
  90
  91         /** Different dialogs will have different Controllers and Views.
  92          *  deriving from these base classes.
  93          */
  94         //@{
  95         class Controller;
  96         class View;
  97         //@}
  98
  99         /** \name Dialog Specialization
 100          *  Methods to set the Controller and View and so specialise
 101          *  to a particular dialog.
 102          */
 103         //@{
 104         /// \param ptr is stored and destroyed by \c Dialog.
 105         void setController(Controller * ptr);
 106         /// \param ptr is stored and destroyed by \c Dialog.
 107         void setView(View * ptr);
 108         //@}
 109
 110         /** \name Dialog Components
 111          *  Methods to access the various components making up a dialog.
 112          */
 113         //@{
 114         Controller & controller() const;
 115         View & view() const;
 116         //@}
 117
 118
 119         virtual void setButtonsValid(bool valid);
 120 protected:
 121         void apply();
 122
 123         bool is_closing_;
 124         Kernel kernel_;
 125         std::string name_;
 126         boost::scoped_ptr<Controller> controller_ptr_;
 127         boost::scoped_ptr<View> view_ptr_;
 128 };
 129
 130
 131 /** \c Dialog::Controller is an abstract base class for the Controller
 132  *  of a Model-Controller-View split of a generic dialog.
 133  */
 134 class Dialog::Controller : boost::noncopyable {
 135 public:
 136         /// \param parent Dialog owning this Controller.
 137         Controller(Dialog & parent);
 138         virtual ~Controller() {}
 139
 140         /** \name Generic Controller
 141          *  These few methods are all that a generic dialog needs of a
 142          *  controller.
 143          */
 144         //@{
 145         /** Enable the controller to initialise its data structures.
 146          *  \param data is a string encoding of the parameters to be displayed.
 147          *  \return true if the translation was successful.
 148          */
 149         virtual bool initialiseParams(std::string const & data) = 0;
 150
 151         /// Enable the controller to clean up its data structures.
 152         virtual void clearParams() = 0;
 153
 154         /// Enable the Controller to dispatch its data back to the LyX kernel.
 155         virtual void dispatchParams() = 0;
 156
 157         /** \return true if the dialog should be shown only when
 158          *  a buffer is open.
 159          */
 160         virtual bool isBufferDependent() const = 0;
 161
 162         /** \return true if the dialog can apply data also
 163          *  for ReadOnly buffers.
 164          *  This has to be distinguished from isBufferDependent()
 165          */
 166         virtual bool canApplyToReadOnly() const { return false; }
 167
 168         /** The lfun that is sent for applying the data.
 169          *
 170          * This method is used by the default implementation of canApply()
 171          * for buffer dependent dialogs that send one lfun when applying the
 172          * data.
 173          * It should be used in dispatchParams(), too for consistency reasons.
 174          *  \returns the lfun that is sent for applying the data.
 175          */
 176         virtual kb_action getLfun() const { return LFUN_INSET_APPLY; }
 177
 178         /** Check whether we may apply our data.
 179          *
 180          * The default implementation works for all dialogs that send one
 181          * lfun when applying the data. Dialogs that send none or more than
 182          * one lfun need to reimplement it.
 183          *  \returns whether the data can be applied or not.
 184          */
 185         virtual bool canApply() const;
 186
 187         /** \return true if the kernel should disconnect the dialog from
 188          *  a particular inset after the data has been applied to it.
 189          *  Clearly this makes sense only for dialogs modifying the contents
 190          *  of an inset :-)
 191          *  In practise, only a very few dialogs (e.g. the citation dialog)
 192          *  return true.
 193          */
 194         virtual bool disconnectOnApply() const { return false; }
 195
 196         /** \return true if Dialog::View::show() should not display the dialog
 197          *   after running update. Currently, only ControlSpellchecker
 198          *   makes use of that.
 199         */
 200         virtual bool exitEarly() const { return false; }
 201         //@}
 202
 203         /// Main Window access.
 204         /// This is unfortunately needed for the qt4 frontend and the \c
 205         /// QDialogView framework. This permits to give a parent to the
 206         /// constructed \c QDialog via a cast to \c GuiView.
 207         LyXView * view() { return &parent_.kernel().lyxview(); }
 208
 209 protected:
 210         /** \name Controller Access
 211          *  Enable the derived classes to access the other parts of the whole.
 212          */
 213         //@{
 214         Dialog & dialog() { return parent_; }
 215         Dialog const & dialog() const { return parent_; }
 216
 217         Kernel & kernel() { return parent_.kernel(); }
 218         Kernel const & kernel() const { return parent_.kernel(); }
 219         //@}
 220
 221 private:
 222         Dialog & parent_;
 223 };
 224
 225
 226 /** \c Dialog::View is an abstract base class to the View
 227  *  of a Model-Controller-View split of a generic dialog.
 228  */
 229 class Dialog::View : boost::noncopyable {
 230 public:
 231         /** \param parent Dialog owning this Controller.
 232          *  \param title  is the dialog title displayed by the WM.
 233          */
 234         View(Dialog & parent, docstring title);
 235         virtual ~View() {}
 236
 237         /** \name Generic View
 238          *  These few methods are all that a generic dialog needs of a
 239          *  view.
 240          */
 241         //@{
 242         /** A request to modify the data structures stored by the
 243          *  accompanying Controller in preparation for their dispatch to
 244          *  the LyX kernel.
 245          */
 246         virtual void apply() = 0;
 247
 248         /// Hide the dialog from sight
 249         virtual void hide() = 0;
 250
 251         /// Redraw the dialog (e.g. if the colors have been remapped).
 252         virtual void redraw() {}
 253
 254         /// Create the dialog if necessary, update it and display it.
 255         virtual void show() = 0;
 256
 257         /// Update the display of the dialog whilst it is still visible.
 258         virtual void update() = 0;
 259
 260         /// \return true if the dialog is visible.
 261         virtual bool isVisible() const = 0;
 262         //@}
 263
 264         /** Defaults to nothing. Can be used by the Controller, however, to
 265          *  indicate to the View that something has changed and that the
 266          *  dialog therefore needs updating.
 267          *  \param id identifies what should be updated.
 268          */
 269         virtual void partialUpdate(int id);
 270
 271         /// sets the title of the dialog (window caption)
 272         void setTitle(docstring const &);
 273         /// gets the title of the dialog (window caption)
 274         docstring const & getTitle() const;
 275
 276         /** \name View Access
 277          *  Enable the derived classes to access the other parts of the whole.
 278          */
 279         //@{
 280         Dialog & dialog() { return p_; }
 281         Dialog const & dialog() const { return p_; }
 282
 283 protected:
 284         Kernel & kernel() { return p_.kernel(); }
 285         Kernel const & kernel() const { return p_.kernel(); }
 286
 287         Controller & getController() { return p_.controller(); }
 288         Controller const & getController() const { return p_.controller(); }
 289         //@}
 290
 291 private:
 292         Dialog & p_;
 293         docstring title_;
 294 };
 295
 296 } // namespace frontend
 297 } // namespace lyx
 298
 299 #endif // DIALOG_H