4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Alejandro Aguilar Sierra
9 * \author Lars Gullik Bjønnes
10 * \author Matthias Ettrich
12 * Full author contact details are available in file CREDITS.
19 #include "insetbase.h"
20 #include "dimension.h"
21 #include "support/types.h"
45 class InsetOld : public InsetBase {
47 /** This is not quite the correct place for this enum. I think
48 the correct would be to let each subclass of Inset declare
49 its own enum code. Actually the notion of an InsetOld::Code
50 should be avoided, but I am not sure how this could be done
56 TOC_CODE, // do these insets really need a code? (ale)
118 MATHMACRO_CODE, // 30
142 TEXT_TO_INSET_OFFSET = 2
156 typedef dispatch_result RESULT;
161 InsetOld(InsetOld const & in);
168 /// what appears in the minibuffer when opening
169 virtual string const editMessage() const;
171 virtual EDITABLE editable() const;
173 virtual bool isTextInset() const { return false; }
174 /// return true if the inset should be removed automatically
175 virtual bool autoDelete() const;
176 /// returns true the inset can hold an inset of given type
177 virtual bool insetAllowed(InsetOld::Code) const { return false; }
178 /// wrapper around the above
179 bool insetAllowed(InsetOld * in) const;
181 virtual void write(Buffer const *, std::ostream &) const = 0;
183 virtual void read(Buffer const *, LyXLex & lex) = 0;
184 /// returns the number of rows (\n's) of generated tex code.
185 virtual int latex(Buffer const *, std::ostream &,
186 LatexRunParams const &) const = 0;
188 virtual int ascii(Buffer const *,
189 std::ostream &, int linelen = 0) const = 0;
191 virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
193 virtual int docbook(Buffer const *, std::ostream &, bool) const = 0;
195 /// returns LyX code associated with the inset. Used for TOC, ...)
196 virtual InsetOld::Code lyxCode() const { return NO_CODE; }
198 /// returns true to override begin and end inset in file
199 virtual bool directWrite() const;
202 void setInsetName(string const & s) { name_ = s; }
204 string const & getInsetName() const { return name_; }
206 void setOwner(UpdatableInset * inset) { owner_ = inset; }
208 UpdatableInset * owner() const { return owner_; }
210 void parOwner(Paragraph * par) { par_owner_ = par; }
212 Paragraph * parOwner() const { return par_owner_; }
214 void setBackgroundColor(LColor::color);
216 LColor::color backgroundColor() const;
218 int x() const { return top_x; }
220 int y() const { return top_baseline; }
222 // because we could have fake text insets and have to call this
223 // inside them without cast!!!
225 virtual LyXText * getLyXText(BufferView const *,
226 bool recursive = false) const;
228 virtual void deleteLyXText(BufferView *, bool = true) const {}
229 /// returns the actuall scroll-value
230 virtual int scroll(bool recursive=true) const {
231 if (!recursive || !owner_)
236 /// try to get a inset pointer from it's id if we have
237 /// an inset to give back!
238 virtual InsetOld * getInsetFromID(int /*id*/) const { return 0; }
239 /// if this insets owns paragraphs (f.ex. InsetText) then it
240 /// should return it's very first one!
241 virtual ParagraphList * getParagraphs(int /*num*/) const { return 0; }
243 virtual bool haveParagraphs() const {
247 /// return the cursor if we own one otherwise giv'em just the
248 /// BufferView cursor to work with.
249 virtual LyXCursor const & cursor(BufferView * bview) const;
255 /// used to toggle insets
256 // is the inset open?
257 virtual bool isOpen() const { return false; }
259 virtual void open(BufferView *) {}
261 virtual void close(BufferView *) const {}
262 /// check if the font of the char we want inserting is correct
263 /// and modify it if it is not.
264 virtual bool checkInsertChar(LyXFont &);
265 /// we need this here because collapsed insets are only EDITABLE
266 virtual void setFont(BufferView *, LyXFont const &,
267 bool toggleall = false, bool selectall = false);
269 // needed for spellchecking text
271 virtual bool allowSpellcheck() const { return false; }
273 // should this inset be handled like a normal charater
274 virtual bool isChar() const { return false; }
275 // is this equivalent to a letter?
276 virtual bool isLetter() const { return false; }
277 // is this equivalent to a space (which is BTW different from
278 // a line separator)?
279 virtual bool isSpace() const { return false; }
280 // should we break lines after this inset?
281 virtual bool isLineSeparator() const { return false; }
282 // if this inset has paragraphs should they be output all as default
283 // paragraphs with "Standard" layout?
284 virtual bool forceDefaultParagraphs(InsetOld const *) const;
285 /** returns true if, when outputing LaTeX, font changes should
286 be closed before generating this inset. This is needed for
287 insets that may contain several paragraphs */
288 virtual bool noFontChange() const { return false; }
290 virtual void getDrawFont(LyXFont &) const {}
291 /* needed for widths which are % of something
292 returns the value of \textwidth in this inset. Most of the
293 time this is the width of the workarea, but if there is a
294 minipage somewhere, it will be the width of this minipage */
295 virtual int latexTextWidth(BufferView *) const;
297 /// mark the inset contents as erased (for change tracking)
298 virtual void markErased() {}
300 /** Adds a LaTeX snippet to the Preview Loader for transformation
301 * into a bitmap image. Does not start the laoding process.
303 * Most insets have no interest in this capability, so the method
306 virtual void addPreview(lyx::graphics::PreviewLoader &) const {}
308 /** Find the PreviewLoader, add a LaTeX snippet to it and
309 * start the loading process.
311 * Most insets have no interest in this capability, so the method
314 virtual void generatePreview() const {}
320 mutable int top_baseline;
323 /// Used to identify the inset for cursor positioning when undoing
326 static unsigned int inset_id;
328 mutable Dimension dim_;
332 UpdatableInset * owner_;
333 /// the paragraph in which this inset has been inserted
334 Paragraph * par_owner_;
338 LColor::color background_color_;
343 * returns true if pointer argument is valid
344 * and points to an editable inset
346 bool isEditableInset(InsetOld const * i);
350 * returns true if pointer argument is valid
351 * and points to a highly editable inset
353 bool isHighlyEditableInset(InsetOld const * i);