2 /* This file is part of
3 * ======================================================
5 * LyX, The Document Processor
7 * Copyright 1995 Matthias Ettrich
8 * Copyright 1995-2001 the LyX Team.
11 * \author Herbert Voss <voss@lyx.org>
12 * ====================================================== */
14 #ifndef INSET_GRAPHICS_H
15 #define INSET_GRAPHICS_H
22 #include "graphics/GraphicsTypes.h"
23 #include "insets/inset.h"
24 #include "insets/insetgraphicsParams.h"
25 // We need a signal here to hide an active dialog when we are deleted.
26 #include "sigc++/signal_system.h"
32 class InsetGraphics : public Inset, public SigC::Object {
37 InsetGraphics(InsetGraphics const &, bool same_id = false);
41 int ascent(BufferView *, LyXFont const &) const;
43 int descent(BufferView *, LyXFont const &) const;
45 int width(BufferView *, LyXFont const &) const;
47 void draw(BufferView *, LyXFont const &, int, float &, bool) const;
49 void edit(BufferView *, int, int, unsigned int);
51 void edit(BufferView * bv, bool front = true);
53 EDITABLE editable() const;
55 void write(Buffer const *, std::ostream &) const;
57 void read(Buffer const *, LyXLex & lex);
59 /** returns the number of rows (\n's) of generated tex code.
60 #fragile == true# means, that the inset should take care about
61 fragile commands by adding a #\protect# before.
63 int latex(Buffer const *, std::ostream &,
64 bool fragile, bool free_spc) const;
66 int ascii(Buffer const *, std::ostream &, int linelen) const;
68 int linuxdoc(Buffer const *, std::ostream &) const;
70 int docbook(Buffer const *, std::ostream &) const;
72 /** Tell LyX what the latex features you need i.e. what latex packages
73 you need to be included.
75 void validate(LaTeXFeatures & features) const;
77 /// returns LyX code associated with the inset. Used for TOC, ...)
78 Inset::Code lyxCode() const { return Inset::GRAPHICS_CODE; }
81 virtual Inset * clone(Buffer const &, bool same_id = false) const;
83 /** Set the inset parameters, used by the GUIndependent dialog.
84 Return true of new params are different from what was so far.
86 bool setParams(InsetGraphicsParams const & params);
88 /// Get the inset parameters, used by the GUIndependent dialog.
89 InsetGraphicsParams const & params() const;
91 /** This signal is connected by our dialog and called when the inset
94 SigC::Signal0<void> hideDialog;
97 /// Set the cached variables
98 void setCache() const;
99 /// Is the image ready to draw, or should we display a message instead?
100 bool drawImage() const;
102 /// Read the inset native format
103 void readInsetGraphics(Buffer const * buf, LyXLex & lex);
104 /// Read the FigInset file format
105 void readFigInset(Buffer const * buf, LyXLex & lex);
107 /// Update the inset after parameter change.
108 void updateInset() const;
109 /// Get the status message, depends on the image loading status.
110 string const statusMessage() const;
111 /// Create the options for the latex command.
112 string const createLatexOptions() const;
113 /// Convert the file if needed, and return the location of the file.
114 string const prepareFile(Buffer const * buf) const;
117 InsetGraphicsParams params_;
119 /// holds the entity name that defines the graphics location (SGML).
120 string const graphic_label;
122 /// The cached variables
123 mutable grfx::ImageStatus cached_status_;
125 mutable grfx::ImagePtr cached_image_;
127 mutable bool cache_filled_;