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/utility.hpp>
26 namespace frontend { class Dialog; }
28 /** Container of all dialogs.
30 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 its still the same buffer.
57 void updateBufferDependent(bool) const ;
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().
65 void show(std::string const & name, std::string const & data = std::string());
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?
78 void show(std::string const & name, std::string const & data, Inset * inset);
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.
84 void update(std::string const & name, std::string const & data);
86 /// Is the dialog currently visible?
87 bool visible(std::string const & name) const;
89 /** All Dialogs of the given \param name will be closed if they are
90 connected to the given \param inset.
92 static void hide(std::string const & name, Inset * inset);
94 void disconnect(std::string const & name);
96 Inset * getOpenInset(std::string const & name) const;
99 void hideSlot(std::string const & name, Inset * inset);
103 bool isValidName(std::string const & name) const;
105 frontend::Dialog * find_or_build(std::string const & name);
107 typedef boost::shared_ptr<frontend::Dialog> DialogPtr;
109 DialogPtr build(std::string const & name);
114 std::map<std::string, Inset *> open_insets_;
117 std::map<std::string, DialogPtr> dialogs_;
119 /// flag against a race condition due to multiclicks in Qt frontend, see bug #1119
123 boost::signals::connection connection_;