]> git.lyx.org Git - lyx.git/blob - src/insets/insetgraphics.h
Final touch 'inset display()'; fix 'is a bit silly' bug
[lyx.git] / src / insets / insetgraphics.h
1 // -*- C++ -*-
2 /**
3  * \file insetgraphics.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author Baruch Even
8  * \author Herbert Voß
9  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #ifndef INSET_GRAPHICS_H
14 #define INSET_GRAPHICS_H
15
16 #include "inset.h"
17 #include "insetgraphicsParams.h"
18
19 #include <boost/scoped_ptr.hpp>
20 #include <boost/signals/trackable.hpp>
21
22 class Dialogs;
23 class RenderGraphic;
24 class LaTeXFeatures;
25
26 ///
27 class InsetGraphics : public InsetOld, public boost::signals::trackable {
28 public:
29         ///
30         InsetGraphics();
31         ///
32         InsetGraphics(InsetGraphics const &);
33         ///
34         ~InsetGraphics();
35         ///
36         void metrics(MetricsInfo &, Dimension &) const;
37         ///
38         EDITABLE editable() const;
39         ///
40         void write(Buffer const &, std::ostream &) const;
41         ///
42         void read(Buffer const &, LyXLex & lex);
43
44         /** returns the number of rows (\n's) of generated tex code.
45          #fragile == true# means, that the inset should take care about
46          fragile commands by adding a #\protect# before.
47          */
48         int latex(Buffer const &, std::ostream &,
49                   LatexRunParams const &) const;
50         ///
51         int ascii(Buffer const &, std::ostream &, int linelen) const;
52         ///
53         int linuxdoc(Buffer const &, std::ostream &) const;
54         ///
55         int docbook(Buffer const &, std::ostream &, bool mixcont) const;
56
57         /** Tell LyX what the latex features you need i.e. what latex packages
58             you need to be included.
59          */
60         void validate(LaTeXFeatures & features) const;
61
62         /// returns LyX code associated with the inset. Used for TOC, ...)
63         InsetOld::Code lyxCode() const { return InsetOld::GRAPHICS_CODE; }
64
65         ///
66         virtual std::auto_ptr<InsetBase> clone() const;
67
68         /** Set the inset parameters, used by the GUIndependent dialog.
69             Return true of new params are different from what was so far.
70         */
71         bool setParams(InsetGraphicsParams const & params);
72
73         /// Get the inset parameters, used by the GUIndependent dialog.
74         InsetGraphicsParams const & params() const;
75         ///
76         void draw(PainterInfo & pi, int x, int y) const;
77 protected:
78         ///
79         virtual
80         dispatch_result
81         priv_dispatch(FuncRequest const & cmd, idx_type &, pos_type &);
82 private:
83         ///
84         friend class InsetGraphicsMailer;
85
86         /** This method is connected to the graphics loader, so we are
87          *  informed when the image has been loaded.
88          */
89         void statusChanged() const;
90
91         /// Read the inset native format
92         void readInsetGraphics(LyXLex & lex, std::string const & bufpath);
93
94         /// Get the status message, depends on the image loading status.
95         std::string const statusMessage() const;
96         /// Create the options for the latex command.
97         std::string const createLatexOptions() const;
98         /// Convert the file if needed, and return the location of the file.
99         std::string const prepareFile(Buffer const & buf, LatexRunParams const &) const;
100
101         ///
102         InsetGraphicsParams params_;
103
104         /// holds the entity name that defines the graphics location (SGML).
105         std::string const graphic_label;
106
107         /// The thing that actually draws the image on LyX's screen.
108         boost::scoped_ptr<RenderGraphic> const graphic_;
109 };
110
111
112 #include "mailinset.h"
113
114 class InsetGraphicsMailer : public MailInset {
115 public:
116         ///
117         InsetGraphicsMailer(InsetGraphics & inset);
118         ///
119         virtual InsetBase & inset() const { return inset_; }
120         ///
121         virtual std::string const & name() const { return name_; }
122         ///
123         virtual std::string const inset2string(Buffer const &) const;
124         ///
125         static void string2params(std::string const & data,
126                                   Buffer const & buffer,
127                                   InsetGraphicsParams &);
128         ///
129         static std::string const params2string(InsetGraphicsParams const &,
130                                           Buffer const &);
131 private:
132         ///
133         static std::string const name_;
134         ///
135         InsetGraphics & inset_;
136 };
137
138 #endif