]> git.lyx.org Git - lyx.git/blob - src/insets/Inset.cpp
Fix GRAPHICS_EDIT of InsetGraphics
[lyx.git] / src / insets / Inset.cpp
1 /**
2  * \file Inset.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Alejandro Aguilar Sierra
7  * \author Jürgen Vigna
8  * \author Lars Gullik Bjønnes
9  * \author Matthias Ettrich
10  * \author André Pönitz
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "Inset.h"
18
19 #include "buffer_funcs.h"
20 #include "Buffer.h"
21 #include "BufferParams.h"
22 #include "BufferView.h"
23 #include "CoordCache.h"
24 #include "Cursor.h"
25 #include "Dimension.h"
26 #include "DispatchResult.h"
27 #include "FuncRequest.h"
28 #include "FuncStatus.h"
29 #include "MetricsInfo.h"
30 #include "Text.h"
31 #include "TextClass.h"
32
33 #include "frontends/Painter.h"
34 #include "frontends/Application.h"
35
36 #include "support/convert.h"
37 #include "support/debug.h"
38 #include "support/docstream.h"
39 #include "support/ExceptionMessage.h"
40 #include "support/gettext.h"
41
42 #include <map>
43
44 using namespace std;
45 using namespace lyx::support;
46
47 namespace lyx {
48
49 class InsetName {
50 public:
51         InsetName(string const & n, InsetCode c) : name(n), code(c) {}
52         string name;
53         InsetCode code;
54 };
55
56
57 typedef map<string, InsetCode> TranslatorMap;
58
59
60 static TranslatorMap const build_translator()
61 {
62         InsetName const insetnames[] = {
63                 InsetName("toc", TOC_CODE),
64                 InsetName("quote", QUOTE_CODE),
65                 InsetName("ref", REF_CODE),
66                 InsetName("href", HYPERLINK_CODE),
67                 InsetName("separator", SEPARATOR_CODE),
68                 InsetName("ending", ENDING_CODE),
69                 InsetName("label", LABEL_CODE),
70                 InsetName("note", NOTE_CODE),
71                 InsetName("accent", ACCENT_CODE),
72                 InsetName("math", MATH_CODE),
73                 InsetName("index", INDEX_CODE),
74                 InsetName("nomenclature", NOMENCL_CODE),
75                 InsetName("include", INCLUDE_CODE),
76                 InsetName("graphics", GRAPHICS_CODE),
77                 InsetName("bibitem", BIBITEM_CODE),
78                 InsetName("bibtex", BIBTEX_CODE),
79                 InsetName("text", TEXT_CODE),
80                 InsetName("ert", ERT_CODE),
81                 InsetName("foot", FOOT_CODE),
82                 InsetName("margin", MARGIN_CODE),
83                 InsetName("float", FLOAT_CODE),
84                 InsetName("wrap", WRAP_CODE),
85                 InsetName("specialchar", SPECIALCHAR_CODE),
86                 InsetName("tabular", TABULAR_CODE),
87                 InsetName("external", EXTERNAL_CODE),
88                 InsetName("caption", CAPTION_CODE),
89                 InsetName("mathmacro", MATHMACRO_CODE),
90                 InsetName("citation", CITE_CODE),
91                 InsetName("floatlist", FLOAT_LIST_CODE),
92                 InsetName("index_print", INDEX_PRINT_CODE),
93                 InsetName("nomencl_print", NOMENCL_PRINT_CODE),
94                 InsetName("optarg", OPTARG_CODE),
95                 InsetName("environment", ENVIRONMENT_CODE),
96                 InsetName("newline", NEWLINE_CODE),
97                 InsetName("line", LINE_CODE),
98                 InsetName("branch", BRANCH_CODE),
99                 InsetName("box", BOX_CODE),
100                 InsetName("flex", FLEX_CODE),
101                 InsetName("space", SPACE_CODE),
102                 InsetName("vspace", VSPACE_CODE),
103                 InsetName("mathmacroarg", MATHMACROARG_CODE),
104                 InsetName("listings", LISTINGS_CODE),
105                 InsetName("info", INFO_CODE),
106                 InsetName("collapsable", COLLAPSABLE_CODE),
107                 InsetName("newpage", NEWPAGE_CODE),
108                 InsetName("tablecell", CELL_CODE)
109         };
110
111         size_t const insetnames_size =
112                 sizeof(insetnames) / sizeof(insetnames[0]);
113
114         map<string, InsetCode> data;
115         for (size_t i = 0; i != insetnames_size; ++i) {
116                 InsetName const & var = insetnames[i];
117                 data[var.name] = var.code;
118         }
119
120         return data;
121 }
122
123
124 void Inset::setBuffer(Buffer & buffer)
125 {
126         buffer_ = &buffer;
127 }
128
129
130 Buffer & Inset::buffer()
131 {
132         if (!buffer_) {
133                 odocstringstream s;
134                 s << "LyX Code: " << lyxCode() << " name: " << name();
135                 BOOST_ASSERT(false);
136                 throw ExceptionMessage(BufferException, 
137                         from_ascii("Inset::buffer_ member not initialized!"), s.str());
138         }
139         return *buffer_;
140 }
141
142
143 Buffer const & Inset::buffer() const
144 {
145         return const_cast<Inset *>(this)->buffer();
146 }
147
148
149 docstring Inset::name() const
150 {
151         return from_ascii("unknown");
152 }
153
154
155 void Inset::initView()
156 {
157         if (isLabeled())
158                 lyx::updateLabels(buffer());
159 }
160
161
162 docstring Inset::toolTip(BufferView const &, int, int) const
163 {
164         return docstring();
165 }
166
167
168 docstring Inset::contextMenu(BufferView const &, int, int) const
169 {
170         return docstring();
171 }
172
173
174 Dimension const Inset::dimension(BufferView const & bv) const
175 {
176         return bv.coordCache().getInsets().dim(this);
177 }
178
179
180 InsetCode insetCode(string const & name)
181 {
182         static TranslatorMap const translator = build_translator();
183
184         TranslatorMap::const_iterator it = translator.find(name);
185         return it == translator.end() ? NO_CODE : it->second;
186 }
187
188
189 string insetName(InsetCode c) 
190 {
191         static TranslatorMap const translator = build_translator();
192
193         TranslatorMap::const_iterator it =  translator.begin();
194         TranslatorMap::const_iterator end = translator.end();
195         for (; it != end; ++it) {
196                 if (it->second == c)
197                         return it->first;
198         }
199         return string();
200 }
201
202
203 void Inset::dispatch(Cursor & cur, FuncRequest & cmd)
204 {
205         cur.updateFlags(Update::Force | Update::FitCursor);
206         cur.dispatched();
207         doDispatch(cur, cmd);
208 }
209
210
211 void Inset::doDispatch(Cursor & cur, FuncRequest &)
212 {
213         cur.noUpdate();
214         cur.undispatched();
215 }
216
217
218 bool Inset::getStatus(Cursor &, FuncRequest const & cmd,
219         FuncStatus & flag) const
220 {
221         // LFUN_INSET_APPLY is sent from the dialogs when the data should
222         // be applied. This is either changed to LFUN_INSET_MODIFY (if the
223         // dialog belongs to us) or LFUN_INSET_INSERT (if the dialog does
224         // not belong to us, i. e. the dialog was open, and the user moved
225         // the cursor in our inset) in LyXFunc::getStatus().
226         // Dialogs::checkStatus() ensures that the dialog is deactivated if
227         // LFUN_INSET_APPLY is disabled.
228
229         switch (cmd.action) {
230         case LFUN_INSET_MODIFY:
231                 // Allow modification of our data.
232                 // This needs to be handled in the doDispatch method of our
233                 // instantiatable children.
234                 flag.enabled(true);
235                 return true;
236
237         case LFUN_INSET_INSERT:
238                 // Don't allow insertion of new insets.
239                 // Every inset that wants to allow new insets from open
240                 // dialogs needs to override this.
241                 flag.enabled(false);
242                 return true;
243
244         default:
245                 return false;
246         }
247 }
248
249
250 void Inset::edit(Cursor &, bool, EntryDirection)
251 {
252         LYXERR(Debug::INSETS, "edit left/right");
253 }
254
255
256 Inset * Inset::editXY(Cursor &, int x, int y)
257 {
258         LYXERR(Debug::INSETS, "x: " << x << " y: " << y);
259         return this;
260 }
261
262
263 Inset::idx_type Inset::index(row_type row, col_type col) const
264 {
265         if (row != 0)
266                 LYXERR0("illegal row: " << row);
267         if (col != 0)
268                 LYXERR0("illegal col: " << col);
269         return 0;
270 }
271
272
273 bool Inset::idxBetween(idx_type idx, idx_type from, idx_type to) const
274 {
275         return from <= idx && idx <= to;
276 }
277
278
279 bool Inset::idxUpDown(Cursor &, bool) const
280 {
281         return false;
282 }
283
284
285 int Inset::docbook(odocstream &, OutputParams const &) const
286 {
287         return 0;
288 }
289
290
291 bool Inset::directWrite() const
292 {
293         return false;
294 }
295
296
297 Inset::EDITABLE Inset::editable() const
298 {
299         return NOT_EDITABLE;
300 }
301
302
303 bool Inset::autoDelete() const
304 {
305         return false;
306 }
307
308
309 docstring Inset::editMessage() const
310 {
311         return _("Opened inset");
312 }
313
314
315 void Inset::cursorPos(BufferView const & /*bv*/, CursorSlice const &,
316                 bool, int & x, int & y) const
317 {
318         LYXERR0("Inset::cursorPos called directly");
319         x = 100;
320         y = 100;
321 }
322
323
324 void Inset::metricsMarkers(Dimension & dim, int framesize) const
325 {
326         dim.wid += 2 * framesize;
327         dim.des += framesize;
328 }
329
330
331 void Inset::metricsMarkers2(Dimension & dim, int framesize) const
332 {
333         dim.wid += 2 * framesize;
334         dim.asc += framesize;
335         dim.des += framesize;
336 }
337
338
339 void Inset::drawMarkers(PainterInfo & pi, int x, int y) const
340 {
341         ColorCode pen_color = mouseHovered() || editing(pi.base.bv)?
342                 Color_mathframe : Color_mathcorners;
343
344         Dimension const dim = dimension(*pi.base.bv);
345
346         int const t = x + dim.width() - 1;
347         int const d = y + dim.descent();
348         pi.pain.line(x, d - 3, x, d, pen_color);
349         pi.pain.line(t, d - 3, t, d, pen_color);
350         pi.pain.line(x, d, x + 3, d, pen_color);
351         pi.pain.line(t - 3, d, t, d, pen_color);
352         setPosCache(pi, x, y);
353 }
354
355
356 void Inset::drawMarkers2(PainterInfo & pi, int x, int y) const
357 {
358         ColorCode pen_color = mouseHovered() || editing(pi.base.bv)?
359                 Color_mathframe : Color_mathcorners;
360
361         drawMarkers(pi, x, y);
362         Dimension const dim = dimension(*pi.base.bv);
363         int const t = x + dim.width() - 1;
364         int const a = y - dim.ascent();
365         pi.pain.line(x, a + 3, x, a, pen_color);
366         pi.pain.line(t, a + 3, t, a, pen_color);
367         pi.pain.line(x, a, x + 3, a, pen_color);
368         pi.pain.line(t - 3, a, t, a, pen_color);
369         setPosCache(pi, x, y);
370 }
371
372
373 bool Inset::editing(BufferView const * bv) const
374 {
375         return bv->cursor().isInside(this);
376 }
377
378
379 int Inset::xo(BufferView const & bv) const
380 {
381         return bv.coordCache().getInsets().x(this);
382 }
383
384
385 int Inset::yo(BufferView const & bv) const
386 {
387         return bv.coordCache().getInsets().y(this);
388 }
389
390
391 bool Inset::covers(BufferView const & bv, int x, int y) const
392 {
393         return bv.coordCache().getInsets().covers(this, x, y);
394 }
395
396
397 InsetLayout const & Inset::getLayout(BufferParams const & bp) const
398 {
399         return bp.documentClass().insetLayout(name());  
400 }
401
402
403 void Inset::dump() const
404 {
405         write(lyxerr);
406 }
407
408
409 ColorCode Inset::backgroundColor() const
410 {
411         return Color_background;
412 }
413
414
415 void Inset::setPosCache(PainterInfo const & pi, int x, int y) const
416 {
417         //LYXERR("Inset: set position cache to " << x << " " << y);
418         pi.base.bv->coordCache().insets().add(this, x, y);
419 }
420
421
422 void Inset::setDimCache(MetricsInfo const & mi, Dimension const & dim) const
423 {
424         mi.base.bv->coordCache().insets().add(this, dim);
425 }
426
427
428 Buffer const * Inset::updateFrontend() const
429 {
430         return theApp() ? theApp()->updateInset(this) : 0;
431 }
432
433
434 docstring Inset::completionPrefix(Cursor const &) const 
435 {
436         return docstring();
437 }
438
439 } // namespace lyx