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.
18 #include "insetbase.h"
19 #include "dimension.h"
20 #include "ParagraphList_fwd.h"
43 class InsetOld : public InsetBase {
45 /** This is not quite the correct place for this enum. I think
46 the correct would be to let each subclass of Inset declare
47 its own enum code. Actually the notion of an InsetOld::Code
48 should be avoided, but I am not sure how this could be done
54 TOC_CODE, // do these insets really need a code? (ale)
116 MATHMACRO_CODE, // 30
144 TEXT_TO_INSET_OFFSET = 2
160 InsetOld(InsetOld const & in);
167 /// what appears in the minibuffer when opening
168 virtual std::string const editMessage() const;
170 virtual EDITABLE editable() const;
172 virtual bool isTextInset() const { return false; }
173 /// return true if the inset should be removed automatically
174 virtual bool autoDelete() const;
175 /// returns true the inset can hold an inset of given type
176 virtual bool insetAllowed(InsetOld::Code) const { return false; }
177 /// wrapper around the above
178 bool insetAllowed(InsetOld * in) const;
180 virtual void write(Buffer const &, std::ostream &) const = 0;
182 virtual void read(Buffer const &, LyXLex & lex) = 0;
183 /// returns the number of rows (\n's) of generated tex code.
184 virtual int latex(Buffer const &, std::ostream &,
185 LatexRunParams const &) const = 0;
187 virtual int ascii(Buffer const &, std::ostream &,
188 LatexRunParams const &) const = 0;
190 virtual int linuxdoc(Buffer const &, std::ostream &,
191 LatexRunParams const &) const = 0;
193 virtual int docbook(Buffer const &, std::ostream &,
194 LatexRunParams const &) const = 0;
196 /// returns LyX code associated with the inset. Used for TOC, ...)
197 virtual InsetOld::Code lyxCode() const { return NO_CODE; }
199 /// returns true to override begin and end inset in file
200 virtual bool directWrite() const;
203 void setInsetName(std::string const & s) { name_ = s; }
205 std::string const & getInsetName() const { return name_; }
207 void setOwner(UpdatableInset * inset) { owner_ = inset; }
209 UpdatableInset * owner() const { return owner_; }
211 void setBackgroundColor(LColor_color);
213 LColor_color backgroundColor() const;
215 int x() const { return top_x; }
217 int y() const { return top_baseline; }
219 // because we could have fake text insets and have to call this
220 // inside them without cast!!!
222 virtual LyXText * getLyXText(BufferView const *,
223 bool recursive = false) const;
225 virtual void deleteLyXText(BufferView *, bool = true) const {}
226 /// returns the actuall scroll-value
227 virtual int scroll(bool recursive=true) const {
228 if (!recursive || !owner_)
233 /// try to get a inset pointer from it's id if we have
234 /// an inset to give back!
235 virtual InsetOld * getInsetFromID(int /*id*/) const { return 0; }
236 /// if this insets owns paragraphs (f.ex. InsetText) then it
237 /// should return it's very first one!
238 virtual ParagraphList * getParagraphs(int /*num*/) const { return 0; }
240 virtual LyXText * getText(int /*num*/) const { return 0; }
242 virtual bool haveParagraphs() const {
246 /// return the cursor if we own one otherwise giv'em just the
247 /// BufferView cursor to work with.
248 virtual LyXCursor const & cursor(BufferView * bview) const;
253 /// lock cell with given index
254 virtual void edit(BufferView *, int /*index*/) {}
256 /// used to toggle insets
257 // is the inset open?
258 virtual bool isOpen() const { return false; }
260 virtual void open(BufferView *) {}
262 virtual void close(BufferView *) const {}
263 /// check if the font of the char we want inserting is correct
264 /// and modify it if it is not.
265 virtual bool checkInsertChar(LyXFont &);
266 /// we need this here because collapsed insets are only EDITABLE
267 virtual void setFont(BufferView *, LyXFont const &,
268 bool toggleall = false, bool selectall = false);
270 // needed for spellchecking text
272 virtual bool allowSpellcheck() const { return false; }
274 // should this inset be handled like a normal charater
275 virtual bool isChar() const { return false; }
276 // is this equivalent to a letter?
277 virtual bool isLetter() const { return false; }
278 // is this equivalent to a space (which is BTW different from
279 // a line separator)?
280 virtual bool isSpace() const { return false; }
281 // should we have a non-filled line before this inset?
282 virtual bool display() const { return false; }
283 // should we break lines after this inset?
284 virtual bool isLineSeparator() const { return false; }
285 // if this inset has paragraphs should they be output all as default
286 // paragraphs with "Standard" layout?
287 virtual bool forceDefaultParagraphs(InsetOld const *) const;
288 /** returns true if, when outputing LaTeX, font changes should
289 be closed before generating this inset. This is needed for
290 insets that may contain several paragraphs */
291 virtual bool noFontChange() const { return false; }
293 virtual void getDrawFont(LyXFont &) const {}
294 /* needed for widths which are % of something
295 returns the value of \textwidth in this inset. Most of the
296 time this is the width of the workarea, but if there is a
297 minipage somewhere, it will be the width of this minipage */
298 virtual int latexTextWidth(BufferView *) const;
300 /// mark the inset contents as erased (for change tracking)
301 virtual void markErased() {}
303 /** Adds a LaTeX snippet to the Preview Loader for transformation
304 * into a bitmap image. Does not start the laoding process.
306 * Most insets have no interest in this capability, so the method
309 virtual void addPreview(lyx::graphics::PreviewLoader &) const {}
314 mutable int top_baseline;
317 /// Used to identify the inset for cursor positioning when undoing
320 static unsigned int inset_id;
322 mutable Dimension dim_;
326 UpdatableInset * owner_;
329 /** We store the LColor::color value as an int to get LColor.h out
330 * of the header file.
332 int background_color_;
336 /** \c InsetOld_code is a wrapper for InsetOld::Code.
337 * It can be forward-declared and passed as a function argument without
338 * having to expose inset.h.
340 class InsetOld_code {
343 InsetOld_code(InsetOld::Code val) : val_(val) {}
344 operator InsetOld::Code() const{ return val_; }
349 * returns true if pointer argument is valid
350 * and points to an editable inset
352 bool isEditableInset(InsetOld const * i);
356 * returns true if pointer argument is valid
357 * and points to a highly editable inset
359 bool isHighlyEditableInset(InsetOld const * i);