src/insets/ExternalSupport.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ExternalSupport.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Asger Alstrup Nielsen
   8  * \author Angus Leeming
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef EXTERNALSUPPORT_H
  14 #define EXTERNALSUPPORT_H
  15
  16 #include <iosfwd>
  17 #include <string>
  18
  19 class Buffer;
  20 class InsetExternalParams;
  21
  22 namespace lyx {
  23 namespace external {
  24
  25 class Template;
  26
  27 /// A shorthand, helper function
  28 Template const * getTemplatePtr(InsetExternalParams const & params);
  29
  30
  31 /// Invoke the external editor.
  32 void editExternal(InsetExternalParams const & params,
  33                   Buffer const & buffer);
  34
  35
  36 /// Substitute meta-variables in string s, making use of params and buffer.
  37 std::string const doSubstitution(InsetExternalParams const & params,
  38                                  Buffer const & buffer,
  39                                  std::string const & s);
  40
  41
  42 /** Write the output for a specific file format
  43     and generate any external data files.
  44     If \param external_in_tmpdir == true, then the generated file is
  45     place in the buffer's temporary directory.
  46 */
  47 int writeExternal(InsetExternalParams const &,
  48                   std::string const & format,
  49                   Buffer const &,
  50                   std::ostream &,
  51                   bool external_in_tmpdir = false);
  52
  53 } // namespace external
  54 } // namespace lyx
  55
  56 #endif // NOT EXTERNALSUPPORT_H