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 "Dimension.h"
20 #include "support/docstream.h"
48 class ParConstIterator;
56 namespace graphics { class PreviewLoader; }
59 /// Common base class to all insets
61 // Do not add _any_ (non-static) data members as this would inflate
62 // everything storing large quantities of insets. Mathed e.g. would
68 typedef ptrdiff_t difference_type;
69 /// short of anything else reasonable
70 typedef size_t size_type;
71 /// type for cell indices
72 typedef size_t idx_type;
73 /// type for cursor positions
74 typedef ptrdiff_t pos_type;
75 /// type for row numbers
76 typedef size_t row_type;
77 /// type for column numbers
78 typedef size_t col_type;
80 /// virtual base class destructor
83 /// identification as math inset
84 virtual InsetMath * asInsetMath() { return 0; }
85 /// true for 'math' math inset, but not for e.g. mbox
86 virtual bool inMathed() const { return false; }
87 /// is this inset based on the TextInset class?
88 virtual InsetText * asTextInset() { return 0; }
89 /// is this inset based on the TextInset class?
90 virtual InsetText const * asTextInset() const { return 0; }
92 /// the real dispatcher
93 void dispatch(Cursor & cur, FuncRequest & cmd);
95 * \returns true if this function made a definitive decision on
96 * whether the inset wants to handle the request \p cmd or not.
97 * The result of this decision is put into \p status.
99 * Every request that is enabled in this method needs to be handled
100 * in doDispatch(). Normally we have a 1:1 relationship between the
101 * requests handled in getStatus() and doDispatch(), but there are
103 * - A request that is disabled in getStatus() does not need to
104 * appear in doDispatch(). It is guaranteed that doDispatch()
105 * is never called with this request.
106 * - A few requests are en- or disabled in Inset::getStatus().
107 * These need to be handled in the doDispatch() methods of the
108 * derived insets, since Inset::doDispatch() has not enough
109 * information to handle them.
110 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
111 * are dispatched directly
113 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
114 FuncStatus & status) const;
117 virtual void edit(Cursor & cur, bool left);
119 virtual Inset * editXY(Cursor & cur, int x, int y);
121 /// compute the size of the object returned in dim
122 /// \retval true if metrics changed.
123 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
124 /// draw inset and update (xo, yo)-cache
125 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
126 /// draw inset selection if necessary
127 virtual void drawSelection(PainterInfo &, int, int) const {}
129 virtual bool editing(BufferView * bv) const;
131 virtual bool showInsetDialog(BufferView *) const { return false; }
133 /// draw inset decoration if necessary.
134 /// This can use \c drawMarkers() for example.
135 virtual void drawDecoration(PainterInfo &, int, int) const {}
136 /// draw four angular markers
137 void drawMarkers(PainterInfo & pi, int x, int y) const;
138 /// draw two angular markers
139 void drawMarkers2(PainterInfo & pi, int x, int y) const;
140 /// add space for markers
141 void metricsMarkers(Dimension & dim, int framesize = 1) const;
142 /// add space for markers
143 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
144 /// last drawn position for 'important' insets
145 int xo(BufferView const & bv) const;
146 /// last drawn position for 'important' insets
147 int yo(BufferView const & bv) const;
148 /// set x/y drawing position cache if available
149 virtual void setPosCache(PainterInfo const &, int, int) const;
151 void setDimCache(MetricsInfo const &, Dimension const &) const;
152 /// do we cover screen position x/y?
153 virtual bool covers(BufferView const & bv, int x, int y) const;
154 /// get the screen positions of the cursor (see note in Cursor.cpp)
155 virtual void cursorPos(BufferView const & bv,
156 CursorSlice const & sl, bool boundary, int & x, int & y) const;
158 /// is this an inset that can be moved into?
159 /// FIXME: merge with editable()
160 virtual bool isActive() const { return nargs() > 0; }
161 /// Where should we go when we press the up or down cursor key?
162 virtual bool idxUpDown(Cursor & cur, bool up) const;
163 /// Move one cell to the left
164 virtual bool idxLeft(Cursor &) const { return false; }
165 /// Move one cell to the right
166 virtual bool idxRight(Cursor &) const { return false; }
168 /// Move one physical cell up
169 virtual bool idxNext(Cursor &) const { return false; }
170 /// Move one physical cell down
171 virtual bool idxPrev(Cursor &) const { return false; }
173 /// Target pos when we enter the inset from the left by pressing "Right"
174 virtual bool idxFirst(Cursor &) const { return false; }
175 /// Target pos when we enter the inset from the right by pressing "Left"
176 virtual bool idxLast(Cursor &) const { return false; }
178 /// Delete a cell and move cursor
179 virtual bool idxDelete(idx_type &) { return false; }
180 /// pulls cell after pressing erase
181 virtual void idxGlue(idx_type) {}
182 /// returns list of cell indices that are "between" from and to for
183 /// selection purposes
184 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
186 /// to which column belongs a cell with a given index?
187 virtual col_type col(idx_type) const { return 0; }
188 /// to which row belongs a cell with a given index?
189 virtual row_type row(idx_type) const { return 0; }
190 /// cell idex corresponding to row and column;
191 virtual idx_type index(row_type row, col_type col) const;
192 /// any additional x-offset when drawing a cell?
193 virtual int cellXOffset(idx_type) const { return 0; }
194 /// any additional y-offset when drawing a cell?
195 virtual int cellYOffset(idx_type) const { return 0; }
196 /// number of embedded cells
197 virtual size_t nargs() const { return 0; }
198 /// number of rows in gridlike structures
199 virtual size_t nrows() const { return 0; }
200 /// number of columns in gridlike structures
201 virtual size_t ncols() const { return 0; }
202 /// is called when the cursor leaves this inset
203 // returns true if cursor is now invalid.
204 virtual bool notifyCursorLeaves(Cursor &) { return false; }
205 /// is called when the mouse enter or leave this inset
206 /// return true if this inset needs repaint
207 virtual bool setMouseHover(bool) { return false; }
208 /// return true if this inset is hovered (under mouse)
209 /// This is by now only used by mathed to draw corners
210 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
211 /// Other insets do not have to redefine this function to
212 /// return the correct status of mouseHovered.
213 virtual bool mouseHovered() const { return false; }
215 /// request "external features"
216 virtual void validate(LaTeXFeatures &) const {}
217 /// Appends \c list with all labels found within this inset.
218 virtual void getLabelList(Buffer const &,
219 std::vector<docstring> & /* list */) const {}
221 /// describe content if cursor inside
222 virtual void infoize(odocstream &) const {}
223 /// describe content if cursor behind
224 virtual void infoize2(odocstream &) const {}
227 PLAINTEXT_NEWLINE = 10000
230 /// plain text output in ucs4 encoding
231 /// return the number of characters; in case of multiple lines of
232 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
233 virtual int plaintext(Buffer const &, odocstream &,
234 OutputParams const &) const = 0;
236 virtual int docbook(Buffer const &, odocstream & os,
237 OutputParams const &) const;
238 /// the string that is passed to the TOC
239 virtual void textString(Buffer const &, odocstream &) const {}
241 /** This enum indicates by which means the inset can be modified:
242 - NOT_EDITABLE: the inset's content cannot be modified at all
243 (e.g. printindex, insetspecialchar)
244 - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, url)
245 - HIGHLY_EDITABLE: content can be edited on screen (normally means that
246 insettext is contained, e.g. collapsables, tabular) */
247 // FIXME: This has not yet been fully implemented to math insets
256 /// what appears in the minibuffer when opening
257 virtual docstring const editMessage() const;
259 virtual EDITABLE editable() const;
260 /// can we go further down on mouse click?
261 virtual bool descendable() const { return false; }
262 /// does this contain text that can be change track marked in DVI?
263 virtual bool canTrackChanges() const { return false; }
264 /// return true if the inset should be removed automatically
265 virtual bool autoDelete() const;
267 /** This is not quite the correct place for this enum. I think
268 the correct would be to let each subclass of Inset declare
269 its own enum code. Actually the notion of an Inset::Code
270 should be avoided, but I am not sure how this could be done
276 TOC_CODE, // do these insets really need a code? (ale)
336 MATHMACRO_CODE, // 30
373 /** returns the Code corresponding to the \c name.
374 * Eg, translate("branch") == BRANCH_CODE
376 static Code translate(std::string const & name);
378 /// returns true if the inset can hold an inset of given type
379 virtual bool insetAllowed(Code) const { return false; }
380 /// if this inset has paragraphs should they be output all as default
381 /// paragraphs with the default layout of the text class?
382 virtual bool forceDefaultParagraphs(idx_type) const { return false; }
383 /// Is the width forced to some value?
384 virtual bool hasFixedWidth() const { return false; }
387 virtual docstring name() const { return from_ascii("unknown"); }
389 virtual InsetLayout const & getLayout(BufferParams const & bp) const;
390 /// used to toggle insets
391 /// is the inset open?
392 /// should this inset be handled like a normal charater
393 virtual bool isChar() const { return false; }
394 /// is this equivalent to a letter?
395 virtual bool isLetter() const { return false; }
396 /// is this equivalent to a space (which is BTW different from
397 /// a line separator)?
398 virtual bool isSpace() const { return false; }
407 /// should we have a non-filled line before this inset?
408 virtual DisplayType display() const { return Inline; }
409 /// should we break lines after this inset?
410 virtual bool isLineSeparator() const { return false; }
411 /// should paragraph indendation be ommitted in any case?
412 virtual bool neverIndent(Buffer const &) const { return false; }
413 /// dumps content to lyxerr
414 virtual void dump() const;
415 /// write inset in .lyx format
416 virtual void write(Buffer const &, std::ostream &) const {}
417 /// read inset in .lyx format
418 virtual void read(Buffer const &, Lexer &) {}
419 /** Export the inset to LaTeX.
420 * Don't use a temporary stringstream if the final output is
421 * supposed to go to a file.
422 * \sa Buffer::writeLaTeXSource for the reason.
423 * \return the number of rows (\n's) of generated LaTeX code.
425 virtual int latex(Buffer const &, odocstream &,
426 OutputParams const &) const { return 0; }
427 /// returns true to override begin and end inset in file
428 virtual bool directWrite() const;
430 virtual bool allowSpellCheck() const { return false; }
432 /// if this insets owns text cells (e.g. InsetText) return cell num
433 virtual Text * getText(int /*num*/) const { return 0; }
435 /** Adds a LaTeX snippet to the Preview Loader for transformation
436 * into a bitmap image. Does not start the laoding process.
438 * Most insets have no interest in this capability, so the method
441 virtual void addPreview(graphics::PreviewLoader &) const {}
442 /// Add an entry to the TocList
443 /// pit is the ParConstIterator of the paragraph containing the inset
444 virtual void addToToc(TocList &, Buffer const &, ParConstIterator const &) const {}
445 /// report files that can be embedded with the lyx file
446 virtual void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &) const {};
447 /// use embedded or external file after the embedding status of a file is changed
448 virtual void updateEmbeddedFile(Buffer const &, EmbeddedFile const &) {}
449 /// Fill keys with BibTeX information
450 virtual void fillWithBibKeys(Buffer const &,
451 BiblioInfo &, InsetIterator const &) const { return; }
452 /// Update the counters of this inset and of its contents
453 virtual void updateLabels(Buffer const &, ParIterator const &) {}
457 /// returns LyX code associated with the inset. Used for TOC, ...)
458 virtual Code lyxCode() const { return NO_CODE; }
460 /// -1: text mode, 1: math mode, 0 undecided
461 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
462 /// return text or mathmode if that is possible to determine
463 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
464 /// returns whether this inset is allowed in other insets of given mode
465 virtual bool allowedIn(mode_type) const { return true; }
467 * Is this inset allowed within a font change?
469 * FIXME: noFontChange means currently that the font change is closed
470 * in LaTeX before the inset, and that the contents of the inset
471 * will be in default font. This should be changed so that the inset
472 * changes the font again.
474 virtual bool noFontChange() const { return false; }
476 /// set the change for the entire inset
477 virtual void setChange(Change const &) {}
478 /// accept the changes within the inset
479 virtual void acceptChanges(BufferParams const &) {};
480 /// reject the changes within the inset
481 virtual void rejectChanges(BufferParams const &) {};
484 virtual Dimension const dimension(BufferView const &) const;
486 int scroll() const { return 0; }
488 virtual Color_color backgroundColor() const;
490 enum CollapseStatus {
495 virtual void setStatus(Cursor &, CollapseStatus) {}
497 enum { TEXT_TO_INSET_OFFSET = 4 };
502 /// replicate ourselves
503 friend class Paragraph;
504 friend class MathAtom;
505 virtual Inset * clone() const = 0;
507 /** The real dispatcher.
508 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
509 * assumes the common case of 'LFUN handled, need update'.
510 * This has to be overriden by calling Cursor::undispatched() or
511 * Cursor::noUpdate() if appropriate.
512 * If you need to call the dispatch method of some inset directly
513 * you may have to explicitly request an update at that place. Don't
514 * do it in doDispatch(), since that causes nested updates when
515 * called from Cursor::dispatch(), and these can lead to crashes.
518 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
523 * returns true if pointer argument is valid
524 * and points to an editable inset
526 bool isEditableInset(Inset const * inset);
530 * returns true if pointer argument is valid
531 * and points to a highly editable inset
533 bool isHighlyEditableInset(Inset const * inset);
535 /** \c Inset_code is a wrapper for Inset::Code.
536 * It can be forward-declared and passed as a function argument without
537 * having to expose Inset.h.
542 Inset_code(Inset::Code val) : val_(val) {}
543 operator Inset::Code() const { return val_; }