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
22 #include "insetbase.h"
23 #include "frontends/mouse_state.h"
24 #include "support/types.h"
43 class Inset : 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 Inset::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)
104 SPECIALCHAR_CODE, // 25
116 MATHMACRO_CODE, // 30
134 TEXT_TO_INSET_OFFSET = 2
148 typedef dispatch_result RESULT;
153 Inset(Inset const & in, bool same_id = false);
155 virtual int ascent(BufferView *, LyXFont const &) const = 0;
157 virtual int descent(BufferView *, LyXFont const &) const = 0;
159 virtual int width(BufferView *, LyXFont const &) const = 0;
161 virtual void draw(BufferView *, LyXFont const &,
162 int baseline, float & x, bool cleared) const = 0;
163 /// update the inset representation
164 virtual void update(BufferView *, LyXFont const &, bool = false)
166 /// what appears in the minibuffer when opening
167 virtual string const editMessage() const;
169 virtual void edit(BufferView *, int x, int y, mouse_button::state button);
171 virtual void edit(BufferView *, bool front = true);
173 virtual EDITABLE editable() const;
175 virtual bool isTextInset() const { return false; }
177 virtual bool doClearArea() const { return true; }
178 /// return true if the inset should be removed automatically
179 virtual bool autoDelete() const;
180 /// returns true the inset can hold an inset of given type
181 virtual bool insetAllowed(Inset::Code) const { return false; }
182 /// wrapper around the above
183 bool insetAllowed(Inset * in) const;
185 virtual void write(Buffer const *, std::ostream &) const = 0;
187 virtual void read(Buffer const *, LyXLex & lex) = 0;
188 /** returns the number of rows (\n's) of generated tex code.
189 fragile == true means, that the inset should take care about
190 fragile commands by adding a \protect before.
191 If the free_spc (freespacing) variable is set, then this inset
192 is in a free-spacing paragraph.
194 virtual int latex(Buffer const *, std::ostream &, bool fragile,
195 bool free_spc) const = 0;
197 virtual int ascii(Buffer const *,
198 std::ostream &, int linelen = 0) const = 0;
200 virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
202 virtual int docbook(Buffer const *, std::ostream &, bool) const = 0;
203 /// Updates needed features for this inset.
204 virtual void validate(LaTeXFeatures & features) const;
206 /// returns LyX code associated with the inset. Used for TOC, ...)
207 virtual Inset::Code lyxCode() const { return NO_CODE; }
209 virtual std::vector<string> const getLabelList() const {
210 return std::vector<string>();
214 virtual Inset * clone(Buffer const &, bool same_ids = false) const = 0;
216 /// returns true to override begin and end inset in file
217 virtual bool directWrite() const;
219 /// Returns true if the inset should be centered alone
220 virtual bool display() const { return false; }
221 /// Changes the display state of the inset
222 virtual void display(bool) {}
224 /// returns true if this inset needs a row on it's own
226 virtual bool needFullRow() const { return false; }
228 void setInsetName(string const & s) { name_ = s; }
230 string const & getInsetName() const { return name_; }
232 void setOwner(Inset * inset) { owner_ = inset; }
234 Inset * owner() const { return owner_; }
236 void parOwner(Paragraph * par) { par_owner_ = par; }
238 Paragraph * parOwner() const { return par_owner_; }
240 void setBackgroundColor(LColor::color);
242 LColor::color backgroundColor() const;
244 int x() const { return top_x; }
246 int y() const { return top_baseline; }
248 // because we could have fake text insets and have to call this
249 // inside them without cast!!!
251 virtual LyXText * getLyXText(BufferView const *,
252 bool const recursive = false) const;
254 virtual void deleteLyXText(BufferView *, bool = true) const {}
256 virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
257 /// returns the actuall scroll-value
258 virtual int scroll(bool recursive=true) const {
259 if (!recursive || !owner_)
264 /// try to get a inset pointer from it's id if we have
265 /// an inset to give back!
266 virtual Inset * getInsetFromID(int /*id*/) const { return 0; }
267 /// if this insets owns paragraphs (f.ex. InsetText) then it
268 /// should return it's very first one!
269 virtual Paragraph * firstParagraph() const { return 0; }
271 virtual Paragraph * getFirstParagraph(int /*num*/) const { return 0; }
273 /// return the cursor if we own one otherwise giv'em just the
274 /// BufferView cursor to work with.
275 virtual LyXCursor const & cursor(BufferView * bview) const;
281 /// used to toggle insets
282 // is the inset open?
283 virtual bool isOpen() const { return false; }
285 virtual void open(BufferView *) {}
287 virtual void close(BufferView *) const {}
288 /// check if the font of the char we want inserting is correct
289 /// and modify it if it is not.
290 virtual bool checkInsertChar(LyXFont &);
291 /// we need this here because collapsed insets are only EDITABLE
292 virtual void setFont(BufferView *, LyXFont const &,
293 bool toggleall = false, bool selectall = false);
295 // needed for spellchecking text
297 virtual bool allowSpellcheck() const { return false; }
299 // should this inset be handled like a normal charater
300 virtual bool isChar() const { return false; }
301 // is this equivalent to a letter?
302 virtual bool isLetter() const { return false; }
303 // is this equivalent to a space (which is BTW different from
304 // a line separator)?
305 virtual bool isSpace() const { return false; }
306 // should we break lines after this inset?
307 virtual bool isLineSeparator() const { return false; }
308 // if this inset has paragraphs should they be output all as default
309 // paragraphs with "Standard" layout?
310 virtual bool forceDefaultParagraphs(Inset const *) const;
311 /** returns true if, when outputing LaTeX, font changes should
312 be closed before generating this inset. This is needed for
313 insets that may contain several paragraphs */
314 virtual bool noFontChange() const { return false; }
316 virtual void getDrawFont(LyXFont &) const {}
317 /* needed for widths which are % of something
318 returns the value of \textwidth in this inset. Most of the
319 time this is the width of the workarea, but if there is a
320 minipage somewhere, it will be the width of this minipage */
321 virtual int latexTextWidth(BufferView *) const;
323 /// mark the inset contents as erased (for change tracking)
324 virtual void markErased() {}
326 /** Adds a LaTeX snippet to the Preview Loader for transformation
327 * into a bitmap image. Does not start the laoding process.
329 * Most insets have no interest in this capability, so the method
332 virtual void addPreview(grfx::PreviewLoader &) const {}
334 /** Find the PreviewLoader, add a LaTeX snippet to it and
335 * start the loading process.
337 * Most insets have no interest in this capability, so the method
340 virtual void generatePreview() const {}
346 mutable bool topx_set; /* have we already drawn ourself! */
348 mutable int top_baseline;
354 static unsigned int inset_id;
359 /// the paragraph in which this inset has been inserted
360 Paragraph * par_owner_;
364 LColor::color background_color_;
369 bool Inset::insetAllowed(Inset * in) const
371 return insetAllowed(in->lyxCode());
376 bool Inset::checkInsertChar(LyXFont &)
382 * returns true if pointer argument is valid
383 * and points to an editable inset
385 inline bool isEditableInset(Inset const * i)
387 return i && i->editable();
391 * returns true if pointer argument is valid
392 * and points to a highly editable inset
394 inline bool isHighlyEditableInset(Inset const * i)
396 return i && i->editable() == Inset::HIGHLY_EDITABLE;