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 "lyxlength.h"
27 /// This struct holds all the parameters needed by insetGraphics.
28 struct InsetGraphicsParams
32 /// Scaling the Screen inside Lyx
33 unsigned int lyxscale;
34 /// How to display the image inside LyX
35 grfx::DisplayType display;
36 /// Scaling for output (LaTeX)
38 /// sizes for output (LaTeX)
42 /// Keep the ratio between height and width when resizing.
46 /// what to do with zipped files
49 /// The bounding box with "xLB yLB yRT yRT ", divided by a space!
56 /// Origin point of rotation
58 /// Do we have a subcaption?
60 /// The text of the subcaption.
61 string subcaptionText;
62 /// any userdefined special command
66 InsetGraphicsParams();
68 InsetGraphicsParams(InsetGraphicsParams const &);
70 InsetGraphicsParams & operator=(InsetGraphicsParams const &);
71 /// Save the parameters in the LyX format stream.
72 void Write(std::ostream & os, string const & bufpath) const;
73 /// If the token belongs to our parameters, read it.
74 bool Read(LyXLex & lex, string const & token, string const & bufpath);
76 // Only a subset of InsetGraphicsParams is needed for display purposes.
77 // This function also interrogates lyxrc to ascertain whether
79 grfx::Params as_grfxParams() const;
82 /// Initialize the object to a default status.
84 /// Copy the other objects content to us, used in copy c-tor and assignment
85 void copy(InsetGraphicsParams const & params);
89 bool operator==(InsetGraphicsParams const &, InsetGraphicsParams const &);
91 bool operator!=(InsetGraphicsParams const &, InsetGraphicsParams const &);