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 <set>
  17 #include "Inset.h"
  18 #include "InsetGraphicsParams.h"
  19
  20 #include <boost/scoped_ptr.hpp>
  21 #include <boost/signals/trackable.hpp>
  22
  23
  24 namespace lyx {
  25
  26 class RenderGraphic;
  27 class LaTeXFeatures;
  28
  29 /////////////////////////////////////////////////////////////////////////
  30 //
  31 // InsetGraphics
  32 //
  33 /////////////////////////////////////////////////////////////////////////
  34
  35 /// Used for images etc.
  36 class InsetGraphics : public Inset, public boost::signals::trackable
  37 {
  38 public:
  39         ///
  40         InsetGraphics(Buffer & buf);
  41         ///
  42         ~InsetGraphics();
  43
  44         ///
  45         static void string2params(std::string const & data,
  46                                   Buffer const & buffer,
  47                                   InsetGraphicsParams &);
  48         ///
  49         static std::string params2string(InsetGraphicsParams const &,
  50                                           Buffer const &);
  51         /// Saves the list of currently used groups in the document.
  52         static void getGraphicsGroups(Buffer const &, std::set<std::string> &);
  53         /// Returns parameters of a given graphics group (except filename).
  54         static std::string getGroupParams(Buffer const &,
  55                                                 std::string const &);
  56         /** Synchronize all Graphics insets of the group.
  57             Both groupId and params are taken from argument.
  58         */
  59         static void unifyGraphicsGroups(Buffer const &, std::string const &);
  60
  61         /** Set the inset parameters, used by the GUIndependent dialog.
  62             Return true of new params are different from what was so far.
  63         */
  64         bool setParams(InsetGraphicsParams const & params);
  65
  66         InsetGraphicsParams getParams() const { return params_;}
  67
  68 private:
  69         ///
  70         InsetGraphics(InsetGraphics const &);
  71
  72         ///
  73         bool isLabeled() const { return true; }
  74         void metrics(MetricsInfo &, Dimension &) const;
  75         ///
  76         EDITABLE editable() const;
  77         ///
  78         void write(std::ostream &) const;
  79         ///
  80         void read(Lexer & lex);
  81         /** returns the number of rows (\n's) of generated tex code.
  82          #fragile == true# means, that the inset should take care about
  83          fragile commands by adding a #\protect# before.
  84          */
  85         int latex(odocstream &, OutputParams const &) const;
  86         ///
  87         int plaintext(odocstream &, OutputParams const &) const;
  88         ///
  89         int docbook(odocstream &, OutputParams const &) const;
  90         /** Tell LyX what the latex features you need i.e. what latex packages
  91             you need to be included.
  92          */
  93         void validate(LaTeXFeatures & features) const;
  94         /// returns LyX code associated with the inset. Used for TOC, ...)
  95         InsetCode lyxCode() const { return GRAPHICS_CODE; }
  96         /// Get the inset parameters, used by the GUIndependent dialog.
  97         InsetGraphicsParams const & params() const;
  98         ///
  99         void draw(PainterInfo & pi, int x, int y) const;
 100         ///
 101         void edit(Cursor & cur, bool front, EntryDirection entry_from);
 102         ///
 103         void editGraphics(InsetGraphicsParams const &, Buffer const &) const;
 104         ///
 105         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 106         ///
 107         void addToToc(ParConstIterator const &) const;
 108         ///
 109         docstring contextMenu(BufferView const & bv, int x, int y) const;
 110         /// Force inset into LTR environment if surroundings are RTL?
 111         bool forceLTR() const { return true; }
 112         ///
 113         void doDispatch(Cursor & cur, FuncRequest & cmd);
 114         ///
 115         Inset * clone() const;
 116         /// Get the status message, depends on the image loading status.
 117         std::string statusMessage() const;
 118         /// Create the options for the latex command.
 119         std::string createLatexOptions() const;
 120         /// Create length values for docbook export.
 121         docstring toDocbookLength(Length const & len) const;
 122         /// Create the atributes for docbook export.
 123         docstring createDocBookAttributes() const;
 124         /// Convert the file if needed, and return the location of the file.
 125         std::string prepareFile(OutputParams const &) const;
 126
 127         ///
 128         InsetGraphicsParams params_;
 129         /// holds the entity name that defines the graphics location (SGML).
 130         docstring const graphic_label;
 131         /// The thing that actually draws the image on LyX's screen.
 132         boost::scoped_ptr<RenderGraphic> const graphic_;
 133 };
 134
 135 } // namespace lyx
 136
 137 #endif // INSET_GRAPHICS_H