]> git.lyx.org Git - lyx.git/blob - src/frontends/Dialogs.h
Convert the prefs dialog to the Dialog-based scheme.
[lyx.git] / 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  * \author Allan Rae
7  *
8  * Full author contact details are available in file CREDITS.
9  */
10
11 #ifndef DIALOGS_H
12 #define DIALOGS_H
13
14 #include <boost/utility.hpp>
15 #include <boost/signals/signal0.hpp>
16 #include <boost/signals/signal1.hpp>
17
18 class Dialog;
19 class InsetBase;
20 class LyXView;
21
22 /** Container of all dialogs and signals a LyXView needs or uses to access them
23     The list of dialog signals isn't comprehensive but should be a good guide
24     for any future additions.  Remember don't go overboard -- think minimal.
25  */
26 class Dialogs : boost::noncopyable
27 {
28 public:
29         ///
30         Dialogs(LyXView &);
31         ///
32         ~Dialogs();
33
34         /** Redraw all visible dialogs because, for example, the GUI colours
35          *  have been re-mapped.
36          *
37          *  Note that static boost signals break some compilers, so we return a
38          *  reference to some hidden magic ;-)
39          */
40         static boost::signal0<void> & redrawGUI();
41
42         /// Toggle tooltips on/off in all dialogs.
43         static void toggleTooltips();
44
45         /// Are the tooltips on or off?
46         static bool tooltipsEnabled();
47
48         /// Signals slated to go
49         //@{
50         boost::signal0<void> hideAllSignal;
51         boost::signal0<void> hideBufferDependentSignal;
52         boost::signal1<void, bool> updateBufferDependentSignal;
53         //@}
54
55         /// Hide all visible dialogs
56         void hideAll() const;
57         /// Hide any dialogs that require a buffer for them to operate
58         void hideBufferDependent() const;
59         /** Update visible, buffer-dependent dialogs
60             If the bool is true then a buffer change has occurred
61             else its still the same buffer.
62          */
63         void updateBufferDependent(bool) const ;
64
65         /**@name Dialog Access Signals.
66            Put into some sort of alphabetical order */
67         //@{
68         ///
69         void showPreamble();
70         /// bring up the spellchecker
71         void showSpellchecker();
72         //@}
73
74         /** \param name == "about" etc; an identifier used to
75             launch a particular dialog.
76             \param data is a string encoding of the data used to populate
77             the dialog. Several of these dialogs do not need any data,
78             so it defaults to string().
79         */
80         void show(std::string const & name, std::string const & data = std::string());
81
82         /** \param name == "bibtex", "citation" etc; an identifier used to
83             launch a particular dialog.
84             \param data is a string representation of the Inset contents.
85             It is often little more than the output from Inset::write.
86             It is passed to, and parsed by, the frontend dialog.
87             \param inset is _not_ passed to the frontend dialog.
88             It is stored internally and used by the kernel to ascertain
89             what to do with the FuncRequest dispatched from the frontend
90             dialog on 'Apply'; should it be used to create a new inset at
91             the current cursor position or modify an existing, 'open' inset?
92         */
93         void show(std::string const & name, std::string const & data, InsetBase * inset);
94
95         /** \param name == "citation", "bibtex" etc; an identifier used
96             to update the contents of a particular dialog with \param data .
97             See the comments to 'show', above.
98         */
99         void update(std::string const & name, std::string const & data);
100
101         /// is the dialog currently visible?
102         bool visible(std::string const & name) const;
103
104         /** All Dialogs of the given \param name will be closed if they are
105             connected to the given \param inset.
106         */
107         static void hide(std::string const & name, InsetBase * inset);
108         ///
109         void disconnect(std::string const & name);
110         ///
111         InsetBase * getOpenInset(std::string const & name) const;
112 private:
113         ///
114         void hideSlot(std::string const & name, InsetBase * inset);
115         ///
116         void redraw() const;
117         ///
118         bool isValidName(std::string const & name) const;
119         ///
120         Dialog * find_or_build(std::string const & name);
121         ///
122         Dialog * build(std::string const & name);
123
124         ///
125         LyXView & lyxview_;
126         ///
127         std::map<std::string, InsetBase *> open_insets_;
128
129         ///
130         typedef boost::shared_ptr<Dialog> DialogPtr;
131         ///
132         std::map<std::string, DialogPtr> dialogs_;
133
134         /// the stuff below is slated to go...
135         void init_pimpl();
136         ///
137         class Impl;
138         ///
139         Impl * pimpl_;
140 };
141
142 #endif