4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
16 #include "dimension.h"
18 #include "support/docstream.h"
43 namespace graphics { class PreviewLoader; }
46 /// Common base class to all insets
48 // Do not add _any_ (non-static) data members as this would inflate
49 // everything storing large quantities of insets. Mathed e.g. would
55 typedef ptrdiff_t difference_type;
56 /// short of anything else reasonable
57 typedef size_t size_type;
58 /// type for cell indices
59 typedef size_t idx_type;
60 /// type for cursor positions
61 typedef ptrdiff_t pos_type;
62 /// type for row numbers
63 typedef size_t row_type;
64 /// type for column numbers
65 typedef size_t col_type;
67 /// virtual base class destructor
68 virtual ~InsetBase() {}
69 /// replicate ourselves
70 std::auto_ptr<InsetBase> clone() const;
72 /// identification as math inset
73 virtual InsetMath * asInsetMath() { return 0; }
74 /// true for 'math' math inset, but not for e.g. mbox
75 virtual bool inMathed() const { return false; }
77 /// the real dispatcher
78 void dispatch(LCursor & cur, FuncRequest & cmd);
80 * \returns true if this function made a definitive decision on
81 * whether the inset wants to handle the request \p cmd or not.
82 * The result of this decision is put into \p status.
84 * Every request that is enabled in this method needs to be handled
85 * in doDispatch(). Normally we have a 1:1 relationship between the
86 * requests handled in getStatus() and doDispatch(), but there are
88 * - A request that is disabled in getStatus() does not need to
89 * appear in doDispatch(). It is guaranteed that doDispatch()
90 * is never called with this request.
91 * - A few requests are en- or disabled in InsetBase::getStatus().
92 * These need to be handled in the doDispatch() methods of the
93 * derived insets, since InsetBase::doDispatch() has not enough
94 * information to handle them.
95 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
96 * are dispatched directly
98 virtual bool getStatus(LCursor & cur, FuncRequest const & cmd,
99 FuncStatus & status) const;
102 virtual void edit(LCursor & cur, bool left);
104 virtual InsetBase * editXY(LCursor & cur, int x, int y);
106 /// compute the size of the object returned in dim
107 /// \retval true if metrics changed.
108 virtual bool metrics(MetricsInfo & mi, Dimension & dim) const = 0;
109 /// draw inset and update (xo, yo)-cache
110 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
111 /// draw inset selection if necessary
112 virtual void drawSelection(PainterInfo &, int, int) const {}
114 virtual bool editing(BufferView * bv) const;
116 virtual bool showInsetDialog(BufferView *) const { return false; }
117 /// draw four angular markers
118 void drawMarkers(PainterInfo & pi, int x, int y) const;
119 /// draw two angular markers
120 void drawMarkers2(PainterInfo & pi, int x, int y) const;
121 /// add space for markers
122 void metricsMarkers(Dimension & dim, int framesize = 1) const;
123 /// add space for markers
124 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
125 /// last drawn position for 'important' insets
126 int xo(BufferView const & bv) const;
127 /// last drawn position for 'important' insets
128 int yo(BufferView const & bv) const;
129 /// set x/y drawing position cache if available
130 virtual void setPosCache(PainterInfo const &, int, int) const {}
131 /// do we cover screen position x/y?
132 virtual bool covers(BufferView const & bv, int x, int y) const;
133 /// get the screen positions of the cursor (see note in cursor.C)
134 virtual void cursorPos(BufferView const & bv,
135 CursorSlice const & sl, bool boundary, int & x, int & y) const;
137 /// is this an inset that can be moved into?
138 virtual bool isActive() const { return nargs() > 0; }
139 /// Where should we go when we press the up or down cursor key?
140 virtual bool idxUpDown(LCursor & cur, bool up) const;
141 /// Move one cell to the left
142 virtual bool idxLeft(LCursor &) const { return false; }
143 /// Move one cell to the right
144 virtual bool idxRight(LCursor &) const { return false; }
146 /// Move one physical cell up
147 virtual bool idxNext(LCursor &) const { return false; }
148 /// Move one physical cell down
149 virtual bool idxPrev(LCursor &) const { return false; }
151 /// Target pos when we enter the inset from the left by pressing "Right"
152 virtual bool idxFirst(LCursor &) const { return false; }
153 /// Target pos when we enter the inset from the right by pressing "Left"
154 virtual bool idxLast(LCursor &) const { return false; }
156 /// Delete a cell and move cursor
157 virtual bool idxDelete(idx_type &) { return false; }
158 /// pulls cell after pressing erase
159 virtual void idxGlue(idx_type) {}
160 /// returns list of cell indices that are "between" from and to for
161 /// selection purposes
162 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
164 /// to which column belongs a cell with a given index?
165 virtual col_type col(idx_type) const { return 0; }
166 /// to which row belongs a cell with a given index?
167 virtual row_type row(idx_type) const { return 0; }
168 /// cell idex corresponding to row and column;
169 virtual idx_type index(row_type row, col_type col) const;
170 /// any additional x-offset when drawing a cell?
171 virtual int cellXOffset(idx_type) const { return 0; }
172 /// any additional y-offset when drawing a cell?
173 virtual int cellYOffset(idx_type) const { return 0; }
174 /// number of embedded cells
175 virtual size_t nargs() const { return 0; }
176 /// number of rows in gridlike structures
177 virtual size_t nrows() const { return 0; }
178 /// number of columns in gridlike structures
179 virtual size_t ncols() const { return 0; }
180 /// is called when the cursor leaves this inset
181 // returns true if cursor is now invalid.
182 virtual bool notifyCursorLeaves(LCursor &) { return false; }
184 /// request "external features"
185 virtual void validate(LaTeXFeatures &) const {}
186 /// Appends \c list with all labels found within this inset.
187 virtual void getLabelList(Buffer const &,
188 std::vector<docstring> & /* list */) const {}
190 /// describe content if cursor inside
191 virtual void infoize(odocstream &) const {}
192 /// describe content if cursor behind
193 virtual void infoize2(odocstream &) const {}
195 /// plain text output in ucs4 encoding
196 virtual int plaintext(Buffer const &, odocstream &,
197 OutputParams const &) const;
199 virtual int docbook(Buffer const &, odocstream & os,
200 OutputParams const &) const;
201 /// the string that is passed to the TOC
202 virtual int textString(Buffer const &, odocstream &,
203 OutputParams const &) const { return 0; };
205 /** This enum indicates by which means the inset can be modified:
206 - NOT_EDITABLE: the inset's content cannot be modified at all
207 (e.g. printindex, insetspecialchar)
208 - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, url)
209 - HIGHLY_EDITABLE: content can be edited on screen (normally means that
210 insettext is contained, e.g. collapsables, tabular) */
211 // FIXME: This has not yet been fully implemented to math insets
220 /// what appears in the minibuffer when opening
221 virtual docstring const editMessage() const;
223 virtual EDITABLE editable() const;
224 /// can we go further down on mouse click?
225 virtual bool descendable() const { return false; }
226 /// does this contain text that can be change track marked in DVI?
227 virtual bool canTrackChanges() const { return false; }
228 /// is this inset based on the TextInset class?
229 virtual InsetText const * asTextInset() const { return 0; }
230 /// return true if the inset should be removed automatically
231 virtual bool autoDelete() const;
233 /** This is not quite the correct place for this enum. I think
234 the correct would be to let each subclass of Inset declare
235 its own enum code. Actually the notion of an InsetBase::Code
236 should be avoided, but I am not sure how this could be done
242 TOC_CODE, // do these insets really need a code? (ale)
302 MATHMACRO_CODE, // 30
335 /** returns the Code corresponding to the \c name.
336 * Eg, translate("branch") == BRANCH_CODE
338 static Code translate(std::string const & name);
340 /// returns true if the inset can hold an inset of given type
341 virtual bool insetAllowed(Code) const { return false; }
342 /// if this inset has paragraphs should they be output all as default
343 /// paragraphs with "Standard" layout?
344 virtual bool forceDefaultParagraphs(idx_type) const { return false; }
347 virtual docstring const & getInsetName() const;
348 /// used to toggle insets
349 /// is the inset open?
350 /// should this inset be handled like a normal charater
351 virtual bool isChar() const { return false; }
352 /// is this equivalent to a letter?
353 virtual bool isLetter() const { return false; }
354 /// is this equivalent to a space (which is BTW different from
355 /// a line separator)?
356 virtual bool isSpace() const { return false; }
357 /// should we have a non-filled line before this inset?
358 virtual bool display() const { return false; }
359 /// should we break lines after this inset?
360 virtual bool isLineSeparator() const { return false; }
361 /// should paragraph indendation be ommitted in any case?
362 virtual bool neverIndent(Buffer const &) const { return false; }
363 /// dumps content to lyxerr
364 virtual void dump() const;
365 /// write inset in .lyx format
366 virtual void write(Buffer const &, std::ostream &) const {}
367 /// read inset in .lyx format
368 virtual void read(Buffer const &, LyXLex &) {}
369 /// returns the number of rows (\n's) of generated tex code.
370 virtual int latex(Buffer const &, odocstream &,
371 OutputParams const &) const { return 0; }
372 /// returns true to override begin and end inset in file
373 virtual bool directWrite() const;
375 virtual bool allowSpellCheck() const { return false; }
377 /// if this insets owns text cells (e.g. InsetText) return cell num
378 virtual LyXText * getText(int /*num*/) const { return 0; }
380 /** Adds a LaTeX snippet to the Preview Loader for transformation
381 * into a bitmap image. Does not start the laoding process.
383 * Most insets have no interest in this capability, so the method
386 virtual void addPreview(graphics::PreviewLoader &) const {}
387 /// Add an antry to the TocList
388 virtual void addToToc(TocList &, Buffer const &) const {}
391 /// returns LyX code associated with the inset. Used for TOC, ...)
392 virtual Code lyxCode() const { return NO_CODE; }
394 /// -1: text mode, 1: math mode, 0 undecided
395 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
396 /// return text or mathmode if that is possible to determine
397 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
398 /// returns whether this inset is allowed in other insets of given mode
399 virtual bool allowedIn(mode_type) const { return true; }
401 * Is this inset allowed within a font change?
403 * FIXME: noFontChange means currently that the font change is closed
404 * in LaTeX before the inset, and that the contents of the inset
405 * will be in default font. This should be changed so that the inset
406 * changes the font again.
408 virtual bool noFontChange() const { return false; }
410 /// set the change for the entire inset
411 virtual void setChange(Change const &) {}
412 /// accept the changes within the inset
413 virtual void acceptChanges() {};
414 /// reject the changes within the inset
415 virtual void rejectChanges() {};
418 virtual int width() const { return 10; }
420 virtual int ascent() const { return 10; }
422 virtual int descent() const { return 10; }
424 int scroll() const { return 0; }
426 enum CollapseStatus {
432 virtual void setStatus(LCursor &, CollapseStatus) {}
435 InsetBase(InsetBase const &) {}
436 /** The real dispatcher.
437 * Gets normally called from LCursor::dispatch(). LCursor::dispatch()
438 * assumes the common case of 'LFUN handled, need update'.
439 * This has to be overriden by calling LCursor::undispatched() or
440 * LCursor::noUpdate() if appropriate.
441 * If you need to call the dispatch method of some inset directly
442 * you may have to explicitly request an update at that place. Don't
443 * do it in doDispatch(), since that causes nested updates when
444 * called from LCursor::dispatch(), and these can lead to crashes.
447 virtual void doDispatch(LCursor & cur, FuncRequest & cmd);
449 /// Cached dimensions of the inset.
450 mutable Dimension dim_;
452 virtual std::auto_ptr<InsetBase> doClone() const = 0;
457 * returns true if pointer argument is valid
458 * and points to an editable inset
460 bool isEditableInset(InsetBase const * inset);
464 * returns true if pointer argument is valid
465 * and points to a highly editable inset
467 bool isHighlyEditableInset(InsetBase const * inset);