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 "ColorCode.h"
19 #include "InsetCode.h"
21 #include "support/strfwd.h"
37 class InsetCollapsable;
49 class ParConstIterator;
57 namespace graphics { class PreviewLoader; }
60 /// Common base class to all insets
62 // Do not add _any_ (non-static) data members as this would inflate
63 // everything storing large quantities of insets. Mathed e.g. would
69 typedef ptrdiff_t difference_type;
70 /// short of anything else reasonable
71 typedef size_t size_type;
72 /// type for cell indices
73 typedef size_t idx_type;
74 /// type for cursor positions
75 typedef ptrdiff_t pos_type;
76 /// type for row numbers
77 typedef size_t row_type;
78 /// type for column numbers
79 typedef size_t col_type;
81 /// virtual base class destructor
84 /// identification as math inset
85 virtual InsetMath * asInsetMath() { return 0; }
86 /// true for 'math' math inset, but not for e.g. mbox
87 virtual bool inMathed() const { return false; }
88 /// is this inset based on the InsetText class?
89 virtual InsetText * asInsetText() { return 0; }
90 /// is this inset based on the InsetText class?
91 virtual InsetText const * asInsetText() const { return 0; }
92 /// is this inset based on the InsetCollapsable class?
93 virtual InsetCollapsable * asInsetCollapsable() { return 0; }
94 /// is this inset based on the InsetCollapsable class?
95 virtual InsetCollapsable const * asInsetCollapsable() const { return 0; }
97 /// the real dispatcher
98 void dispatch(Cursor & cur, FuncRequest & cmd);
100 * \returns true if this function made a definitive decision on
101 * whether the inset wants to handle the request \p cmd or not.
102 * The result of this decision is put into \p status.
104 * Every request that is enabled in this method needs to be handled
105 * in doDispatch(). Normally we have a 1:1 relationship between the
106 * requests handled in getStatus() and doDispatch(), but there are
108 * - A request that is disabled in getStatus() does not need to
109 * appear in doDispatch(). It is guaranteed that doDispatch()
110 * is never called with this request.
111 * - A few requests are en- or disabled in Inset::getStatus().
112 * These need to be handled in the doDispatch() methods of the
113 * derived insets, since Inset::doDispatch() has not enough
114 * information to handle them.
115 * - LFUN_MOUSE_* need not to be handled in getStatus(), because these
116 * are dispatched directly
118 virtual bool getStatus(Cursor & cur, FuncRequest const & cmd,
119 FuncStatus & status) const;
122 virtual void edit(Cursor & cur, bool left);
124 virtual Inset * editXY(Cursor & cur, int x, int y);
126 /// compute the size of the object returned in dim
127 /// \retval true if metrics changed.
128 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
129 /// draw inset and update (xo, yo)-cache
130 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
131 /// draw inset selection if necessary
132 virtual void drawSelection(PainterInfo &, int, int) const {}
134 virtual bool editing(BufferView * bv) const;
136 virtual bool showInsetDialog(BufferView *) const { return false; }
138 /// draw inset decoration if necessary.
139 /// This can use \c drawMarkers() for example.
140 virtual void drawDecoration(PainterInfo &, int, int) const {}
141 /// draw four angular markers
142 void drawMarkers(PainterInfo & pi, int x, int y) const;
143 /// draw two angular markers
144 void drawMarkers2(PainterInfo & pi, int x, int y) const;
145 /// add space for markers
146 void metricsMarkers(Dimension & dim, int framesize = 1) const;
147 /// add space for markers
148 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
149 /// last drawn position for 'important' insets
150 int xo(BufferView const & bv) const;
151 /// last drawn position for 'important' insets
152 int yo(BufferView const & bv) const;
153 /// set x/y drawing position cache if available
154 virtual void setPosCache(PainterInfo const &, int, int) const;
156 void setDimCache(MetricsInfo const &, Dimension const &) const;
157 /// do we cover screen position x/y?
158 virtual bool covers(BufferView const & bv, int x, int y) const;
159 /// get the screen positions of the cursor (see note in Cursor.cpp)
160 virtual void cursorPos(BufferView const & bv,
161 CursorSlice const & sl, bool boundary, int & x, int & y) const;
164 virtual bool isFreeSpacing() const { return false; }
166 virtual bool allowEmpty() const { return false; }
167 /// Force inset into LTR environment if surroundings are RTL?
168 virtual bool forceLTR() const { return false; }
170 /// is this an inset that can be moved into?
171 /// FIXME: merge with editable()
172 virtual bool isActive() const { return nargs() > 0; }
173 /// Where should we go when we press the up or down cursor key?
174 virtual bool idxUpDown(Cursor & cur, bool up) const;
175 /// Move one cell backwards
176 virtual bool idxBackward(Cursor &) const { return false; }
177 /// Move one cell forward
178 virtual bool idxForward(Cursor &) const { return false; }
180 /// Move to the next cell
181 virtual bool idxNext(Cursor &) const { return false; }
182 /// Move to the previous cell
183 virtual bool idxPrev(Cursor &) const { return false; }
185 /// Target pos when we enter the inset while moving forward
186 virtual bool idxFirst(Cursor &) const { return false; }
187 /// Target pos when we enter the inset while moving backwards
188 virtual bool idxLast(Cursor &) const { return false; }
190 /// Delete a cell and move cursor
191 virtual bool idxDelete(idx_type &) { return false; }
192 /// pulls cell after pressing erase
193 virtual void idxGlue(idx_type) {}
194 /// returns list of cell indices that are "between" from and to for
195 /// selection purposes
196 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
198 /// to which column belongs a cell with a given index?
199 virtual col_type col(idx_type) const { return 0; }
200 /// to which row belongs a cell with a given index?
201 virtual row_type row(idx_type) const { return 0; }
202 /// cell idex corresponding to row and column;
203 virtual idx_type index(row_type row, col_type col) const;
204 /// any additional x-offset when drawing a cell?
205 virtual int cellXOffset(idx_type) const { return 0; }
206 /// any additional y-offset when drawing a cell?
207 virtual int cellYOffset(idx_type) const { return 0; }
208 /// number of embedded cells
209 virtual size_t nargs() const { return 0; }
210 /// number of rows in gridlike structures
211 virtual size_t nrows() const { return 0; }
212 /// number of columns in gridlike structures
213 virtual size_t ncols() const { return 0; }
214 /// is called when the cursor leaves this inset
215 // returns true if cursor is now invalid.
216 virtual bool notifyCursorLeaves(Cursor &) { return false; }
217 /// is called when the mouse enter or leave this inset
218 /// return true if this inset needs repaint
219 virtual bool setMouseHover(bool) { return false; }
220 /// return true if this inset is hovered (under mouse)
221 /// This is by now only used by mathed to draw corners
222 /// (Inset::drawMarkers() and Inset::drawMarkers2()).
223 /// Other insets do not have to redefine this function to
224 /// return the correct status of mouseHovered.
225 virtual bool mouseHovered() const { return false; }
227 /// request "external features"
228 virtual void validate(LaTeXFeatures &) const {}
229 /// Appends \c list with all labels found within this inset.
230 virtual void getLabelList(Buffer const &,
231 std::vector<docstring> & /* list */) const {}
233 /// describe content if cursor inside
234 virtual void infoize(odocstream &) const {}
235 /// describe content if cursor behind
236 virtual void infoize2(odocstream &) const {}
239 PLAINTEXT_NEWLINE = 10000
242 /// plain text output in ucs4 encoding
243 /// return the number of characters; in case of multiple lines of
244 /// output, add PLAINTEXT_NEWLINE to the number of chars in the last line
245 virtual int plaintext(Buffer const &, odocstream &,
246 OutputParams const &) const = 0;
248 virtual int docbook(Buffer const &, odocstream & os,
249 OutputParams const &) const;
250 /// the string that is passed to the TOC
251 virtual void textString(Buffer const &, odocstream &) const {}
253 /** This enum indicates by which means the inset can be modified:
254 - NOT_EDITABLE: the inset's content cannot be modified at all
255 (e.g. printindex, insetspecialchar)
256 - IS_EDITABLE: content can be edited via dialog (e.g. bibtex, index, href)
257 - HIGHLY_EDITABLE: content can be edited on screen (normally means that
258 insettext is contained, e.g. collapsables, tabular) */
259 // FIXME: This has not yet been fully implemented to math insets
268 /// what appears in the minibuffer when opening
269 virtual docstring const editMessage() const;
271 virtual EDITABLE editable() const;
272 /// can we go further down on mouse click?
273 virtual bool descendable() const { return false; }
274 /// does this contain text that can be change track marked in DVI?
275 virtual bool canTrackChanges() const { return false; }
276 /// return true if the inset should be removed automatically
277 virtual bool autoDelete() const;
279 /// returns true if the inset can hold an inset of given type
280 virtual bool insetAllowed(InsetCode) const { return false; }
281 /// if this inset has paragraphs should they be output all as default
282 /// paragraphs with the default layout of the text class?
283 virtual bool forceDefaultParagraphs(idx_type) const { return false; }
284 /// Is the width forced to some value?
285 virtual bool hasFixedWidth() const { return false; }
288 virtual docstring name() const;
290 virtual InsetLayout const & getLayout(BufferParams const & bp) const;
291 /// used to toggle insets
292 /// is the inset open?
293 /// should this inset be handled like a normal charater
294 virtual bool isChar() const { return false; }
295 /// is this equivalent to a letter?
296 virtual bool isLetter() const { return false; }
297 /// is this equivalent to a space (which is BTW different from
298 /// a line separator)?
299 virtual bool isSpace() const { return false; }
308 /// should we have a non-filled line before this inset?
309 virtual DisplayType display() const { return Inline; }
310 /// should we break lines after this inset?
311 virtual bool isLineSeparator() const { return false; }
312 /// should paragraph indendation be ommitted in any case?
313 virtual bool neverIndent(Buffer const &) const { return false; }
314 /// dumps content to lyxerr
315 virtual void dump() const;
316 /// write inset in .lyx format
317 virtual void write(Buffer const &, std::ostream &) const {}
318 /// read inset in .lyx format
319 virtual void read(Buffer const &, Lexer &) {}
320 /** Export the inset to LaTeX.
321 * Don't use a temporary stringstream if the final output is
322 * supposed to go to a file.
323 * \sa Buffer::writeLaTeXSource for the reason.
324 * \return the number of rows (\n's) of generated LaTeX code.
326 virtual int latex(Buffer const &, odocstream &,
327 OutputParams const &) const { return 0; }
328 /// returns true to override begin and end inset in file
329 virtual bool directWrite() const;
331 virtual bool allowSpellCheck() const { return false; }
333 /// if this insets owns text cells (e.g. InsetText) return cell num
334 virtual Text * getText(int /*num*/) const { return 0; }
336 /** Adds a LaTeX snippet to the Preview Loader for transformation
337 * into a bitmap image. Does not start the laoding process.
339 * Most insets have no interest in this capability, so the method
342 virtual void addPreview(graphics::PreviewLoader &) const {}
343 /// Add an entry to the TocList
344 /// pit is the ParConstIterator of the paragraph containing the inset
345 virtual void addToToc(TocList &, Buffer const &, ParConstIterator const &) const {}
346 /// report files that can be embedded with the lyx file
347 virtual void registerEmbeddedFiles(Buffer const &, EmbeddedFiles &) const {}
348 /// use embedded or external file after the embedding status of a file is changed
349 virtual void updateEmbeddedFile(Buffer const &, EmbeddedFile const &) {}
350 /// Fill keys with BibTeX information
351 virtual void fillWithBibKeys(Buffer const &,
352 BiblioInfo &, InsetIterator const &) const {}
353 /// Update the counters of this inset and of its contents
354 virtual void updateLabels(Buffer const &, ParIterator const &) {}
356 /// Updates the inset's dialog
357 virtual Buffer const * updateFrontend() const;
360 /// returns LyX code associated with the inset. Used for TOC, ...)
361 virtual InsetCode lyxCode() const { return NO_CODE; }
363 /// -1: text mode, 1: math mode, 0 undecided
364 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
365 /// return text or mathmode if that is possible to determine
366 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
367 /// returns whether this inset is allowed in other insets of given mode
368 virtual bool allowedIn(mode_type) const { return true; }
370 * Is this inset allowed within a font change?
372 * FIXME: noFontChange means currently that the font change is closed
373 * in LaTeX before the inset, and that the contents of the inset
374 * will be in default font. This should be changed so that the inset
375 * changes the font again.
377 virtual bool noFontChange() const { return false; }
379 /// set the change for the entire inset
380 virtual void setChange(Change const &) {}
381 /// accept the changes within the inset
382 virtual void acceptChanges(BufferParams const &) {};
383 /// reject the changes within the inset
384 virtual void rejectChanges(BufferParams const &) {};
387 virtual Dimension const dimension(BufferView const &) const;
389 int scroll() const { return 0; }
391 virtual ColorCode backgroundColor() const;
393 enum CollapseStatus {
398 virtual void setStatus(Cursor &, CollapseStatus) {}
400 enum { TEXT_TO_INSET_OFFSET = 4 };
405 /// replicate ourselves
406 friend class InsetList;
407 friend class MathAtom;
408 virtual Inset * clone() const = 0;
410 /** The real dispatcher.
411 * Gets normally called from Cursor::dispatch(). Cursor::dispatch()
412 * assumes the common case of 'LFUN handled, need update'.
413 * This has to be overriden by calling Cursor::undispatched() or
414 * Cursor::noUpdate() if appropriate.
415 * If you need to call the dispatch method of some inset directly
416 * you may have to explicitly request an update at that place. Don't
417 * do it in doDispatch(), since that causes nested updates when
418 * called from Cursor::dispatch(), and these can lead to crashes.
421 virtual void doDispatch(Cursor & cur, FuncRequest & cmd);