3 * \file InsetGraphicsParams.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
13 #ifndef INSETGRAPHICSPARAMS_H
14 #define INSETGRAPHICSPARAMS_H
17 #include "graphics/GraphicsTypes.h"
19 #include "EmbeddedFiles.h"
23 namespace graphics { class Params; }
29 /// This class holds all the parameters needed by insetGraphics.
30 class InsetGraphicsParams
34 EmbeddedFile filename;
35 /// Scaling the Screen inside Lyx
36 unsigned int lyxscale;
37 /// How to display the image inside LyX
38 graphics::DisplayType display;
39 /// Scaling for output (LaTeX)
41 /// sizes for output (LaTeX)
45 /// Keep the ratio between height and width when resizing.
49 /// what to do with zipped files
51 /// scale image before rotating
52 bool scaleBeforeRotation;
54 /// The bounding box with "xLB yLB yRT yRT ", divided by a space!
60 std::string rotateAngle;
61 /// Origin point of rotation
62 std::string rotateOrigin;
63 /// Do we have a subcaption?
65 /// The text of the subcaption.
66 std::string subcaptionText;
67 /// any userdefined special command
71 InsetGraphicsParams();
73 InsetGraphicsParams(InsetGraphicsParams const &);
75 void operator=(InsetGraphicsParams const &);
76 /// Save the parameters in the LyX format stream.
77 /// Buffer is needed to figure out if a figure is embedded.
78 void Write(std::ostream & os, Buffer const & buf) const;
79 /// If the token belongs to our parameters, read it.
80 bool Read(Lexer & lex, std::string const & token, std::string const & bufpath);
82 // Only a subset of InsetGraphicsParams is needed for display purposes.
83 // This function also interrogates lyxrc to ascertain whether
85 graphics::Params as_grfxParams() const;
88 /// Initialize the object to a default status.
90 /// Copy the other objects content to us, used in copy c-tor and assignment
91 void copy(InsetGraphicsParams const & params);
95 bool operator==(InsetGraphicsParams const &, InsetGraphicsParams const &);
97 bool operator!=(InsetGraphicsParams const &, InsetGraphicsParams const &);