* Licence details can be found in the file COPYING.
* \author Allan Rae
*
- * Full author contact details are available in file CREDITS
+ * Full author contact details are available in file CREDITS.
*/
#ifndef DIALOGS_H
#define DIALOGS_H
-
-#include "LString.h"
-
#include <boost/utility.hpp>
-#include <boost/scoped_ptr.hpp>
#include <boost/signals/signal0.hpp>
#include <boost/signals/signal1.hpp>
class InsetBase;
class LyXView;
-class InsetFloat;
-class InsetWrap;
-class InsetGraphics;
-class InsetInfo;
-class InsetMinipage;
-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
for any future additions. Remember don't go overboard -- think minimal.
public:
///
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
Put into some sort of alphabetical order */
//@{
///
- void showAboutlyx();
- ///
- void showCharacter();
- /// connected to the character dialog also
- void setUserFreeFont();
- ///
void showDocument();
- /// show the contents of a file.
- void showFile(string const &);
- ///
- void showFloat(InsetFloat *);
- ///
- void showWrap(InsetWrap *);
/// show all forked child processes
void showForks();
///
- void showGraphics(InsetGraphics *);
- /// show the LaTeX log or build file
- void showLogFile();
- /// display the top-level maths panel
- void showMathPanel();
- /// show the merge changes dialog
- void showMergeChanges();
- ///
- void showMinipage(InsetMinipage *);
- ///
- void updateMinipage(InsetMinipage *);
- ///
- void showParagraph();
- ///
- void updateParagraph();
- ///
void showPreamble();
///
void showPreferences();
void showSendto();
/// bring up the spellchecker
void showSpellchecker();
- ///
- void showTabular(InsetTabular *);
- ///
- void updateTabular(InsetTabular *);
- ///
- void showTabularCreate();
- /// show the TexInfo
- void showTexinfo();
- /// show the thesaurus dialog
- void showThesaurus(string const &);
- /// show the version control log
- void showVCLogFile();
//@}
- /** name == "bibtex", "citation" etc
- data is generated by the Inset::write method, to be read by the
- Inset::read method in the frontends.
- inset is stored. On a subsequent Apply from the frontends, the
- stored inset will be modified. If no inset is stored, then a
- new one will be created at the current cursor position.
- */
- void show(string const & name, string const & data, InsetBase * inset);
- /** name == "citation", "bibtex" etc.
- Update the contents of the dialog.
- */
- void update(string const & name, string const & data);
- ///
- void Dialogs::hide(string const & name);
- ///
- void disconnect(string const & name);
- ///
- InsetBase * getOpenInset(string const & name) 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, 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);
+ ///
+ void disconnect(std::string const & name);
+ ///
+ InsetBase * getOpenInset(std::string const & name) const;
private:
+ ///
+ void hideSlot(std::string const & name, InsetBase * inset);
///
void redraw() const;
///
- bool isValidName(string const & name) const;
+ bool isValidName(std::string const & name) const;
///
- Dialog * find(string const & name);
+ Dialog * find_or_build(std::string const & name);
///
- Dialog * build(string const & name);
+ Dialog * build(std::string const & name);
///
LyXView & lyxview_;
///
- std::map<string, InsetBase *> open_insets_;
+ std::map<std::string, InsetBase *> open_insets_;
///
typedef boost::shared_ptr<Dialog> DialogPtr;
///
- std::map<string, DialogPtr> dialogs_;
+ std::map<std::string, DialogPtr> dialogs_;
/// the stuff below is slated to go...
void init_pimpl();