3 * \file InsetListings.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
12 #ifndef INSET_LISTINGS_H
13 #define INSET_LISTINGS_H
15 #include "LaTeXFeatures.h"
16 #include "InsetListingsParams.h"
21 /////////////////////////////////////////////////////////////////////////
25 /////////////////////////////////////////////////////////////////////////
27 /// A collapsable text inset for program listings.
28 class InsetListings : public InsetCollapsable
32 InsetListings(Buffer *, InsetListingsParams const & par = InsetListingsParams());
36 static void string2params(std::string const &, InsetListingsParams &);
38 static std::string params2string(InsetListingsParams const &);
41 bool isLabeled() const { return true; }
43 bool noFontChange() const { return true; }
45 InsetCode lyxCode() const { return LISTINGS_CODE; }
46 /// lstinline is inlined, normal listing is displayed
47 DisplayType display() const;
49 docstring name() const { return from_ascii("Listings"); }
50 // Update the counters of this inset and of its contents
51 void updateBuffer(ParIterator const &, UpdateType);
53 void write(std::ostream & os) const;
55 void read(Lexer & lex);
57 int latex(odocstream &, OutputParams const &) const;
59 docstring xhtml(XHTMLStream &, OutputParams const &) const;
61 void validate(LaTeXFeatures &) const;
63 bool showInsetDialog(BufferView *) const;
65 InsetListingsParams const & params() const { return params_; }
67 InsetListingsParams & params() { return params_; }
69 docstring contextMenu(BufferView const & bv, int x, int y) const;
71 void doDispatch(Cursor & cur, FuncRequest & cmd);
73 bool getStatus(Cursor & cur, FuncRequest const & cmd, FuncStatus &) const;
75 Inset * clone() const { return new InsetListings(*this); }
77 docstring const buttonLabel(BufferView const & bv) const;
79 docstring getCaption(OutputParams const &) const;
81 bool insetAllowed(InsetCode c) const { return c == CAPTION_CODE; }
84 InsetListingsParams params_;
89 #endif // INSET_LISTINGS_H