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 <set>
  20
  21 namespace lyx {
  22
  23 class RenderGraphic;
  24 class LaTeXFeatures;
  25
  26 /////////////////////////////////////////////////////////////////////////
  27 //
  28 // InsetGraphics
  29 //
  30 /////////////////////////////////////////////////////////////////////////
  31
  32 /// Used for images etc.
  33 class InsetGraphics : public Inset
  34 {
  35 public:
  36         ///
  37         explicit InsetGraphics(Buffer * buf);
  38         ///
  39         ~InsetGraphics();
  40
  41         ///
  42         static void string2params(std::string const & data,
  43                                   Buffer const & buffer,
  44                                   InsetGraphicsParams &);
  45         ///
  46         static std::string params2string(InsetGraphicsParams const &,
  47                                           Buffer const &);
  48
  49         /** Set the inset parameters, used by the GUIndependent dialog.
  50             Return true of new params are different from what was so far.
  51         */
  52         bool setParams(InsetGraphicsParams const & params);
  53
  54         InsetGraphicsParams getParams() const { return params_;}
  55         ///
  56         bool clickable(BufferView const &, int, int) const { return true; }
  57         ///
  58         bool canPaintChange(BufferView const &) const { return true; }
  59         ///
  60         InsetGraphics * asInsetGraphics() { return this; }
  61         ///
  62         InsetGraphics const * asInsetGraphics() const { return this; }
  63
  64         ///
  65         bool isLabeled() const { return true; }
  66         ///
  67         bool hasSettings() const { return true; }
  68         ///
  69         void write(std::ostream &) const;
  70         ///
  71         void read(Lexer & lex);
  72         /** returns the number of rows (\n's) of generated tex code.
  73          #fragile == true# means, that the inset should take care about
  74          fragile commands by adding a #\protect# before.
  75          */
  76         void latex(otexstream &, OutputParams const &) const;
  77         ///
  78         int plaintext(odocstringstream & ods, OutputParams const & op,
  79                       size_t max_length = INT_MAX) const;
  80         ///
  81         int docbook(odocstream &, OutputParams const &) const;
  82         ///
  83         docstring xhtml(XHTMLStream & os, OutputParams const &) const;
  84         /** Tell LyX what the latex features you need i.e. what latex packages
  85             you need to be included.
  86          */
  87         void validate(LaTeXFeatures & features) const;
  88         /// returns LyX code associated with the inset. Used for TOC, ...)
  89         InsetCode lyxCode() const { return GRAPHICS_CODE; }
  90         ///
  91         docstring layoutName() const { return from_ascii("Graphics"); }
  92         /// Get the inset parameters, used by the GUIndependent dialog.
  93         InsetGraphicsParams const & params() const;
  94
  95         ///
  96         int topOffset(BufferView const *) const { return 0; }
  97         ///
  98         int bottomOffset(BufferView const *) const { return 0; }
  99         ///
 100         int leftOffset(BufferView const *) const { return 0; }
 101         ///
 102         int rightOffset(BufferView const *) const { return 0; }
 103
 104         ///
 105         void metrics(MetricsInfo &, Dimension &) const;
 106         ///
 107         void draw(PainterInfo & pi, int x, int y) const;
 108         ///
 109         bool showInsetDialog(BufferView * bv) const;
 110         ///
 111         void editGraphics(InsetGraphicsParams const &) const;
 112         ///
 113         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
 114         ///
 115         void addToToc(DocIterator const & di, bool output_active,
 116                                   UpdateType utype, TocBackend & backend) const;
 117         ///
 118         std::string contextMenuName() const;
 119         /// Force inset into LTR environment if surroundings are RTL
 120         bool forceLTR(OutputParams const &) const { return true; }
 121         ///
 122         void doDispatch(Cursor & cur, FuncRequest & cmd);
 123         ///
 124         Inset * clone() const;
 125         /// Get the status message, depends on the image loading status.
 126         std::string statusMessage() const;
 127         /// Get the output bounding box accounting for raster formats.
 128         void outBoundingBox(graphics::BoundingBox &) const;
 129         /// Create the options for the latex command.
 130         std::string createLatexOptions(bool const ps) const;
 131         /// Create length values for docbook export.
 132         docstring toDocbookLength(Length const & len) const;
 133         /// Create the atributes for docbook export.
 134         docstring createDocBookAttributes() const;
 135         /// Convert the file if needed, and return the location of the file.
 136         /// This version is for use with LaTeX-style output.
 137         std::string prepareFile(OutputParams const &) const;
 138         /// Convert the file if needed, and return the location of the file.
 139         /// This version is for use with HTML-style output.
 140         /// \return the new filename, relative to the location of the HTML file,
 141         /// or an empty string on error.
 142         std::string prepareHTMLFile(OutputParams const & runparams) const;
 143         ///
 144         OutputParams::CtObject CtObject(OutputParams const &) const { return OutputParams::CT_OBJECT; }
 145
 146 private:
 147         ///
 148         InsetGraphics(InsetGraphics const &);
 149
 150         ///
 151         InsetGraphicsParams params_;
 152         /// holds the entity name that defines the graphics location (SGML).
 153         docstring const graphic_label;
 154         ///
 155         docstring toolTip(BufferView const & bv, int x, int y) const;
 156         /// The thing that actually draws the image on LyX's screen.
 157         RenderGraphic * graphic_;
 158 };
 159
 160 namespace graphics {
 161
 162         /// Saves the list of currently used groups in the document.
 163         void getGraphicsGroups(Buffer const &, std::set<std::string> &);
 164
 165         /// how many members has the current group?
 166         int countGroupMembers(Buffer const &, std::string const &);
 167
 168         /// Returns parameters of a given graphics group (except filename).
 169         std::string getGroupParams(Buffer const &, std::string const &);
 170
 171         /** Synchronize all Graphics insets of the group.
 172             Both groupId and params are taken from argument.
 173         */
 174         void unifyGraphicsGroups(Buffer &, std::string const &);
 175         InsetGraphics * getCurrentGraphicsInset(Cursor const &);
 176
 177 } // namespace graphics
 178
 179 } // namespace lyx
 180
 181 #endif // INSET_GRAPHICS_H