]> git.lyx.org Git - lyx.git/blob - src/insets/inset.h
1b15c9ed841da2e31f6b1cf77824e26271160108
[lyx.git] / src / insets / inset.h
1 // -*- C++ -*-
2 /**
3  * \file inset.h
4  * This file is part of LyX, the document processor.
5  * Licence details can be found in the file COPYING.
6  *
7  * \author Alejandro Aguilar Sierra
8  * \author Jürgen Vigna
9  * \author Lars Gullik Bjønnes
10  * \author Matthias Ettrich
11  *
12  * Full author contact details are available in file CREDITS
13  */
14
15 #ifndef INSET_H
16 #define INSET_H
17
18 #include "LString.h"
19 #include "LColor.h"
20 #include "insetbase.h"
21 #include "support/types.h"
22
23 #include <vector>
24
25 class LyXFont;
26 class Dimension;
27 class Buffer;
28 class Painter;
29 class LatexRunParams;
30 class LyXText;
31 class LyXLex;
32 class Paragraph;
33 class ParagraphList;
34 class LyXCursor;
35 class FuncRequest;
36 class WordLangTuple;
37
38 struct LaTeXFeatures;
39
40 namespace grfx {
41         class PreviewLoader;
42 }
43
44 /// Insets
45 class Inset : public InsetBase {
46 public:
47         /** This is not quite the correct place for this enum. I think
48             the correct would be to let each subclass of Inset declare
49             its own enum code. Actually the notion of an Inset::Code
50             should be avoided, but I am not sure how this could be done
51             in a cleaner way. */
52         enum Code {
53                 ///
54                 NO_CODE,
55                 ///
56                 TOC_CODE,  // do these insets really need a code? (ale)
57                 ///
58                 QUOTE_CODE,
59                 ///
60                 MARK_CODE,
61                 ///
62                 REF_CODE, // 5
63                 ///
64                 URL_CODE,
65                 ///
66                 HTMLURL_CODE,
67                 ///
68                 SEPARATOR_CODE,
69                 ///
70                 ENDING_CODE,
71                 ///
72                 LABEL_CODE, // 10
73                 ///
74                 NOTE_CODE,
75                 ///
76                 ACCENT_CODE,
77                 ///
78                 MATH_CODE,
79                 ///
80                 INDEX_CODE,
81                 ///
82                 INCLUDE_CODE, // 15
83                 ///
84                 GRAPHICS_CODE,
85                 ///
86                 PARENT_CODE,
87                 ///
88                 BIBITEM_CODE,
89                 ///
90                 BIBTEX_CODE,
91                 ///
92                 TEXT_CODE,
93                 ///
94                 ERT_CODE, // 20
95                 ///
96                 FOOT_CODE,
97                 ///
98                 MARGIN_CODE,
99                 ///
100                 FLOAT_CODE,
101                 ///
102                 WRAP_CODE,
103                 ///
104                 MINIPAGE_CODE,
105                 ///
106                 SPACE_CODE,
107                 ///
108                 SPECIALCHAR_CODE, // 25
109                 ///
110                 TABULAR_CODE,
111                 ///
112                 EXTERNAL_CODE,
113 #if 0
114                 ///
115                 THEOREM_CODE,
116 #endif
117                 ///
118                 CAPTION_CODE,
119                 ///
120                 MATHMACRO_CODE, // 30
121                 ///
122                 ERROR_CODE,
123                 ///
124                 CITE_CODE,
125                 ///
126                 FLOAT_LIST_CODE,
127                 ///
128                 INDEX_PRINT_CODE,
129                 ///
130                 OPTARG_CODE,
131                 ///
132                 ENVIRONMENT_CODE,
133                 ///
134                 HFILL_CODE,
135                 ///
136                 NEWLINE_CODE
137         };
138
139         ///
140         enum {
141                 ///
142                 TEXT_TO_INSET_OFFSET = 2
143         };
144
145         ///
146         enum EDITABLE {
147                 ///
148                 NOT_EDITABLE = 0,
149                 ///
150                 IS_EDITABLE,
151                 ///
152                 HIGHLY_EDITABLE
153         };
154
155         ///
156         typedef dispatch_result RESULT;
157
158         ///
159         Inset();
160         ///
161         Inset(Inset const & in);
162         ///
163         //Inset(Inset const & in, bool same_id);
164         ///
165         virtual void dimension(BufferView *, LyXFont const &, Dimension &) const = 0;
166         ///
167         int ascent(BufferView *, LyXFont const &) const;
168         ///
169         int descent(BufferView *, LyXFont const &) const;
170         ///
171         int width(BufferView *, LyXFont const &) const;
172         ///
173         virtual void draw(BufferView *, LyXFont const &, int baseline, float & x) const = 0;
174         /// update the inset representation
175         virtual void update(BufferView *, bool = false)
176                 {}
177         /// what appears in the minibuffer when opening
178         virtual string const editMessage() const;
179         ///
180         virtual EDITABLE editable() const;
181         ///
182         virtual bool isTextInset() const { return false; }
183         /// return true if the inset should be removed automatically
184         virtual bool autoDelete() const;
185         /// returns true the inset can hold an inset of given type
186         virtual bool insetAllowed(Inset::Code) const { return false; }
187         /// wrapper around the above
188         bool insetAllowed(Inset * in) const;
189         ///
190         virtual void write(Buffer const *, std::ostream &) const = 0;
191         ///
192         virtual void read(Buffer const *, LyXLex & lex) = 0;
193         /// returns the number of rows (\n's) of generated tex code.
194         virtual int latex(Buffer const *, std::ostream &,
195                           LatexRunParams const &) const = 0;
196         ///
197         virtual int ascii(Buffer const *,
198                           std::ostream &, int linelen = 0) const = 0;
199         ///
200         virtual int linuxdoc(Buffer const *, std::ostream &) const = 0;
201         ///
202         virtual int docbook(Buffer const *, std::ostream &, bool) const = 0;
203         /// Updates needed features for this inset.
204         virtual void validate(LaTeXFeatures & features) const;
205
206         /// returns LyX code associated with the inset. Used for TOC, ...)
207         virtual Inset::Code lyxCode() const { return NO_CODE; }
208
209         virtual std::vector<string> const getLabelList() const {
210                 return std::vector<string>();
211         }
212
213         ///
214         virtual Inset * clone(Buffer const &) const = 0;
215         ///
216         //virtual Inset * clone(Buffer const &, bool same_ids) const = 0;
217
218         /// returns true to override begin and end inset in file
219         virtual bool directWrite() const;
220
221         /// Returns true if the inset should be centered alone
222         virtual bool display() const { return false; }
223         /// Changes the display state of the inset
224         virtual void display(bool) {}
225         ///
226         /// returns true if this inset needs a row on it's own
227         ///
228         virtual bool needFullRow() const { return false; }
229         ///
230         void setInsetName(string const & s) { name_ = s; }
231         ///
232         string const & getInsetName() const { return name_; }
233         ///
234         void setOwner(Inset * inset) { owner_ = inset; }
235         ///
236         Inset * owner() const { return owner_; }
237         ///
238         void parOwner(Paragraph * par) { par_owner_ = par; }
239         ///
240         Paragraph * parOwner() const { return par_owner_; }
241         ///
242         void setBackgroundColor(LColor::color);
243         ///
244         LColor::color backgroundColor() const;
245         ///
246         int x() const { return top_x; }
247         ///
248         int y() const { return top_baseline; }
249         //
250         // because we could have fake text insets and have to call this
251         // inside them without cast!!!
252         ///
253         virtual LyXText * getLyXText(BufferView const *,
254                                      bool const recursive = false) const;
255         ///
256         virtual void deleteLyXText(BufferView *, bool = true) const {}
257         ///
258         virtual void resizeLyXText(BufferView *, bool /*force*/= false) const {}
259         /// returns the actuall scroll-value
260         virtual int scroll(bool recursive=true) const {
261                 if (!recursive || !owner_)
262                         return scx;
263                 return 0;
264         }
265
266         /// try to get a inset pointer from it's id if we have
267         /// an inset to give back!
268         virtual Inset * getInsetFromID(int /*id*/) const { return 0; }
269         /// if this insets owns paragraphs (f.ex. InsetText) then it
270         /// should return it's very first one!
271         virtual ParagraphList * getParagraphs(int /*num*/) const { return 0; }
272         ///
273         virtual bool haveParagraphs() const {
274                 return false;
275         }
276
277         /// return the cursor if we own one otherwise giv'em just the
278         /// BufferView cursor to work with.
279         virtual LyXCursor const & cursor(BufferView * bview) const;
280         /// id functions
281         int id() const;
282         ///
283         void id(int id_arg);
284
285         /// used to toggle insets
286         // is the inset open?
287         virtual bool isOpen() const { return false; }
288         /// open the inset
289         virtual void open(BufferView *) {}
290         /// close the inset
291         virtual void close(BufferView *) const {}
292         /// check if the font of the char we want inserting is correct
293         /// and modify it if it is not.
294         virtual bool checkInsertChar(LyXFont &);
295         /// we need this here because collapsed insets are only EDITABLE
296         virtual void setFont(BufferView *, LyXFont const &,
297                          bool toggleall = false, bool selectall = false);
298         ///
299         // needed for spellchecking text
300         ///
301         virtual bool allowSpellcheck() const { return false; }
302
303         // should this inset be handled like a normal charater
304         virtual bool isChar() const { return false; }
305         // is this equivalent to a letter?
306         virtual bool isLetter() const { return false; }
307         // is this equivalent to a space (which is BTW different from
308         // a line separator)?
309         virtual bool isSpace() const { return false; }
310         // should we break lines after this inset?
311         virtual bool isLineSeparator() const { return false; }
312         // if this inset has paragraphs should they be output all as default
313         // paragraphs with "Standard" layout?
314         virtual bool forceDefaultParagraphs(Inset const *) const;
315         /** returns true if, when outputing LaTeX, font changes should
316             be closed before generating this inset. This is needed for
317             insets that may contain several paragraphs */
318         virtual bool noFontChange() const { return false; }
319         //
320         virtual void getDrawFont(LyXFont &) const {}
321         /* needed for widths which are % of something
322            returns the value of \textwidth in this inset. Most of the
323            time this is the width of the workarea, but if there is a
324            minipage somewhere, it will be the width of this minipage */
325         virtual int latexTextWidth(BufferView *) const;
326
327         /// mark the inset contents as erased (for change tracking)
328         virtual void markErased() {}
329
330         /** Adds a LaTeX snippet to the Preview Loader for transformation
331          *  into a bitmap image. Does not start the laoding process.
332          *
333          *  Most insets have no interest in this capability, so the method
334          *  defaults to empty.
335          */
336         virtual void addPreview(grfx::PreviewLoader &) const {}
337
338         /** Find the PreviewLoader, add a LaTeX snippet to it and
339          *  start the loading process.
340          *
341          *  Most insets have no interest in this capability, so the method
342          *  defaults to empty.
343          */
344         virtual void generatePreview() const {}
345
346 protected:
347         ///
348         mutable int top_x;
349         ///
350         mutable int top_baseline;
351         ///
352         mutable int scx;
353         ///
354         unsigned int id_;
355         ///
356         static unsigned int inset_id;
357
358 private:
359         ///
360         Inset * owner_;
361         /// the paragraph in which this inset has been inserted
362         Paragraph * par_owner_;
363         ///
364         string name_;
365         ///
366         LColor::color background_color_;
367 };
368
369
370 inline
371 bool Inset::insetAllowed(Inset * in) const
372 {
373         return insetAllowed(in->lyxCode());
374 }
375
376
377 inline
378 bool Inset::checkInsertChar(LyXFont &)
379 {
380         return false;
381 }
382
383 /**
384  * returns true if pointer argument is valid
385  * and points to an editable inset
386  */
387 inline bool isEditableInset(Inset const * i)
388 {
389         return i && i->editable();
390 }
391
392 /**
393  * returns true if pointer argument is valid
394  * and points to a highly editable inset
395  */
396 inline bool isHighlyEditableInset(Inset const * i)
397 {
398         return i && i->editable() == Inset::HIGHLY_EDITABLE;
399 }
400
401 #endif