src/frontends/Dialogs.h

   1 // -*- C++ -*-
   2 /**
   3  * \file Dialogs.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Allan Rae
   8  * \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef DIALOGS_H
  14 #define DIALOGS_H
  15
  16 #include <boost/signal.hpp>
  17 #include <boost/utility.hpp>
  18
  19 #include <map>
  20
  21 namespace lyx {
  22
  23 class Inset;
  24
  25 namespace frontend {
  26
  27 class Dialog;
  28 class LyXView;
  29
  30 /** Container of all dialogs.
  31  */
  32 class Dialogs : boost::noncopyable {
  33 public:
  34         ///
  35         Dialogs(LyXView &);
  36
  37         /** Check the status of all visible dialogs and disable or reenable
  38          *  them as appropriate.
  39          *
  40          *  Disabling is needed for example when a dialog is open and the
  41          *  cursor moves to a position where the corresponding inset is not
  42          *  allowed.
  43          */
  44         void checkStatus();
  45
  46         /// Are the tooltips on or off?
  47         static bool tooltipsEnabled();
  48
  49         /// Hide all visible dialogs
  50         void hideAll() const;
  51         /// Hide any dialogs that require a buffer for them to operate
  52         void hideBufferDependent() const;
  53         /** Update visible, buffer-dependent dialogs
  54             If the bool is true then a buffer change has occurred
  55             else its still the same buffer.
  56          */
  57         void updateBufferDependent(bool) const ;
  58
  59         /** \param name == "about" etc; an identifier used to
  60             launch a particular dialog.
  61             \param data is a string encoding of the data used to populate
  62             the dialog. Several of these dialogs do not need any data,
  63             so it defaults to string().
  64         */
  65         void show(std::string const & name, std::string const & data = std::string());
  66
  67         /** \param name == "bibtex", "citation" etc; an identifier used to
  68             launch a particular dialog.
  69             \param data is a string representation of the Inset contents.
  70             It is often little more than the output from Inset::write.
  71             It is passed to, and parsed by, the frontend dialog.
  72             \param inset is _not_ passed to the frontend dialog.
  73             It is stored internally and used by the kernel to ascertain
  74             what to do with the FuncRequest dispatched from the frontend
  75             dialog on 'Apply'; should it be used to create a new inset at
  76             the current cursor position or modify an existing, 'open' inset?
  77         */
  78         void show(std::string const & name, std::string const & data, Inset * inset);
  79
  80         /** \param name == "citation", "bibtex" etc; an identifier used
  81             to update the contents of a particular dialog with \param data.
  82             See the comments to 'show', above.
  83         */
  84         void update(std::string const & name, std::string const & data);
  85
  86         /// Is the dialog currently visible?
  87         bool visible(std::string const & name) const;
  88
  89         /** All Dialogs of the given \param name will be closed if they are
  90             connected to the given \param inset.
  91         */
  92         void hide(std::string const & name, Inset * inset);
  93         ///
  94         void disconnect(std::string const & name);
  95         ///
  96         Inset * getOpenInset(std::string const & name) const;
  97 private:
  98         ///
  99         void redraw() const;
 100         ///
 101         bool isValidName(std::string const & name) const;
 102         ///
 103         Dialog * find_or_build(std::string const & name);
 104         ///
 105         typedef boost::shared_ptr<Dialog> DialogPtr;
 106         ///
 107         DialogPtr build(std::string const & name);
 108
 109         ///
 110         LyXView & lyxview_;
 111         ///
 112         std::map<std::string, Inset *> open_insets_;
 113
 114         ///
 115         std::map<std::string, DialogPtr> dialogs_;
 116
 117         /// flag against a race condition due to multiclicks in Qt frontend, see bug #1119
 118         bool in_show_;
 119
 120         ///
 121         boost::signals::connection connection_;
 122 };
 123
 124 } // namespace frontend
 125 } // namespace lyx
 126
 127 #endif