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 "Dimension.h"
21 #include "support/docstream.h"
23 #include <boost/signal.hpp>
50 namespace graphics { class PreviewLoader; }
53 /// Common base class to all insets
55 // Do not add _any_ (non-static) data members as this would inflate
56 // everything storing large quantities of insets. Mathed e.g. would
59 class Inset : public boost::noncopyable {
62 typedef ptrdiff_t difference_type;
63 /// short of anything else reasonable
64 typedef size_t size_type;
65 /// type for cell indices
66 typedef size_t idx_type;
67 /// type for cursor positions
68 typedef ptrdiff_t pos_type;
69 /// type for row numbers
70 typedef size_t row_type;
71 /// type for column numbers
72 typedef size_t col_type;
74 /// virtual base class destructor
75 virtual ~Inset() { destroyed();}
76 /// replicate ourselves
77 std::auto_ptr<Inset> clone() const;
79 /// identification as math inset
80 virtual InsetMath * asInsetMath() { return 0; }
81 /// true for 'math' math inset, but not for e.g. mbox
82 virtual bool inMathed() const { return false; }
84 /// the real dispatcher
85 void dispatch(Cursor & cur, FuncRequest & cmd);
87 * \returns true if this function made a definitive decision on
88 * whether the inset wants to handle the request \p cmd or not.
89 * The result of this decision is put into \p status.
91 * Every request that is enabled in this method needs to be handled
92 * in doDispatch(). Normally we have a 1:1 relationship between the
93 * requests handled in getStatus() and doDispatch(), but there are
95 * - A request that is disabled in getStatus() does not need to
96 * appear in doDispatch(). It is guaranteed that doDispatch()
97 * is never called with this request.
98 * - A few requests are en- or disabled in Inset::getStatus().
99 * These need to be handled in the doDispatch() methods of the
100 * derived insets, since Inset::doDispatch() has not enough
101 * information to handle them.
102 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
103 * are dispatched directly
105 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
106 FuncStatus & status) const;
109 virtual void edit(Cursor & cur, bool left);
111 virtual Inset * editXY(Cursor & cur, int x, int y);
113 /// compute the size of the object returned in dim
114 /// \retval true if metrics changed.
115 virtual bool metrics(MetricsInfo & mi, Dimension & dim) const = 0;
116 /// draw inset and update (xo, yo)-cache
117 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
118 /// draw inset selection if necessary
119 virtual void drawSelection(PainterInfo &, int, int) const {}
121 virtual bool editing(BufferView * bv) const;
123 virtual bool showInsetDialog(BufferView *) const { return false; }
125 /// draw inset decoration if necessary.
126 /// This can use \c drawMarkers() for example.
127 virtual void drawDecoration(PainterInfo &, int, int) const {}
128 /// draw four angular markers
129 void drawMarkers(PainterInfo & pi, int x, int y) const;
130 /// draw two angular markers
131 void drawMarkers2(PainterInfo & pi, int x, int y) const;
132 /// add space for markers
133 void metricsMarkers(Dimension & dim, int framesize = 1) const;
134 /// add space for markers
135 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
136 /// last drawn position for 'important' insets
137 int xo(BufferView const & bv) const;
138 /// last drawn position for 'important' insets
139 int yo(BufferView const & bv) const;
140 /// set x/y drawing position cache if available
141 virtual void setPosCache(PainterInfo const &, int, int) const;
142 /// do we cover screen position x/y?
143 virtual bool covers(BufferView const & bv, int x, int y) const;
144 /// get the screen positions of the cursor (see note in Cursor.cpp)
145 virtual void cursorPos(BufferView const & bv,
146 CursorSlice const & sl, bool boundary, int & x, int & y) const;
148 /// is this an inset that can be moved into?
149 virtual bool isActive() const { return nargs() > 0; }
150 /// Where should we go when we press the up or down cursor key?
151 virtual bool idxUpDown(Cursor & cur, bool up) const;
152 /// Move one cell to the left
153 virtual bool idxLeft(Cursor &) const { return false; }
154 /// Move one cell to the right
155 virtual bool idxRight(Cursor &) const { return false; }
157 /// Move one physical cell up
158 virtual bool idxNext(Cursor &) const { return false; }
159 /// Move one physical cell down
160 virtual bool idxPrev(Cursor &) const { return false; }
162 /// Target pos when we enter the inset from the left by pressing "Right"
163 virtual bool idxFirst(Cursor &) const { return false; }
164 /// Target pos when we enter the inset from the right by pressing "Left"
165 virtual bool idxLast(Cursor &) const { return false; }
167 /// Delete a cell and move cursor
168 virtual bool idxDelete(idx_type &) { return false; }
169 /// pulls cell after pressing erase
170 virtual void idxGlue(idx_type) {}
171 /// returns list of cell indices that are "between" from and to for
172 /// selection purposes
173 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
175 /// to which column belongs a cell with a given index?
176 virtual col_type col(idx_type) const { return 0; }
177 /// to which row belongs a cell with a given index?
178 virtual row_type row(idx_type) const { return 0; }
179 /// cell idex corresponding to row and column;
180 virtual idx_type index(row_type row, col_type col) const;
181 /// any additional x-offset when drawing a cell?
182 virtual int cellXOffset(idx_type) const { return 0; }
183 /// any additional y-offset when drawing a cell?
184 virtual int cellYOffset(idx_type) const { return 0; }
185 /// number of embedded cells
186 virtual size_t nargs() const { return 0; }
187 /// number of rows in gridlike structures
188 virtual size_t nrows() const { return 0; }
189 /// number of columns in gridlike structures
190 virtual size_t ncols() const { return 0; }
191 /// is called when the cursor leaves this inset
192 // returns true if cursor is now invalid.
193 virtual bool notifyCursorLeaves(Cursor &) { return false; }
194 /// is called when the mouse enter or leave this inset
195 /// return true if this inset needs repaint
196 virtual bool setMouseHover(bool) { return false; }
198 /// request "external features"
199 virtual void validate(LaTeXFeatures &) const {}
200 /// Appends \c list with all labels found within this inset.
201 virtual void getLabelList(Buffer const &,
202 std::vector<docstring> & /* list */) const {}
204 /// describe content if cursor inside
205 virtual void infoize(odocstream &) const {}
206 /// describe content if cursor behind
207 virtual void infoize2(odocstream &) const {}
210 PLAINTEXT_NEWLINE = 10000
213 /// plain text output in ucs4 encoding
214 /// return the number of characters; in case of multiple lines of
215 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
216 virtual int plaintext(Buffer const &, odocstream &,
217 OutputParams const &) const = 0;
219 virtual int docbook(Buffer const &, odocstream & os,
220 OutputParams const &) const;
221 /// the string that is passed to the TOC
222 virtual void textString(Buffer const &, odocstream &) const {}
224 /** This enum indicates by which means the inset can be modified:
225 - NOT_EDITABLE: the inset's content cannot be modified at all
226 (e.g. printindex, insetspecialchar)
227 - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, url)
228 - HIGHLY_EDITABLE: content can be edited on screen (normally means that
229 insettext is contained, e.g. collapsables, tabular) */
230 // FIXME: This has not yet been fully implemented to math insets
239 /// what appears in the minibuffer when opening
240 virtual docstring const editMessage() const;
242 virtual EDITABLE editable() const;
243 /// can we go further down on mouse click?
244 virtual bool descendable() const { return false; }
245 /// does this contain text that can be change track marked in DVI?
246 virtual bool canTrackChanges() const { return false; }
247 /// is this inset based on the TextInset class?
248 virtual InsetText const * asTextInset() const { return 0; }
249 /// return true if the inset should be removed automatically
250 virtual bool autoDelete() const;
252 /** This is not quite the correct place for this enum. I think
253 the correct would be to let each subclass of Inset declare
254 its own enum code. Actually the notion of an Inset::Code
255 should be avoided, but I am not sure how this could be done
261 TOC_CODE, // do these insets really need a code? (ale)
321 MATHMACRO_CODE, // 30
358 /** returns the Code corresponding to the \c name.
359 * Eg, translate("branch") == BRANCH_CODE
361 static Code translate(std::string const & name);
363 /// returns true if the inset can hold an inset of given type
364 virtual bool insetAllowed(Code) const { return false; }
365 /// if this inset has paragraphs should they be output all as default
366 /// paragraphs with the default layout of the text class?
367 virtual bool forceDefaultParagraphs(idx_type) const { return false; }
368 /// Is the width forced to some value?
369 virtual bool hasFixedWidth() const { return false; }
372 virtual docstring name() const { return from_ascii("unknown"); }
373 /// used to toggle insets
374 /// is the inset open?
375 /// should this inset be handled like a normal charater
376 virtual bool isChar() const { return false; }
377 /// is this equivalent to a letter?
378 virtual bool isLetter() const { return false; }
379 /// is this equivalent to a space (which is BTW different from
380 /// a line separator)?
381 virtual bool isSpace() const { return false; }
390 /// should we have a non-filled line before this inset?
391 virtual DisplayType display() const { return Inline; }
392 /// should we break lines after this inset?
393 virtual bool isLineSeparator() const { return false; }
394 /// should paragraph indendation be ommitted in any case?
395 virtual bool neverIndent(Buffer const &) const { return false; }
396 /// dumps content to lyxerr
397 virtual void dump() const;
398 /// write inset in .lyx format
399 virtual void write(Buffer const &, std::ostream &) const {}
400 /// read inset in .lyx format
401 virtual void read(Buffer const &, Lexer &) {}
402 /** Export the inset to LaTeX.
403 * Don't use a temporary stringstream if the final output is
404 * supposed to go to a file.
405 * \sa Buffer::writeLaTeXSource for the reason.
406 * \return the number of rows (\n's) of generated LaTeX code.
408 virtual int latex(Buffer const &, odocstream &,
409 OutputParams const &) const { return 0; }
410 /// returns true to override begin and end inset in file
411 virtual bool directWrite() const;
413 virtual bool allowSpellCheck() const { return false; }
415 /// if this insets owns text cells (e.g. InsetText) return cell num
416 virtual Text * getText(int /*num*/) const { return 0; }
418 /** Adds a LaTeX snippet to the Preview Loader for transformation
419 * into a bitmap image. Does not start the laoding process.
421 * Most insets have no interest in this capability, so the method
424 virtual void addPreview(graphics::PreviewLoader &) const {}
425 /// Add an entry to the TocList
426 virtual void addToToc(TocList &, Buffer const &) const {}
429 /// returns LyX code associated with the inset. Used for TOC, ...)
430 virtual Code lyxCode() const { return NO_CODE; }
432 /// -1: text mode, 1: math mode, 0 undecided
433 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
434 /// return text or mathmode if that is possible to determine
435 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
436 /// returns whether this inset is allowed in other insets of given mode
437 virtual bool allowedIn(mode_type) const { return true; }
439 * Is this inset allowed within a font change?
441 * FIXME: noFontChange means currently that the font change is closed
442 * in LaTeX before the inset, and that the contents of the inset
443 * will be in default font. This should be changed so that the inset
444 * changes the font again.
446 virtual bool noFontChange() const { return false; }
448 /// set the change for the entire inset
449 virtual void setChange(Change const &) {}
450 /// accept the changes within the inset
451 virtual void acceptChanges(BufferParams const &) {};
452 /// reject the changes within the inset
453 virtual void rejectChanges(BufferParams const &) {};
456 int width() const { return dim_.wid; }
458 int ascent() const { return dim_.asc; }
460 int descent() const { return dim_.des; }
462 int scroll() const { return 0; }
464 void setBackgroundColor(Color_color);
466 Color_color backgroundColor() const;
468 enum CollapseStatus {
474 virtual void setStatus(Cursor &, CollapseStatus) {}
476 enum { TEXT_TO_INSET_OFFSET = 4 };
478 /// This signal is emitted when the inset is destroyed.
479 boost::signal<void()> destroyed;
483 Inset(Inset const & i);
485 Inset & operator=(Inset const &);
486 /** The real dispatcher.
487 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
488 * assumes the common case of 'LFUN handled, need update'.
489 * This has to be overriden by calling Cursor::undispatched() or
490 * Cursor::noUpdate() if appropriate.
491 * If you need to call the dispatch method of some inset directly
492 * you may have to explicitly request an update at that place. Don't
493 * do it in doDispatch(), since that causes nested updates when
494 * called from Cursor::dispatch(), and these can lead to crashes.
497 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);
499 /// Cached dimensions of the inset.
500 mutable Dimension dim_;
502 virtual std::auto_ptr<Inset> doClone() const = 0;
503 /** We store the Color::color value as an int to get Color.h out
504 * of the header file.
506 int background_color_;
511 * returns true if pointer argument is valid
512 * and points to an editable inset
514 bool isEditableInset(Inset const * inset);
518 * returns true if pointer argument is valid
519 * and points to a highly editable inset
521 bool isHighlyEditableInset(Inset const * inset);
523 /** \c Inset_code is a wrapper for Inset::Code.
524 * It can be forward-declared and passed as a function argument without
525 * having to expose Inset.h.
531 Inset_code(Inset::Code val) : val_(val) {}
532 operator Inset::Code() const { return val_; }