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         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(int, int) const { return true; }
  57
  58 private:
  59         ///
  60         InsetGraphics(InsetGraphics const &);
  61
  62         ///
  63         bool isLabeled() const { return true; }
  64         void metrics(MetricsInfo &, Dimension &) const;
  65         ///
  66         bool hasSettings() const { return true; }
  67         ///
  68         void write(std::ostream &) const;
  69         ///
  70         void read(Lexer & lex);
  71         /** returns the number of rows (\n's) of generated tex code.
  72          #fragile == true# means, that the inset should take care about
  73          fragile commands by adding a #\protect# before.
  74          */
  75         void latex(otexstream &, OutputParams const &) const;
  76         ///
  77         int plaintext(odocstringstream & ods, OutputParams const & op,
  78                       size_t max_length = INT_MAX) const;
  79         ///
  80         int docbook(odocstream &, OutputParams const &) const;
  81         ///
  82         docstring xhtml(XHTMLStream & os, OutputParams const &) const;
  83         /** Tell LyX what the latex features you need i.e. what latex packages
  84             you need to be included.
  85          */
  86         void validate(LaTeXFeatures & features) const;
  87         /// returns LyX code associated with the inset. Used for TOC, ...)
  88         InsetCode lyxCode() const { return GRAPHICS_CODE; }
  89         /// Get the inset parameters, used by the GUIndependent dialog.
  90         InsetGraphicsParams const & params() const;
  91         ///
  92         void draw(PainterInfo & pi, int x, int y) const;
  93         ///
  94         bool showInsetDialog(BufferView * bv) const;
  95         ///
  96         void editGraphics(InsetGraphicsParams const &) const;
  97         ///
  98         bool getStatus(Cursor &, FuncRequest const &, FuncStatus &) const;
  99         ///
 100         void addToToc(DocIterator const & di, bool output_active) const;
 101         ///
 102         std::string contextMenuName() const;
 103         /// Force inset into LTR environment if surroundings are RTL
 104         bool forceLTR() const { return true; }
 105         ///
 106         void doDispatch(Cursor & cur, FuncRequest & cmd);
 107         ///
 108         Inset * clone() const;
 109         /// Get the status message, depends on the image loading status.
 110         std::string statusMessage() const;
 111         /// Create the options for the latex command.
 112         std::string createLatexOptions() const;
 113         /// Create length values for docbook export.
 114         docstring toDocbookLength(Length const & len) const;
 115         /// Create the atributes for docbook export.
 116         docstring createDocBookAttributes() const;
 117         /// Convert the file if needed, and return the location of the file.
 118         /// This version is for use with LaTeX-style output.
 119         std::string prepareFile(OutputParams const &) const;
 120         /// Convert the file if needed, and return the location of the file.
 121         /// This version is for use with HTML-style output.
 122         /// \return the new filename, relative to the location of the HTML file,
 123         /// or an empty string on error.
 124         std::string prepareHTMLFile(OutputParams const & runparams) const;
 125
 126         ///
 127         InsetGraphicsParams params_;
 128         /// holds the entity name that defines the graphics location (SGML).
 129         docstring const graphic_label;
 130         ///
 131         docstring toolTip(BufferView const & bv, int x, int y) const;
 132         /// The thing that actually draws the image on LyX's screen.
 133         RenderGraphic * graphic_;
 134 };
 135
 136 namespace graphics {
 137
 138         /// Saves the list of currently used groups in the document.
 139         void getGraphicsGroups(Buffer const &, std::set<std::string> &);
 140
 141         /// how many members has the current group?
 142         int countGroupMembers(Buffer const &, std::string const &);
 143
 144         /// Returns parameters of a given graphics group (except filename).
 145         std::string getGroupParams(Buffer const &, std::string const &);
 146
 147         /** Synchronize all Graphics insets of the group.
 148             Both groupId and params are taken from argument.
 149         */
 150         void unifyGraphicsGroups(Buffer &, std::string const &);
 151         InsetGraphics * getCurrentGraphicsInset(Cursor const &);
 152
 153 }
 154
 155 } // namespace lyx
 156
 157 #endif // INSET_GRAPHICS_H