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