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                   OutputParams const &) const;
  50         ///
  51         int plaintext(Buffer const &, std::ostream &,
  52                   OutputParams const &) const;
  53         ///
  54         int linuxdoc(Buffer const &, std::ostream &,
  55                      OutputParams const &) const;
  56         ///
  57         int docbook(Buffer const &, std::ostream &,
  58                     OutputParams const &) const;
  59
  60         /** Tell LyX what the latex features you need i.e. what latex packages
  61             you need to be included.
  62          */
  63         void validate(LaTeXFeatures & features) const;
  64
  65         /// returns LyX code associated with the inset. Used for TOC, ...)
  66         InsetOld::Code lyxCode() const { return InsetOld::GRAPHICS_CODE; }
  67
  68         ///
  69         virtual std::auto_ptr<InsetBase> clone() const;
  70
  71         /** Set the inset parameters, used by the GUIndependent dialog.
  72             Return true of new params are different from what was so far.
  73         */
  74         bool setParams(InsetGraphicsParams const & params);
  75
  76         /// Get the inset parameters, used by the GUIndependent dialog.
  77         InsetGraphicsParams const & params() const;
  78         ///
  79         void draw(PainterInfo & pi, int x, int y) const;
  80         ///
  81         void edit(LCursor & cur, bool left);
  82         ///
  83         void editGraphics(InsetGraphicsParams const &, Buffer const &) const;
  84 protected:
  85         ///
  86         void priv_dispatch(LCursor & cur, FuncRequest & cmd);
  87 private:
  88         ///
  89         friend class InsetGraphicsMailer;
  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         /// Create length values for docbook export.
  99         std::string const toDocbookLength(LyXLength const & len) const;
 100         /// Create the atributes for docbook export.
 101         std::string const createDocBookAttributes() const;
 102         /// Convert the file if needed, and return the location of the file.
 103         std::string const prepareFile(Buffer const & buf, OutputParams const &) const;
 104
 105         ///
 106         InsetGraphicsParams params_;
 107
 108         /// holds the entity name that defines the graphics location (SGML).
 109         std::string const graphic_label;
 110
 111         /// The thing that actually draws the image on LyX's screen.
 112         boost::scoped_ptr<RenderGraphic> const graphic_;
 113 };
 114
 115
 116 #include "mailinset.h"
 117
 118 class InsetGraphicsMailer : public MailInset {
 119 public:
 120         ///
 121         InsetGraphicsMailer(InsetGraphics & inset);
 122         ///
 123         virtual InsetBase & inset() const { return inset_; }
 124         ///
 125         virtual std::string const & name() const { return name_; }
 126         ///
 127         virtual std::string const inset2string(Buffer const &) const;
 128         ///
 129         static void string2params(std::string const & data,
 130                                   Buffer const & buffer,
 131                                   InsetGraphicsParams &);
 132         ///
 133         static std::string const params2string(InsetGraphicsParams const &,
 134                                           Buffer const &);
 135 private:
 136         ///
 137         static std::string const name_;
 138         ///
 139         InsetGraphics & inset_;
 140 };
 141
 142 #endif