]> git.lyx.org Git - lyx.git/blobdiff - src/insets/ExternalTemplate.h
Enable the external inset to handle unknown templates gracefully.
[lyx.git] / src / insets / ExternalTemplate.h
index a0dfcbd7f9a5d79ef14c38ef116130ee4717dac2..151c26221fd84999c75a049ce85c3f03f8284f1e 100644 (file)
@@ -1,25 +1,22 @@
 // -*- C++ -*-
-/* This file is part of*
- * ====================================================== 
+/**
+ * \file ExternalTemplate.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *      
- *           Copyright 1995 Matthias Ettrich
- *           Copyright 1995-2000 The LyX Team.
+ * \author Asger Alstrup Nielsen
  *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef EXTERNALTEMPLATE_H
 #define EXTERNALTEMPLATE_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
 
 #include <iosfwd>
 #include <map>
 #include "LString.h"
-#include "support/utility.hpp"
+#include <boost/utility.hpp>
 
 class LyXLex;
 
@@ -31,10 +28,12 @@ struct ExternalTemplate {
        string guiName;
        /// A short help text
        string helpText;
+       /** The format of the input file. Can be "*", in which case we try and
+           ascertain the format from the contents of the file.
+       */
+       string inputFormat;
        /// A file extension regular expression for the file browser
        string fileRegExp;
-       /// What command should be executed to view the file?
-       string viewCommand;
        /// What command should be executed to edit the file?
        string editCommand;
        /// Should we do automatic production of the output?
@@ -43,8 +42,10 @@ struct ExternalTemplate {
        struct FormatTemplate {
                /// The text that should be inserted into the exported file
                string product;
-               /// The shell command to produce a resulting file
-               string updateCommand;
+               /// The filename of the resulting file
+               string updateResult;
+               /// The format of this file.
+               string updateFormat;
                /// What features does this external inset require?
                string requirement;
                /// What should be inserted into the preamble
@@ -62,17 +63,16 @@ struct ExternalTemplate {
        Formats formats;
        ///
        void dumpFormats(std::ostream &) const;
-       
+
        /// We have to have default commands for safety reasons!
        ExternalTemplate();
-               
 };
 
 
 /**
    A singleton class that manages the external inset templates
 */
-class ExternalTemplateManager : public noncopyable {
+class ExternalTemplateManager : boost::noncopyable {
 public:
        /// Map from the LyX name of the template to the template structure
        typedef std::map<string, ExternalTemplate> Templates;
@@ -80,6 +80,8 @@ public:
        static ExternalTemplateManager & get();
        Templates & getTemplates();
        Templates const & getTemplates() const;
+       /// return the template by LyX name
+       ExternalTemplate const & getTemplateByName(const string & name);
 private:
        ExternalTemplateManager();
        void readTemplates(string const & path);
@@ -88,4 +90,3 @@ private:
 };
 
 #endif
-