]> git.lyx.org Git - lyx.git/blob - src/frontends/screen.C
Use PanelStack for the document dialog too
[lyx.git] / src / frontends / screen.C
1 /**
2  * \file screen.C
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author John Levon
7  *
8  * Full author contact details are available in file CREDITS
9  *
10  * Splash screen code added by Angus Leeming
11  */
12
13
14 #include <config.h>
15
16 #include "screen.h"
17 #include "lyxtext.h"
18 #include "lyxrc.h"
19 #include "lyxrow.h"
20 #include "BufferView.h"
21 #include "buffer.h"
22 #include "WorkArea.h"
23 #include "Painter.h"
24 #include "font_metrics.h"
25 #include "language.h"
26 #include "debug.h"
27 #include "rowpainter.h"
28
29 // Splash screen-specific stuff
30 #include "lyxfont.h"
31 #include "version.h"
32
33 #include "graphics/GraphicsLoader.h"
34 #include "graphics/GraphicsImage.h"
35
36 #include "support/filetools.h" // LibFileSearch
37
38 #include <boost/utility.hpp>
39 #include <boost/bind.hpp>
40 #include <boost/signals/trackable.hpp>
41
42 using std::min;
43 using std::max;
44 using std::endl;
45
46 namespace {
47
48 class SplashScreen : boost::noncopyable, boost::signals::trackable {
49 public:
50         /// This is a singleton class. Get the instance.
51         static SplashScreen const & get();
52         ///
53         grfx::Image const * image() const { return loader_.image(); }
54         ///
55         string const & text() const { return text_; }
56         ///
57         LyXFont const & font() const { return font_; }
58         ///
59         void connect(grfx::Loader::slot_type const & slot) const {
60                 loader_.connect(slot);
61         }
62         ///
63         void startLoading() const {
64                 if (loader_.status() == grfx::WaitingToLoad)
65                         loader_.startLoading();
66         }
67
68 private:
69         /** Make the c-tor private so we can control how many objects
70          *  are instantiated.
71          */
72         SplashScreen();
73
74         ///
75         grfx::Loader loader_;
76         /// The text to be written on top of the pixmap
77         string const text_;
78         /// in this font...
79         LyXFont font_;
80 };
81
82
83 SplashScreen const & SplashScreen::get()
84 {
85         static SplashScreen singleton;
86         return singleton;
87 }
88
89
90 SplashScreen::SplashScreen()
91         : text_(lyx_version ? lyx_version : "unknown")
92 {
93         if (!lyxrc.show_banner)
94                 return;
95
96         string const file = LibFileSearch("images", "banner", "ppm");
97         if (file.empty())
98                 return;
99
100         // The font used to display the version info
101         font_.setFamily(LyXFont::SANS_FAMILY);
102         font_.setSeries(LyXFont::BOLD_SERIES);
103         font_.setSize(LyXFont::SIZE_NORMAL);
104         font_.setColor(LColor::yellow);
105
106         // Load up the graphics file
107         loader_.reset(file);
108 }
109
110 } // namespace anon
111
112
113 LyXScreen::LyXScreen()
114         : cursor_visible_(false), greyed_out_(true)
115 {
116         // Start loading the pixmap as soon as possible
117         if (lyxrc.show_banner) {
118                 SplashScreen const & splash = SplashScreen::get();
119                 splash.connect(boost::bind(&LyXScreen::greyOut, this));
120                 splash.startLoading();
121         }
122 }
123
124
125 LyXScreen::~LyXScreen()
126 {
127 }
128
129 // FIXME: GUII these cursor methods need to decide
130 // whether the workarea is focused or not
131
132 void LyXScreen::showCursor(LyXText const * text, BufferView const * bv)
133 {
134         if (cursor_visible_)
135                 return;
136
137         workarea().getPainter().start();
138
139         Cursor_Shape shape = BAR_SHAPE;
140         BufferParams const & bp(bv->buffer()->params);
141         LyXFont const & realfont(text->real_current_font);
142
143         if (realfont.language() != bp.language
144                 || realfont.isVisibleRightToLeft()
145                 != bp.language->RightToLeft()) {
146                 shape = (realfont.isVisibleRightToLeft())
147                         ? REVERSED_L_SHAPE : L_SHAPE;
148         }
149
150         showManualCursor(text, text->cursor.x(), text->cursor.y(),
151                 font_metrics::maxAscent(realfont),
152                 font_metrics::maxDescent(realfont),
153                 shape);
154
155         workarea().getPainter().end();
156 }
157
158
159 bool LyXScreen::fitManualCursor(BufferView * bv, LyXText * text,
160         int /*x*/, int y, int asc, int desc)
161 {
162         int const vheight = workarea().workHeight();
163         int newtop = text->top_y();
164
165         if (y + desc - text->top_y() >= vheight)
166                 newtop = y - 3 * vheight / 4;  // the scroll region must be so big!!
167         else if (y - asc < text->top_y()
168                 && text->top_y() > 0) {
169                 newtop = y - vheight / 4;
170         }
171
172         newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
173
174         if (newtop != text->top_y()) {
175                 draw(text, bv, newtop);
176                 text->top_y(newtop);
177                 return true;
178         }
179
180         return false;
181 }
182
183
184 void LyXScreen::cursorToggle(BufferView * bv) const
185 {
186         if (cursor_visible_)
187                 bv->hideCursor();
188         else
189                 bv->showCursor();
190 }
191
192
193 unsigned int LyXScreen::topCursorVisible(LyXCursor const & cursor, int top_y)
194 {
195         int const vheight = workarea().workHeight();
196         int newtop = top_y;
197
198         Row * row = cursor.row();
199
200         // Is this a hack? Yes, probably... (Lgb)
201         if (!row)
202                 return max(newtop, 0);
203
204         if (cursor.y() - row->baseline() + row->height() - top_y >= vheight) {
205                 if (row->height() < vheight
206                     && row->height() > vheight / 4) {
207                         newtop = cursor.y()
208                                 + row->height()
209                                 - row->baseline() - vheight;
210                 } else {
211                         // scroll down
212                         newtop = cursor.y()
213                                 - vheight / 2;   /* the scroll region must be so big!! */
214                 }
215
216         } else if (static_cast<int>((cursor.y()) - row->baseline()) <
217                    top_y && top_y > 0) {
218                 if (row->height() < vheight
219                     && row->height() > vheight / 4) {
220                         newtop = cursor.y() - row->baseline();
221                 } else {
222                         // scroll up
223                         newtop = cursor.y() - vheight / 2;
224                         newtop = min(newtop, top_y);
225                 }
226         }
227
228         newtop = max(newtop, 0);
229
230         return newtop;
231 }
232
233
234 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
235 {
236         // Is a change necessary?
237         int const newtop = topCursorVisible(text->cursor, text->top_y());
238         bool const result = (newtop != text->top_y());
239         if (result) {
240                 draw(text, bv, newtop);
241         }
242
243         return result;
244 }
245
246
247 void LyXScreen::update(BufferView & bv, int yo, int xo)
248 {
249         int const vwidth = workarea().workWidth();
250         int const vheight = workarea().workHeight();
251         LyXText * text = bv.text;
252
253         workarea().getPainter().start();
254
255         switch (text->refreshStatus()) {
256         case LyXText::REFRESH_AREA:
257         {
258                 int const y = max(int(text->refresh_y - text->top_y()), 0);
259                 drawFromTo(text, &bv, y, vheight, yo, xo);
260                 expose(0, y, vwidth, vheight - y);
261         }
262         break;
263         case LyXText::REFRESH_ROW:
264         {
265                 // ok I will update the current cursor row
266                 drawOneRow(text, &bv, text->refresh_row, text->refresh_y,
267                            yo, xo);
268                 // this because if we had a major update the refresh_row could
269                 // have been set to 0!
270                 if (text->refresh_row) {
271                         expose(0, text->refresh_y - text->top_y() + yo,
272                                    vwidth, text->refresh_row->height());
273                 }
274         }
275         break;
276         case LyXText::REFRESH_NONE:
277                 // Nothing needs done
278                 break;
279         }
280
281         workarea().getPainter().end();
282 }
283
284
285 void LyXScreen::toggleSelection(LyXText * text, BufferView * bv,
286                                 bool kill_selection,
287                                 int yo, int xo)
288 {
289         // only if there is a selection
290         if (!text->selection.set()) return;
291
292         int const bottom = min(
293                 max(static_cast<int>(text->selection.end.y()
294                                      - text->selection.end.row()->baseline()
295                                      + text->selection.end.row()->height()),
296                     text->top_y()),
297                 static_cast<int>(text->top_y() + workarea().workHeight()));
298         int const top = min(
299                 max(static_cast<int>(text->selection.start.y() -
300                                      text->selection.start.row()->baseline()),
301                     text->top_y()),
302                 static_cast<int>(text->top_y() + workarea().workHeight()));
303
304         if (kill_selection)
305                 text->selection.set(false);
306
307         workarea().getPainter().start();
308
309         drawFromTo(text, bv, top - text->top_y(), bottom - text->top_y(),
310                    yo, xo);
311         expose(0, top - text->top_y(),
312                workarea().workWidth(),
313                bottom - text->top_y() - (top - text->top_y()));
314
315         workarea().getPainter().end();
316 }
317
318
319 void LyXScreen::toggleToggle(LyXText * text, BufferView * bv,
320                              int yo, int xo)
321 {
322         if (text->toggle_cursor.par() == text->toggle_end_cursor.par()
323             && text->toggle_cursor.pos() == text->toggle_end_cursor.pos())
324                 return;
325
326         int const top_tmp = text->toggle_cursor.y()
327                 - text->toggle_cursor.row()->baseline();
328         int const bottom_tmp = text->toggle_end_cursor.y()
329                 - text->toggle_end_cursor.row()->baseline()
330                 + text->toggle_end_cursor.row()->height();
331
332         int const offset = yo < 0 ? yo : 0;
333         int const bottom = min(max(bottom_tmp, text->top_y()),
334                 static_cast<int>(text->top_y() + workarea().workHeight())) - offset;
335         int const top = min(max(top_tmp, text->top_y()),
336                 static_cast<int>(text->top_y() + workarea().workHeight())) - offset;
337
338         workarea().getPainter().start();
339
340         drawFromTo(text, bv, top - text->top_y(), bottom - text->top_y(), yo, xo);
341         expose(0, top - text->top_y(), workarea().workWidth(),
342                bottom - text->top_y() - (top - text->top_y()));
343
344         workarea().getPainter().end();
345 }
346
347
348 void LyXScreen::redraw(LyXText * text, BufferView * bv)
349 {
350         greyed_out_ = !text;
351
352         if (greyed_out_) {
353                 greyOut();
354                 return;
355         }
356
357         workarea().getPainter().start();
358
359         drawFromTo(text, bv, 0, workarea().workHeight(), 0, 0);
360         expose(0, 0, workarea().workWidth(), workarea().workHeight());
361
362         workarea().getPainter().end();
363
364         if (cursor_visible_) {
365                 cursor_visible_ = false;
366                 bv->showCursor();
367         }
368 }
369
370
371 void LyXScreen::greyOut()
372 {
373         if (!greyed_out_)
374                 return;
375
376         workarea().getPainter().start();
377
378         workarea().getPainter().fillRectangle(0, 0,
379                 workarea().workWidth(),
380                 workarea().workHeight(),
381                 LColor::bottomarea);
382
383         // Add a splash screen to the centre of the work area
384         SplashScreen const & splash = SplashScreen::get();
385         grfx::Image const * const splash_image = splash.image();
386         if (splash_image) {
387                 int const w = splash_image->getWidth();
388                 int const h = splash_image->getHeight();
389
390                 int x = (workarea().workWidth() - w) / 2;
391                 int y = (workarea().workHeight() - h) / 2;
392
393                 workarea().getPainter().image(x, y, w, h, *splash_image);
394
395                 string const & splash_text  = splash.text();
396                 LyXFont const & splash_font = splash.font();
397
398                 x += 260;
399                 y += 265;
400
401                 workarea().getPainter().text(x, y, splash_text, splash_font);
402         }
403         expose(0, 0, workarea().workWidth(), workarea().workHeight());
404         workarea().getPainter().end();
405 }
406
407
408 void LyXScreen::drawFromTo(LyXText * text, BufferView * bv,
409         int y1, int y2, int yo, int xo)
410 {
411         lyxerr[Debug::GUI] << "screen: drawFromTo " << y1 << '-' << y2 << endl;
412
413         int y_text = text->top_y() + y1;
414
415         // get the first needed row
416         Row * row = text->getRowNearY(y_text);
417         // y_text is now the real beginning of the row
418
419         int y = y_text - text->top_y();
420         // y1 is now the real beginning of row on the screen
421
422
423         while (row != 0 && y < y2) {
424                 RowPainter rp(*bv, *text, *row);
425                 rp.paint(y + yo, xo, y + text->top_y());
426                 y += row->height();
427                 row = row->next();
428         }
429
430         // maybe we have to clear the screen at the bottom
431         if ((y < y2) && !text->isInInset()) {
432                 workarea().getPainter().fillRectangle(0, y,
433                         workarea().workWidth(), y2 - y,
434                         LColor::bottomarea);
435         }
436 }
437
438
439 void LyXScreen::drawOneRow(LyXText * text, BufferView * bv, Row * row,
440         int y_text, int yo, int xo)
441 {
442         int const y = y_text - text->top_y() + yo;
443
444         if (y + row->height() <= 0)
445                 return;
446
447         if (y - row->height() > workarea().workHeight())
448                 return;
449
450         RowPainter rp(*bv, *text, *row);
451         rp.paint(y, xo, y + text->top_y());
452 }