src/insets/InsetListings.h

   1 // -*- C++ -*-
   2 /**
   3  * \file InsetListings.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Bo Peng
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef INSETLISTINGS_H
  13 #define INSETLISTINGS_H
  14
  15 #include "LaTeXFeatures.h"
  16 #include "InsetERT.h"
  17 #include "InsetListingsParams.h"
  18 #include "MailInset.h"
  19
  20
  21 namespace lyx {
  22
  23 /** A collapsable text inset for program listings.
  24  */
  25
  26
  27 class InsetListings : public InsetCollapsable {
  28 public:
  29         ///
  30         InsetListings(Buffer const &, InsetListingsParams const & par = InsetListingsParams());
  31         ///
  32         ~InsetListings();
  33         ///
  34         InsetCode lyxCode() const { return LISTINGS_CODE; }
  35         /// lstinline is inlined, normal listing is displayed
  36         DisplayType display() const;
  37         ///
  38         docstring name() const { return from_ascii("Listings"); }
  39         // Update the counters of this inset and of its contents
  40         void updateLabels(ParIterator const &);
  41         ///
  42         void write(std::ostream & os) const;
  43         ///
  44         void read(Lexer & lex);
  45         ///
  46         docstring editMessage() const;
  47         ///
  48         bool isMacroScope() const { return true; }
  49         ///
  50         int latex(odocstream &, OutputParams const &) const;
  51         ///
  52         void validate(LaTeXFeatures &) const;
  53         ///
  54         bool showInsetDialog(BufferView *) const;
  55         ///
  56         InsetListingsParams const & params() const { return params_; }
  57         ///
  58         InsetListingsParams & params() { return params_; }
  59 private:
  60         ///
  61         void doDispatch(Cursor & cur, FuncRequest & cmd);
  62         ///
  63         bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
  64         ///
  65         Inset * clone() const { return new InsetListings(*this); }
  66         ///
  67         void setButtonLabel();
  68         ///
  69         docstring getCaption(OutputParams const &) const;
  70         ///
  71         InsetListingsParams params_;
  72 };
  73
  74
  75 class InsetListingsMailer : public MailInset {
  76 public:
  77         ///
  78         InsetListingsMailer(InsetListings & inset);
  79         ///
  80         virtual Inset & inset() const { return inset_; }
  81         ///
  82         virtual std::string const & name() const { return name_; }
  83         ///
  84         virtual std::string const inset2string(Buffer const &) const;
  85         ///
  86         static void string2params(std::string const &,
  87                 InsetListingsParams &);
  88         ///
  89         static std::string const params2string(InsetListingsParams const &);
  90 private:
  91         ///
  92         static std::string const name_;
  93         ///
  94         InsetListings & inset_;
  95 };
  96
  97
  98 } // namespace lyx
  99
 100 #endif