src/frontends/Dialogs.h

   1 // -*- C++ -*-
   2 /* Dialogs.h
   3  * Container of all dialogs and signals a LyXView needs or uses to access them.
   4  * Author: Allan Rae <rae@lyx.org>
   5  * This file is part of
   6  * ======================================================
   7  *
   8  *           LyX, The Document Processor
   9  *
  10  *           Copyright 1995 Matthias Ettrich
  11  *           Copyright 1995-2001 The LyX Team.
  12  *
  13  *           This file Copyright 2000
  14  *           Allan Rae
  15  * ======================================================
  16  */
  17
  18 #ifndef DIALOGS_H
  19 #define DIALOGS_H
  20
  21 #include <vector>
  22 #include <sigc++/signal_system.h>
  23
  24 #include "LString.h"
  25 #include <boost/utility.hpp>
  26 #include <boost/smart_ptr.hpp>
  27
  28 #ifdef __GNUG__
  29 #pragma interface
  30 #endif
  31
  32 #include "DialogBase.h"
  33
  34 // Maybe this should be a UIFunc modelled on LyXFunc
  35 class LyXView;
  36
  37 class InsetGraphics;
  38 class InsetBibKey;
  39 class InsetBibtex;
  40 class InsetError;
  41 class InsetExternal;
  42 class InsetInclude;
  43 class InsetInfo;
  44 class InsetTabular;
  45 class InsetCommand;
  46 class InsetMinipage;
  47 class LyXParagraph;
  48
  49 /** Container of all dialogs and signals a LyXView needs or uses to access them
  50     The list of dialog signals isn't comprehensive but should be a good guide
  51     for any future additions.  Remember don't go overboard -- think minimal.
  52  */
  53 class Dialogs : boost::noncopyable
  54 {
  55 public:
  56         ///
  57         typedef boost::shared_ptr<DialogBase> db_ptr;
  58         /**@name Constructor */
  59         //@{
  60         ///
  61         Dialogs(LyXView *);
  62         //@}
  63
  64         /** Redraw all visible dialogs because, for example, the GUI colours
  65             have been re-mapped. */
  66         static SigC::Signal0<void> redrawGUI;
  67
  68         /**@name Global Hide and Update Signals */
  69         //@{
  70         /// Hide all visible dialogs
  71         SigC::Signal0<void> hideAll;
  72
  73         /// Hide any dialogs that require a buffer for them to operate
  74         SigC::Signal0<void> hideBufferDependent;
  75
  76         /** Update visible, buffer-dependent dialogs
  77             If the bool is true then a buffer change has occurred
  78             else its still the same buffer.
  79          */
  80         SigC::Signal1<void, bool> updateBufferDependent;
  81         //@}
  82
  83         /**@name Dialog Access Signals.
  84            Put into some sort of alphabetical order */
  85         //@{
  86         /// Do we really have to push this?
  87         SigC::Signal1<void, std::vector<string> const &> SetDocumentClassChoice;
  88         /// show the key and label of a bibliography entry
  89         SigC::Signal1<void, InsetCommand *> showBibitem;
  90         /// show the bibtex dialog
  91         SigC::Signal1<void, InsetCommand *> showBibtex;
  92         ///
  93         SigC::Signal0<void> showCharacter;
  94         /// connected to the character dialog also
  95         SigC::Signal0<void> setUserFreeFont;
  96         ///
  97         SigC::Signal1<void, InsetCommand *> showCitation;
  98         ///
  99         SigC::Signal1<void, string const &> createCitation;
 100         ///
 101         SigC::Signal0<void> showCopyright;
 102         ///
 103         SigC::Signal0<void> showCredits;
 104         ///
 105         SigC::Signal0<void> showDocument;
 106         ///
 107         SigC::Signal1<void, InsetError *> showError;
 108         /// show the external inset dialog
 109         SigC::Signal1<void, InsetExternal *> showExternal;
 110         ///
 111         SigC::Signal1<void, InsetGraphics *> showGraphics;
 112         /// show the details of a LyX file include inset
 113         SigC::Signal1<void, InsetInclude *> showInclude;
 114         ///
 115         SigC::Signal1<void, InsetCommand *> showIndex;
 116         ///
 117         SigC::Signal1<void, string const &> createIndex;
 118         ///
 119         SigC::Signal1<void, InsetInfo *> showInfo;
 120         /// show the LaTeX log or build file
 121         SigC::Signal0<void> showLogFile;
 122         /// display the top-level maths panel
 123         SigC::Signal0<void> showMathPanel;
 124         ///
 125         SigC::Signal1<void, InsetMinipage *> showMinipage;
 126         ///
 127         SigC::Signal1<void, InsetMinipage *> updateMinipage;
 128         ///
 129         SigC::Signal0<void> showParagraph;
 130         ///
 131         SigC::Signal0<void> updateParagraph;
 132         ///
 133         SigC::Signal0<void> showPreamble;
 134         ///
 135         SigC::Signal0<void> showPreferences;
 136         ///
 137         SigC::Signal0<void> showPrint;
 138         ///
 139         SigC::Signal1<void, InsetCommand *> showRef;
 140         ///
 141         SigC::Signal1<void, string const &> createRef;
 142         ///
 143         SigC::Signal0<void> showSearch;
 144         /// pop up the splash
 145         SigC::Signal0<void> showSplash;
 146         /// destroy the splash dialog
 147         void destroySplash();
 148         ///
 149         SigC::Signal1<void, InsetTabular *> showTabular;
 150         ///
 151         SigC::Signal1<void, InsetTabular *> updateTabular;
 152         ///
 153         SigC::Signal0<void> showTabularCreate;
 154         ///
 155         SigC::Signal1<void, InsetCommand *> showTOC;
 156         ///
 157         SigC::Signal1<void, string const &> createTOC;
 158         ///
 159         SigC::Signal1<void, InsetCommand *> showUrl;
 160         ///
 161         SigC::Signal1<void, string const &> createUrl;
 162         /// show the version control log
 163         SigC::Signal0<void> showVCLogFile;
 164         //@}
 165 private:
 166         /// Add a dialog to the vector of dialogs.
 167         void add(DialogBase *);
 168         /// the dialogs being managed
 169         std::vector<db_ptr> dialogs_;
 170         /// the splash dialog
 171         boost::scoped_ptr<DialogBase> splash_;
 172 };
 173
 174 #endif