4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Vincent van Ravesteijn
9 * Full author contact details are available in file CREDITS.
12 #ifndef INSETPREVIEW_H
13 #define INSETPREVIEW_H
15 #include "InsetText.h"
17 #include "support/unique_ptr.h"
30 /// An inset with an instant preview
31 class InsetPreview : public InsetText {
35 explicit InsetPreview(Buffer *);
39 InsetPreview(InsetPreview const & other);
41 InsetPreview & operator=(InsetPreview const & other);
43 /// \name Methods inherited from Inset class
45 Inset * clone() const override { return new InsetPreview(*this); }
47 bool neverIndent() const override { return true; }
49 InsetCode lyxCode() const override { return PREVIEW_CODE; }
51 docstring layoutName() const override { return from_ascii("Preview"); }
53 bool descendable(BufferView const & /*bv*/) const override { return true; }
55 std::string contextMenuName() const override
56 { return "context-preview"; }
58 void metrics(MetricsInfo & mi, Dimension & dim) const override;
60 Inset * editXY(Cursor & cur, int x, int y) override;
62 void draw(PainterInfo & pi, int x, int y) const override;
64 void addPreview(DocIterator const & inset_pos,
65 graphics::PreviewLoader & ploader) const override;
67 bool notifyCursorLeaves(Cursor const & old, Cursor & cur) override;
69 void write(std::ostream & os) const override;
71 void edit(Cursor & cur, bool front, EntryDirection entry_from) override;
73 bool canPaintChange(BufferView const &) const override { return true; }
77 /// Retrieves the preview state. Returns true if preview
78 /// is enabled and the preview image is available.
79 bool previewState(BufferView * bv) const;
80 /// Recreates the preview if preview is enabled.
81 void reloadPreview(DocIterator const & pos) const;
82 /// Prepare the preview if preview is enabled.
83 void preparePreview(DocIterator const & pos) const;
86 unique_ptr<RenderPreview> preview_;
91 /// gathers the list of macro definitions used in the given inset
92 MacroNameSet gatherMacroDefinitions(const Buffer* buffer, const Inset * inset);
93 /// returns the LaTeX snippet to compute the preview of the given inset
94 docstring insetToLaTeXSnippet(const Buffer* buffer, const Inset * inset);