4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
8 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
16 #include <boost/signal.hpp>
17 #include <boost/noncopyable.hpp>
30 /** Container of all dialogs.
32 class Dialogs : boost::noncopyable {
37 /** Check the status of all visible dialogs and disable or reenable
38 * them as appropriate.
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
46 /// Are the tooltips on or off?
47 static bool tooltipsEnabled();
49 /// Hide all visible dialogs
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 it is still the same buffer.
57 void updateBufferDependent(bool) const;
59 /** \param name == "bibtex", "citation" etc; an identifier used to
60 launch a particular dialog.
61 \param data is a string representation of the Inset contents.
62 It is often little more than the output from Inset::write.
63 It is passed to, and parsed by, the frontend dialog.
64 Several of these dialogs do not need any data,
65 so it defaults to string().
66 \param inset ownership is _not_ passed to the frontend dialog.
67 It is stored internally and used by the kernel to ascertain
68 what to do with the FuncRequest dispatched from the frontend
69 dialog on 'Apply'; should it be used to create a new inset at
70 the current cursor position or modify an existing, 'open' inset?
72 void show(std::string const & name,
73 std::string const & data = std::string(), Inset * inset = 0);
75 /** \param name == "citation", "bibtex" etc; an identifier used
76 to update the contents of a particular dialog with \param data.
77 See the comments to 'show', above.
79 void update(std::string const & name, std::string const & data);
81 /// Is the dialog currently visible?
82 bool visible(std::string const & name) const;
84 /** All Dialogs of the given \param name will be closed if they are
85 connected to the given \param inset.
87 void hide(std::string const & name, Inset * inset);
89 void disconnect(std::string const & name);
91 Inset * getOpenInset(std::string const & name) const;
96 bool isValidName(std::string const & name) const;
98 Dialog * find_or_build(std::string const & name);
100 typedef boost::shared_ptr<Dialog> DialogPtr;
102 Dialog * build(std::string const & name);
107 std::map<std::string, Inset *> open_insets_;
110 std::map<std::string, DialogPtr> dialogs_;
112 /// flag against a race condition due to multiclicks in Qt frontend,
117 boost::signals::connection connection_;
120 } // namespace frontend