// -*- C++ -*-
-/* Dialogs.h
- * Container of all dialogs and signals a LyXView needs or uses to access them.
- * Author: Allan Rae <rae@lyx.org>
- * This file is part of
- * ======================================================
+/**
+ * \file Dialogs.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ * \author Allan Rae
*
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * This file Copyright 2000
- * Allan Rae
- * ======================================================
+ * Full author contact details are available in file CREDITS.
*/
#ifndef DIALOGS_H
#define DIALOGS_H
-#include <vector>
-#include <sigc++/signal_system.h>
-
-#include "LString.h"
#include <boost/utility.hpp>
-#include <boost/smart_ptr.hpp>
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <boost/signals/signal0.hpp>
+#include <boost/signals/signal1.hpp>
-#include "DialogBase.h"
-
-// Maybe this should be a UIFunc modelled on LyXFunc
+class Dialog;
+class InsetBase;
class LyXView;
-class InsetGraphics;
-class InsetBibKey;
-class InsetBibtex;
-class InsetError;
-class InsetExternal;
-class InsetInclude;
-class InsetInfo;
-class InsetTabular;
-class InsetCommand;
-class InsetMinipage;
-class InsetFloat;
-class Paragraph;
-
/** Container of all dialogs and signals a LyXView needs or uses to access them
The list of dialog signals isn't comprehensive but should be a good guide
for any future additions. Remember don't go overboard -- think minimal.
{
public:
///
- typedef boost::shared_ptr<DialogBase> db_ptr;
- /**@name Constructor */
- //@{
+ Dialogs(LyXView &);
///
- Dialogs(LyXView *);
- //@}
+ ~Dialogs();
/** Redraw all visible dialogs because, for example, the GUI colours
- have been re-mapped. */
- static SigC::Signal0<void> redrawGUI;
+ * have been re-mapped.
+ *
+ * Note that static boost signals break some compilers, so we return a
+ * reference to some hidden magic ;-)
+ */
+ static boost::signal0<void> & redrawGUI();
- /**@name Global Hide and Update Signals */
+ /// Toggle tooltips on/off in all dialogs.
+ static void toggleTooltips();
+
+ /// Are the tooltips on or off?
+ static bool tooltipsEnabled();
+
+ /// Signals slated to go
//@{
+ boost::signal0<void> hideAllSignal;
+ boost::signal0<void> hideBufferDependentSignal;
+ boost::signal1<void, bool> updateBufferDependentSignal;
+ //@}
+
/// Hide all visible dialogs
- SigC::Signal0<void> hideAll;
-
+ void hideAll() const;
/// Hide any dialogs that require a buffer for them to operate
- SigC::Signal0<void> hideBufferDependent;
-
+ void hideBufferDependent() const;
/** Update visible, buffer-dependent dialogs
If the bool is true then a buffer change has occurred
else its still the same buffer.
*/
- SigC::Signal1<void, bool> updateBufferDependent;
- //@}
+ void updateBufferDependent(bool) const ;
/**@name Dialog Access Signals.
Put into some sort of alphabetical order */
//@{
- /// Do we really have to push this?
- SigC::Signal1<void, std::vector<string> const &> SetDocumentClassChoice;
- ///
- SigC::Signal0<void> showAboutlyx;
- /// show the key and label of a bibliography entry
- SigC::Signal1<void, InsetCommand *> showBibitem;
- /// show the bibtex dialog
- SigC::Signal1<void, InsetCommand *> showBibtex;
- ///
- SigC::Signal0<void> showCharacter;
- /// connected to the character dialog also
- SigC::Signal0<void> setUserFreeFont;
- ///
- SigC::Signal1<void, InsetCommand *> showCitation;
- ///
- SigC::Signal1<void, string const &> createCitation;
///
- SigC::Signal0<void> showDocument;
+ void showDocument();
+ /// show all forked child processes
+ void showForks();
///
- SigC::Signal1<void, InsetError *> showError;
- /// show the external inset dialog
- SigC::Signal1<void, InsetExternal *> showExternal;
+ void showPreamble();
///
- SigC::Signal1<void, InsetGraphics *> showGraphics;
- /// show the details of a LyX file include inset
- SigC::Signal1<void, InsetInclude *> showInclude;
+ void showPreferences();
///
- SigC::Signal1<void, InsetCommand *> showIndex;
+ void showPrint();
///
- SigC::Signal1<void, string const &> createIndex;
+ void showSearch();
///
- SigC::Signal1<void, InsetInfo *> showInfo;
- /// show the LaTeX log or build file
- SigC::Signal0<void> showLogFile;
- /// display the top-level maths panel
- SigC::Signal0<void> showMathPanel;
- ///
- SigC::Signal1<void, InsetMinipage *> showMinipage;
- ///
- SigC::Signal1<void, InsetMinipage *> updateMinipage;
- ///
- SigC::Signal1<void, InsetFloat *> showFloat;
- ///
- SigC::Signal0<void> showParagraph;
- ///
- SigC::Signal0<void> updateParagraph;
+ void showSendto();
+ /// bring up the spellchecker
+ void showSpellchecker();
+ //@}
+
+ /** \param name == "about" etc; an identifier used to
+ launch a particular dialog.
+ \param data is a string encoding of the data used to populate
+ the dialog. Several of these dialogs do not need any data,
+ so it defaults to string().
+ */
+ void show(std::string const & name, std::string const & data = std::string());
+
+ /** \param name == "bibtex", "citation" etc; an identifier used to
+ launch a particular dialog.
+ \param data is a string representation of the Inset contents.
+ It is often little more than the output from Inset::write.
+ It is passed to, and parsed by, the frontend dialog.
+ \param inset is _not_ passed to the frontend dialog.
+ It is stored internally and used by the kernel to ascertain
+ what to do with the FuncRequest dispatched from the frontend
+ dialog on 'Apply'; should it be used to create a new inset at
+ the current cursor position or modify an existing, 'open' inset?
+ */
+ void show(std::string const & name, std::string const & data, InsetBase * inset);
+
+ /** \param name == "citation", "bibtex" etc; an identifier used
+ to update the contents of a particular dialog with \param data .
+ See the comments to 'show', above.
+ */
+ void update(std::string const & name, std::string const & data);
+
+ /// is the dialog currently visible?
+ bool visible(std::string const & name) const;
+
+ /** All Dialogs of the given \param name will be closed if they are
+ connected to the given \param inset.
+ */
+ static void hide(std::string const & name, InsetBase * inset);
///
- SigC::Signal0<void> showPreamble;
+ void disconnect(std::string const & name);
///
- SigC::Signal0<void> showPreferences;
+ InsetBase * getOpenInset(std::string const & name) const;
+private:
///
- SigC::Signal0<void> showPrint;
+ void hideSlot(std::string const & name, InsetBase * inset);
///
- SigC::Signal1<void, InsetCommand *> showRef;
+ void redraw() const;
///
- SigC::Signal1<void, string const &> createRef;
+ bool isValidName(std::string const & name) const;
///
- SigC::Signal0<void> showSearch;
- /// bring up the spellchecker
- SigC::Signal0<void> showSpellchecker;
- /// bring up the spellchecker tab in preferences
- SigC::Signal0<void> showSpellcheckerPreferences;
- /// pop up the splash
- SigC::Signal0<void> showSplash;
- /// destroy the splash dialog
- void destroySplash();
+ Dialog * find_or_build(std::string const & name);
///
- SigC::Signal1<void, InsetTabular *> showTabular;
+ Dialog * build(std::string const & name);
+
///
- SigC::Signal1<void, InsetTabular *> updateTabular;
+ LyXView & lyxview_;
///
- SigC::Signal0<void> showTabularCreate;
- /// show the thesaurus dialog
- SigC::Signal1<void, string const &> showThesaurus;
+ std::map<std::string, InsetBase *> open_insets_;
+
///
- SigC::Signal1<void, InsetCommand *> showTOC;
+ typedef boost::shared_ptr<Dialog> DialogPtr;
///
- SigC::Signal1<void, string const &> createTOC;
+ std::map<std::string, DialogPtr> dialogs_;
+
+ /// the stuff below is slated to go...
+ void init_pimpl();
///
- SigC::Signal1<void, InsetCommand *> showUrl;
+ class Impl;
///
- SigC::Signal1<void, string const &> createUrl;
- /// show the version control log
- SigC::Signal0<void> showVCLogFile;
- //@}
-private:
- /// Add a dialog to the vector of dialogs.
- void add(DialogBase *);
- /// the dialogs being managed
- std::vector<db_ptr> dialogs_;
- /// the splash dialog
- boost::scoped_ptr<DialogBase> splash_;
+ Impl * pimpl_;
};
#endif
projects / lyx.git / blobdiff