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.
36 namespace lyx { namespace graphics { class PreviewLoader; } }
40 /// Common base class to all insets
42 // Do not add _any_ (non-static) data members as this would inflate
43 // everything storing large quantities of insets. Mathed e.g. would
49 typedef ptrdiff_t difference_type;
50 /// short of anything else reasonable
51 typedef size_t size_type;
52 /// type for cell indices
53 typedef size_t idx_type;
54 /// type for cursor positions
55 typedef ptrdiff_t pos_type;
56 /// type for row numbers
57 typedef size_t row_type;
58 /// type for column numbers
59 typedef size_t col_type;
61 /// virtual base class destructor
62 virtual ~InsetBase() {}
63 /// replicate ourselves
64 virtual std::auto_ptr<InsetBase> clone() const = 0;
66 /// identification as math inset
67 virtual MathInset * asMathInset() { return 0; }
68 /// identification as non-math inset
69 virtual UpdatableInset * asUpdatableInset() { return 0; }
70 /// true for 'math' math inset, but not for e.g. mbox
71 virtual bool inMathed() const { return false; }
73 // the real dispatcher
74 void dispatch(LCursor & cur, FuncRequest & cmd);
75 /// do we want to handle this event?
76 virtual bool getStatus(LCursor & cur, FuncRequest const & cmd,
77 FuncStatus & status) const;
80 virtual void edit(LCursor & cur, bool left);
82 virtual InsetBase * editXY(LCursor & cur, int x, int y) const;
84 /// compute the size of the object returned in dim
85 virtual void metrics(MetricsInfo & mi, Dimension & dim) const = 0;
86 /// draw inset and update (xo, yo)-cache
87 virtual void draw(PainterInfo & pi, int x, int y) const = 0;
88 /// draw inset selection if necessary
89 virtual void drawSelection(PainterInfo &, int, int) const {}
91 virtual bool editing(BufferView * bv) const;
92 /// draw four angular markers
93 void drawMarkers(PainterInfo & pi, int x, int y) const;
94 /// draw two angular markers
95 void drawMarkers2(PainterInfo & pi, int x, int y) const;
96 /// add space for markers
97 void metricsMarkers(Dimension & dim, int framesize = 1) const;
98 /// add space for markers
99 void metricsMarkers2(Dimension & dim, int framesize = 1) const;
100 /// last drawn position for 'important' insets
102 /// last drawn position for 'important' insets
104 /// set x/y drawing position cache if available
105 virtual void setPosCache(PainterInfo const &, int, int) const {}
106 /// do we cover screen position x/y?
107 virtual bool covers(int x, int y) const;
108 /// get the screen positions of the cursor (see note in cursor.C)
109 virtual void getCursorPos(LCursor const & cur, int & x, int & y) const;
111 /// is this an inset that can be moved into?
112 virtual bool isActive() const { return nargs() > 0; }
113 /// Where should we go when we press the up or down cursor key?
114 virtual bool idxUpDown(LCursor & cur, bool up) const;
115 /// Where should we go when we press the up or down cursor key?
116 virtual bool idxUpDown2(LCursor & cur, bool up) const;
117 /// Move one cell to the left
118 virtual bool idxLeft(LCursor &) const { return false; }
119 /// Move one cell to the right
120 virtual bool idxRight(LCursor &) const { return false; }
122 /// Move one physical cell up
123 virtual bool idxNext(LCursor &) const { return false; }
124 /// Move one physical cell down
125 virtual bool idxPrev(LCursor &) const { return false; }
127 /// Target pos when we enter the inset from the left by pressing "Right"
128 virtual bool idxFirst(LCursor &) const { return false; }
129 /// Target pos when we enter the inset from the right by pressing "Left"
130 virtual bool idxLast(LCursor &) const { return false; }
132 /// Delete a cell and move cursor
133 virtual bool idxDelete(idx_type &) { return false; }
134 /// pulls cell after pressing erase
135 virtual void idxGlue(idx_type) {}
136 // returns list of cell indices that are "between" from and to for
137 // selection purposes
138 virtual bool idxBetween(idx_type idx, idx_type from, idx_type to) const;
140 /// to which column belongs a cell with a given index?
141 virtual col_type col(idx_type) const { return 0; }
142 /// to which row belongs a cell with a given index?
143 virtual row_type row(idx_type) const { return 0; }
144 /// cell idex corresponding to row and column;
145 virtual idx_type index(row_type row, col_type col) const;
146 /// any additional x-offset when drawing a cell?
147 virtual int cellXOffset(idx_type) const { return 0; }
148 /// any additional y-offset when drawing a cell?
149 virtual int cellYOffset(idx_type) const { return 0; }
150 /// number of embedded cells
151 virtual size_t nargs() const { return 0; }
152 /// number of rows in gridlike structures
153 virtual size_t nrows() const { return 0; }
154 /// number of columns in gridlike structures
155 virtual size_t ncols() const { return 0; }
156 /// is called when the cursor leaves this inset
157 virtual void notifyCursorLeaves(LCursor &) {}
159 /// request "external features"
160 virtual void validate(LaTeXFeatures &) const {}
161 /// Appends \c list with all labels found within this inset.
162 virtual void getLabelList(Buffer const &,
163 std::vector<std::string> & /* list */) const {}
165 /// describe content if cursor inside
166 virtual void infoize(std::ostream &) const {}
167 /// describe content if cursor behind
168 virtual void infoize2(std::ostream &) const {}
170 /// plain ascii output
171 virtual int plaintext(Buffer const &, std::ostream & os,
172 OutputParams const &) const;
174 virtual int linuxdoc(Buffer const &, std::ostream & os,
175 OutputParams const &) const;
177 virtual int docbook(Buffer const &, std::ostream & os,
178 OutputParams const &) const;
189 /// what appears in the minibuffer when opening
190 virtual std::string const editMessage() const;
192 virtual EDITABLE editable() const;
193 /// can we go further down on mouse click?
194 virtual bool descendable() const { return false; }
196 virtual bool isTextInset() const { return false; }
197 /// return true if the inset should be removed automatically
198 virtual bool autoDelete() const;
200 /** This is not quite the correct place for this enum. I think
201 the correct would be to let each subclass of Inset declare
202 its own enum code. Actually the notion of an InsetOld::Code
203 should be avoided, but I am not sure how this could be done
209 TOC_CODE, // do these insets really need a code? (ale)
269 MATHMACRO_CODE, // 30
300 /** returns the Code corresponding to the \c name.
301 * Eg, translate("branch") == BRANCH_CODE
303 static Code translate(std::string const & name);
305 /// returns true the inset can hold an inset of given type
306 virtual bool insetAllowed(Code) const { return false; }
307 // if this inset has paragraphs should they be output all as default
308 // paragraphs with "Standard" layout?
309 virtual bool forceDefaultParagraphs(InsetBase const *) const { return false; }
311 virtual std::string const & getInsetName() const;
312 /// used to toggle insets
313 // is the inset open?
314 virtual bool isOpen() const { return false; }
316 virtual void open() {}
318 virtual void close() {}
319 // should this inset be handled like a normal charater
320 virtual bool isChar() const { return false; }
321 // is this equivalent to a letter?
322 virtual bool isLetter() const { return false; }
323 // is this equivalent to a space (which is BTW different from
324 // a line separator)?
325 virtual bool isSpace() const { return false; }
326 // should we have a non-filled line before this inset?
327 virtual bool display() const { return false; }
328 // should we break lines after this inset?
329 virtual bool isLineSeparator() const { return false; }
330 /// dumps content to lyxerr
331 virtual void dump() const;
333 virtual void write(Buffer const &, std::ostream &) const {}
335 virtual void read(Buffer const &, LyXLex &) {}
336 /// returns the number of rows (\n's) of generated tex code.
337 virtual int latex(Buffer const &, std::ostream &,
338 OutputParams const &) const { return 0; }
339 /// returns true to override begin and end inset in file
340 virtual bool directWrite() const;
342 virtual bool allowSpellCheck() const { return false; }
344 /// if this insets owns text cells (e.g. InsetText) return cell num
345 virtual LyXText * getText(int /*num*/) const { return 0; }
347 /** Adds a LaTeX snippet to the Preview Loader for transformation
348 * into a bitmap image. Does not start the laoding process.
350 * Most insets have no interest in this capability, so the method
353 virtual void addPreview(lyx::graphics::PreviewLoader &) const {}
355 // the real dispatcher
356 virtual void priv_dispatch(LCursor & cur, FuncRequest & cmd);
358 /// returns LyX code associated with the inset. Used for TOC, ...)
359 virtual Code lyxCode() const { return NO_CODE; }
361 /// -1: text mode, 1: math mode, 0 undecided
362 enum mode_type {UNDECIDED_MODE, TEXT_MODE, MATH_MODE};
363 /// return text or mathmode if that is possible to determine
364 virtual mode_type currentMode() const { return UNDECIDED_MODE; }
366 /// is this inset allowed within a font change?
367 virtual bool noFontChange() const { return false; }
370 virtual void markErased();
372 virtual int width() const { return 10; }
374 virtual int ascent() const { return 10; }
376 virtual int descent() const { return 10; }
381 * returns true if pointer argument is valid
382 * and points to an editable inset
384 bool isEditableInset(InsetBase const * inset);
388 * returns true if pointer argument is valid
389 * and points to a highly editable inset
391 bool isHighlyEditableInset(InsetBase const * inset);