// -*- 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 "DialogBase.h"
+#include "LString.h"
-// Maybe this should be a UIFunc modelled on LyXFunc
-class LyXView;
+#include <boost/utility.hpp>
+#include <boost/scoped_ptr.hpp>
+#include <boost/signals/signal0.hpp>
+#include <boost/signals/signal1.hpp>
-class InsetGraphics;
+class LyXView;
class InsetBibKey;
class InsetBibtex;
+class InsetCommand;
class InsetError;
+class InsetERT;
class InsetExternal;
+class InsetFloat;
+class InsetWrap;
+class InsetGraphics;
class InsetInclude;
class InsetInfo;
-class InsetTabular;
-class InsetCommand;
class InsetMinipage;
-class InsetFloat;
-class InsetERT;
class Paragraph;
+class InsetTabular;
/** 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
{
public:
///
- typedef boost::shared_ptr<DialogBase> db_ptr;
- /**@name Constructor */
- //@{
- ///
- Dialogs(LyXView *);
- //@}
+ Dialogs(LyXView &);
+ /// Define an empty d-tor out-of-line to keep boost::scoped_ptr happy.
+ ~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();
/// Toggle tooltips on/off in all dialogs.
- static SigC::Signal0<void> toggleTooltips;
+ static void toggleTooltips();
/// Are the tooltips on or off?
static bool tooltipsEnabled();
/**@name Global Hide and Update Signals */
//@{
/// Hide all visible dialogs
- SigC::Signal0<void> hideAll;
-
+ boost::signal0<void> hideAll;
+
/// Hide any dialogs that require a buffer for them to operate
- SigC::Signal0<void> hideBufferDependent;
-
+ boost::signal0<void> hideBufferDependent;
+
/** 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;
+ boost::signal1<void, bool> updateBufferDependent;
//@}
/**@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;
+ void showAboutlyx();
/// show the key and label of a bibliography entry
- SigC::Signal1<void, InsetCommand *> showBibitem;
+ void showBibitem(InsetCommand * ic);
/// show the bibtex dialog
- SigC::Signal1<void, InsetCommand *> showBibtex;
+ void showBibtex(InsetCommand * ic);
///
- SigC::Signal0<void> showCharacter;
+ void showCharacter();
/// connected to the character dialog also
- SigC::Signal0<void> setUserFreeFont;
+ void setUserFreeFont();
+ ///
+ void showCitation(InsetCommand *);
///
- SigC::Signal1<void, InsetCommand *> showCitation;
+ void createCitation(string const &);
///
- SigC::Signal1<void, string const &> createCitation;
+ void showDocument();
///
- SigC::Signal0<void> showDocument;
+ void showError(InsetError *);
///
- SigC::Signal1<void, InsetError *> showError;
+ void showERT(InsetERT *);
+ ///
+ void updateERT(InsetERT *);
/// show the external inset dialog
- SigC::Signal1<void, InsetExternal *> showExternal;
+ void showExternal(InsetExternal *);
/// show the contents of a file.
- SigC::Signal1<void, string const &> showFile;
+ void showFile(string const &);
+ ///
+ void showFloat(InsetFloat *);
+ ///
+ void showWrap(InsetWrap *);
/// show all forked child processes
- SigC::Signal0<void> showForks;
+ void showForks();
///
- SigC::Signal1<void, InsetGraphics *> showGraphics;
+ void showGraphics(InsetGraphics *);
/// show the details of a LyX file include inset
- SigC::Signal1<void, InsetInclude *> showInclude;
- ///
- SigC::Signal1<void, InsetCommand *> showIndex;
+ void showInclude(InsetInclude *);
///
- SigC::Signal1<void, string const &> createIndex;
+ void showIndex(InsetCommand *);
///
- SigC::Signal1<void, InsetInfo *> showInfo;
+ void createIndex();
/// show the LaTeX log or build file
- SigC::Signal0<void> showLogFile;
- /// display the top-level maths panel
- SigC::Signal0<void> showMathPanel;
+ void showLogFile();
+ /// display the top-level maths panel
+ void showMathPanel();
///
- SigC::Signal1<void, InsetMinipage *> showMinipage;
+ void showMinipage(InsetMinipage *);
///
- SigC::Signal1<void, InsetMinipage *> updateMinipage;
+ void updateMinipage(InsetMinipage *);
///
- SigC::Signal1<void, InsetERT *> showERT;
+ void showParagraph();
///
- SigC::Signal1<void, InsetERT *> updateERT;
+ void updateParagraph();
///
- SigC::Signal1<void, InsetFloat *> showFloat;
+ void showPreamble();
///
- SigC::Signal0<void> showParagraph;
+ void showPreferences();
///
- SigC::Signal0<void> updateParagraph;
+ void showPrint();
///
- SigC::Signal0<void> showPreamble;
+ void showRef(InsetCommand *);
///
- SigC::Signal0<void> showPreferences;
+ void createRef(string const &);
///
- SigC::Signal0<void> showPrint;
+ void showSearch();
///
- SigC::Signal1<void, InsetCommand *> showRef;
- ///
- SigC::Signal1<void, string const &> createRef;
- ///
- SigC::Signal0<void> showSearch;
- ///
- SigC::Signal0<void> showSendto;
+ void showSendto();
/// bring up the spellchecker
- SigC::Signal0<void> showSpellchecker;
- /// bring up the spellchecker tab in preferences
- SigC::Signal0<void> showSpellcheckerPreferences;
+ void showSpellchecker();
///
- SigC::Signal1<void, InsetTabular *> showTabular;
+ void showTabular(InsetTabular *);
///
- SigC::Signal1<void, InsetTabular *> updateTabular;
+ void updateTabular(InsetTabular *);
///
- SigC::Signal0<void> showTabularCreate;
+ void showTabularCreate();
/// show the TexInfo
- SigC::Signal0<void> showTexinfo;
+ void showTexinfo();
/// show the thesaurus dialog
- SigC::Signal1<void, string const &> showThesaurus;
+ void showThesaurus(string const &);
///
- SigC::Signal1<void, InsetCommand *> showTOC;
+ void showTOC(InsetCommand *);
///
- SigC::Signal1<void, string const &> createTOC;
+ void createTOC(string const &);
///
- SigC::Signal1<void, InsetCommand *> showUrl;
+ void showUrl(InsetCommand *);
///
- SigC::Signal1<void, string const &> createUrl;
+ void createUrl(string const &);
/// show the version control log
- SigC::Signal0<void> showVCLogFile;
+ void showVCLogFile();
//@}
+
private:
- /// Add a dialog to the vector of dialogs.
- void add(DialogBase *);
- /// the dialogs being managed
- std::vector<db_ptr> dialogs_;
+ /// Use the Pimpl idiom to hide the internals.
+ class Impl;
+ /// The pointer never changes although *pimpl_'s contents may.
+ boost::scoped_ptr<Impl> const pimpl_;
};
#endif