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