src/frontends/controllers/ControlExternal.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ControlExternal.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
   8  * \author John Levon
   9  * \author Angus Leeming
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef CONTROLEXTERNAL_H
  15 #define CONTROLEXTERNAL_H
  16
  17 #include "Dialog.h"
  18
  19 #include <boost/scoped_ptr.hpp>
  20
  21 #include <string>
  22 #include <vector>
  23
  24
  25 class InsetExternalParams;
  26
  27 namespace lyx {
  28 namespace external {
  29
  30 class Template;
  31
  32 } // namespace external
  33 } // namespace lyx
  34
  35
  36 class ControlExternal : public Dialog::Controller {
  37 public:
  38         ///
  39         ControlExternal(Dialog &);
  40         ///
  41         virtual bool initialiseParams(std::string const & data);
  42         /// clean-up on hide.
  43         virtual void clearParams();
  44         /// clean-up on hide.
  45         virtual void dispatchParams();
  46         ///
  47         virtual bool isBufferDependent() const { return true; }
  48
  49         ///
  50         InsetExternalParams const & params() const;
  51         ///
  52         void setParams(InsetExternalParams const &);
  53
  54         ///
  55         void editExternal();
  56         ///
  57         std::vector<std::string> const getTemplates() const;
  58         ///
  59         int getTemplateNumber(std::string const &) const;
  60         ///
  61         lyx::external::Template getTemplate(int) const;
  62         ///
  63         std::string const Browse(std::string const &) const;
  64 private:
  65         ///
  66         boost::scoped_ptr<InsetExternalParams> params_;
  67 };
  68
  69 #endif // CONTROLEXTERNAL_H