// -*- 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.
*
- * LyX, The Document Processor
+ * \author Allan Rae
+ * \author Angus Leeming
*
- * 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 "LString.h"
-
+#include <boost/signal.hpp>
#include <boost/utility.hpp>
-#include <boost/shared_ptr.hpp>
-#include <boost/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
-#include <vector>
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include <map>
-#include "DialogBase.h"
+namespace lyx {
-// Maybe this should be a UIFunc modelled on LyXFunc
+class Inset;
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 InsetERT;
-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.
+namespace frontend { class Dialog; }
+
+/** Container of all dialogs.
*/
-class Dialogs : boost::noncopyable
-{
+class Dialogs : boost::noncopyable {
public:
///
- typedef boost::shared_ptr<DialogBase> db_ptr;
- /**@name Constructor */
- //@{
+ Dialogs(LyXView &);
///
- Dialogs(LyXView *);
- //@}
-
- /** Redraw all visible dialogs because, for example, the GUI colours
- have been re-mapped. */
- boost::signal0<void> redrawGUI;
+ ~Dialogs();
- /// Toggle tooltips on/off in all dialogs.
- boost::signal0<void> toggleTooltips;
+ /** Check the status of all visible dialogs and disable or reenable
+ * them as appropriate.
+ *
+ * Disabling is needed for example when a dialog is open and the
+ * cursor moves to a position where the corresponding inset is not
+ * allowed.
+ */
+ void checkStatus();
/// Are the tooltips on or off?
static bool tooltipsEnabled();
- /**@name Global Hide and Update Signals */
- //@{
/// Hide all visible dialogs
- boost::signal0<void> hideAll;
-
+ void hideAll() const;
/// Hide any dialogs that require a buffer for them to operate
- boost::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.
*/
- boost::signal1<void, bool> updateBufferDependent;
- //@}
-
- /**@name Dialog Access Signals.
- Put into some sort of alphabetical order */
- //@{
- ///
- void showAboutlyx();
- /// show the key and label of a bibliography entry
- void showBibitem(InsetCommand * ic);
- /// show the bibtex dialog
- void showBibtex(InsetCommand * ic);
- ///
- void showCharacter();
- /// connected to the character dialog also
- void setUserFreeFont();
- ///
- void showCitation(InsetCommand *);
- ///
- void createCitation(string const &);
- ///
- void showDocument();
- ///
- void showError(InsetError *);
- /// show the external inset dialog
- void showExternal(InsetExternal *);
- /// show the contents of a file.
- void showFile(string const &);
- /// show all forked child processes
- void showForks();
- ///
- void showGraphics(InsetGraphics *);
- /// show the details of a LyX file include inset
- void showInclude(InsetInclude *);
- ///
- void showIndex(InsetCommand *);
- ///
- void createIndex();
- ///
- void showInfo(InsetInfo *);
- /// show the LaTeX log or build file
- void showLogFile();
- /// display the top-level maths panel
- void showMathPanel();
- ///
- void showMinipage(InsetMinipage *);
- ///
- void updateMinipage(InsetMinipage *);
- ///
- void showERT(InsetERT *);
- ///
- void updateERT(InsetERT *);
- ///
- void showFloat(InsetFloat *);
- ///
- void showParagraph();
- ///
- boost::signal0<void> updateParagraph;
- ///
- void showPreamble();
- ///
- void showPreferences();
- ///
- void showPrint();
- ///
- void showRef(InsetCommand *);
+ void updateBufferDependent(bool) const ;
+
+ /** \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, Inset * 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, Inset * inset);
+ ///
+ void disconnect(std::string const & name);
+ ///
+ Inset * getOpenInset(std::string const & name) const;
+private:
///
- void createRef(string const &);
+ void hideSlot(std::string const & name, Inset * inset);
///
- void showSearch();
+ void redraw() const;
///
- void showSendto();
- /// bring up the spellchecker
- void showSpellchecker();
+ bool isValidName(std::string const & name) const;
///
- void showTabular(InsetTabular *);
+ frontend::Dialog * find_or_build(std::string const & name);
///
- void updateTabular(InsetTabular *);
+ typedef boost::shared_ptr<frontend::Dialog> DialogPtr;
///
- void showTabularCreate();
- /// show the TexInfo
- void showTexinfo();
- /// show the thesaurus dialog
- void showThesaurus(string const &);
+ DialogPtr build(std::string const & name);
+
///
- void showTOC(InsetCommand *);
+ LyXView & lyxview_;
///
- void createTOC(string const &);
+ std::map<std::string, Inset *> open_insets_;
+
///
- void showUrl(InsetCommand *);
+ std::map<std::string, DialogPtr> dialogs_;
+
+ /// flag against a race condition due to multiclicks in Qt frontend, see bug #1119
+ bool in_show_;
+
///
- void createUrl(string const &);
- /// show the version control log
- void showVCLogFile();
- //@}
-private:
- /// Add a dialog to the vector of dialogs.
- //void add(DialogBase *);
- /// the dialogs being managed
- //std::vector<db_ptr> dialogs_;
+ boost::signals::connection connection_;
};
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff