3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
8 * Full author contact details are available in file CREDITS
10 * Splash screen code added by Angus Leeming
20 #include "BufferView.h"
24 #include "font_metrics.h"
27 #include "rowpainter.h"
29 // Splash screen-specific stuff
33 #include "graphics/GraphicsLoader.h"
34 #include "graphics/GraphicsImage.h"
36 #include "support/filetools.h" // LibFileSearch
38 #include <boost/utility.hpp>
39 #include <boost/bind.hpp>
40 #include <boost/signals/trackable.hpp>
48 class SplashScreen : boost::noncopyable, boost::signals::trackable {
50 /// This is a singleton class. Get the instance.
51 static SplashScreen const & get();
53 grfx::Image const * image() const { return loader_.image(); }
55 string const & text() const { return text_; }
57 LyXFont const & font() const { return font_; }
59 void connect(grfx::Loader::slot_type const & slot) const {
60 loader_.connect(slot);
63 void startLoading() const {
64 if (loader_.status() == grfx::WaitingToLoad)
65 loader_.startLoading();
69 /** Make the c-tor private so we can control how many objects
76 /// The text to be written on top of the pixmap
83 SplashScreen const & SplashScreen::get()
85 static SplashScreen singleton;
90 SplashScreen::SplashScreen()
91 : text_(lyx_version ? lyx_version : "unknown")
93 if (!lyxrc.show_banner)
96 string const file = LibFileSearch("images", "banner", "ppm");
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);
106 // Load up the graphics file
113 LyXScreen::LyXScreen()
114 : cursor_visible_(false), greyed_out_(true)
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();
125 LyXScreen::~LyXScreen()
129 // FIXME: GUII these cursor methods need to decide
130 // whether the workarea is focused or not
132 void LyXScreen::showCursor(LyXText const * text, BufferView const * bv)
137 workarea().getPainter().start();
139 Cursor_Shape shape = BAR_SHAPE;
140 BufferParams const & bp(bv->buffer()->params);
141 LyXFont const & realfont(text->real_current_font);
143 if (realfont.language() != bp.language
144 || realfont.isVisibleRightToLeft()
145 != bp.language->RightToLeft()) {
146 shape = (realfont.isVisibleRightToLeft())
147 ? REVERSED_L_SHAPE : L_SHAPE;
150 showManualCursor(text, text->cursor.x(), text->cursor.y(),
151 font_metrics::maxAscent(realfont),
152 font_metrics::maxDescent(realfont),
155 workarea().getPainter().end();
159 bool LyXScreen::fitManualCursor(BufferView * bv, LyXText * text,
160 int /*x*/, int y, int asc, int desc)
162 int const vheight = workarea().workHeight();
163 int newtop = text->top_y();
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;
172 newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
174 if (newtop != text->top_y()) {
175 draw(text, bv, newtop);
184 void LyXScreen::cursorToggle(BufferView * bv) const
193 unsigned int LyXScreen::topCursorVisible(LyXCursor const & cursor, int top_y)
195 int const vheight = workarea().workHeight();
198 Row * row = cursor.row();
200 // Is this a hack? Yes, probably... (Lgb)
202 return max(newtop, 0);
204 if (cursor.y() - row->baseline() + row->height() - top_y >= vheight) {
205 if (row->height() < vheight
206 && row->height() > vheight / 4) {
209 - row->baseline() - vheight;
213 - vheight / 2; /* the scroll region must be so big!! */
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();
223 newtop = cursor.y() - vheight / 2;
224 newtop = min(newtop, top_y);
228 newtop = max(newtop, 0);
234 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
236 // Is a change necessary?
237 int const newtop = topCursorVisible(text->cursor, text->top_y());
238 bool const result = (newtop != text->top_y());
240 draw(text, bv, newtop);
247 void LyXScreen::update(BufferView & bv, int yo, int xo)
249 int const vwidth = workarea().workWidth();
250 int const vheight = workarea().workHeight();
251 LyXText * text = bv.text;
253 workarea().getPainter().start();
255 switch (text->status()) {
256 case LyXText::NEED_MORE_REFRESH:
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);
263 case LyXText::NEED_VERY_LITTLE_REFRESH:
265 // ok I will update the current cursor row
266 drawOneRow(text, &bv, text->refresh_row, text->refresh_y,
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());
276 case LyXText::CHANGED_IN_DRAW: // just to remove the warning
277 case LyXText::UNCHANGED:
278 // Nothing needs done
282 workarea().getPainter().end();
286 void LyXScreen::toggleSelection(LyXText * text, BufferView * bv,
290 // only if there is a selection
291 if (!text->selection.set()) return;
293 int const bottom = min(
294 max(static_cast<int>(text->selection.end.y()
295 - text->selection.end.row()->baseline()
296 + text->selection.end.row()->height()),
298 static_cast<int>(text->top_y() + workarea().workHeight()));
300 max(static_cast<int>(text->selection.start.y() -
301 text->selection.start.row()->baseline()),
303 static_cast<int>(text->top_y() + workarea().workHeight()));
306 text->selection.set(false);
308 workarea().getPainter().start();
310 drawFromTo(text, bv, top - text->top_y(), bottom - text->top_y(),
312 expose(0, top - text->top_y(),
313 workarea().workWidth(),
314 bottom - text->top_y() - (top - text->top_y()));
316 workarea().getPainter().end();
320 void LyXScreen::toggleToggle(LyXText * text, BufferView * bv,
323 if (text->toggle_cursor.par() == text->toggle_end_cursor.par()
324 && text->toggle_cursor.pos() == text->toggle_end_cursor.pos())
327 int const top_tmp = text->toggle_cursor.y()
328 - text->toggle_cursor.row()->baseline();
329 int const bottom_tmp = text->toggle_end_cursor.y()
330 - text->toggle_end_cursor.row()->baseline()
331 + text->toggle_end_cursor.row()->height();
333 int const offset = yo < 0 ? yo : 0;
334 int const bottom = min(max(bottom_tmp, text->top_y()),
335 static_cast<int>(text->top_y() + workarea().workHeight())) - offset;
336 int const top = min(max(top_tmp, text->top_y()),
337 static_cast<int>(text->top_y() + workarea().workHeight())) - offset;
339 workarea().getPainter().start();
341 drawFromTo(text, bv, top - text->top_y(),
342 bottom - text->top_y(), yo,
344 expose(0, top - text->top_y(), workarea().workWidth(),
345 bottom - text->top_y() - (top - text->top_y()));
347 workarea().getPainter().end();
351 void LyXScreen::redraw(LyXText * text, BufferView * bv)
362 workarea().getPainter().start();
364 drawFromTo(text, bv, 0, workarea().workHeight(), 0, 0, text == bv->text);
365 expose(0, 0, workarea().workWidth(), workarea().workHeight());
367 workarea().getPainter().end();
369 if (cursor_visible_) {
370 cursor_visible_ = false;
376 void LyXScreen::greyOut()
381 workarea().getPainter().start();
383 workarea().getPainter().fillRectangle(0, 0,
384 workarea().workWidth(),
385 workarea().workHeight(),
388 // Add a splash screen to the centre of the work area
389 SplashScreen const & splash = SplashScreen::get();
390 grfx::Image const * const splash_image = splash.image();
392 int const w = splash_image->getWidth();
393 int const h = splash_image->getHeight();
395 int x = (workarea().workWidth() - w) / 2;
396 int y = (workarea().workHeight() - h) / 2;
398 workarea().getPainter().image(x, y, w, h, *splash_image);
400 string const & splash_text = splash.text();
401 LyXFont const & splash_font = splash.font();
406 workarea().getPainter().text(x, y, splash_text, splash_font);
408 expose(0, 0, workarea().workWidth(), workarea().workHeight());
409 workarea().getPainter().end();
413 void LyXScreen::drawFromTo(LyXText * text, BufferView * bv,
414 int y1, int y2, int yo, int xo,
417 lyxerr[Debug::GUI] << "screen: drawFromTo " << y1 << '-' << y2 << endl;
419 int y_text = text->top_y() + y1;
421 // get the first needed row
422 Row * row = text->getRowNearY(y_text);
423 // y_text is now the real beginning of the row
425 int y = y_text - text->top_y();
426 // y1 is now the real beginning of row on the screen
429 while (row != 0 && y < y2) {
430 LyXText::text_status st = text->status();
431 // we need this here as the row pointer may be illegal
432 // at a later time (Jug20020502)
433 Row * prev = row->previous();
434 RowPainter rp(*bv, *text, *row);
436 if (rp.paint(y + yo, xo, y + text->top_y()))
437 text->markChangeInDraw(bv, row, prev);
439 internal = internal && (st != LyXText::CHANGED_IN_DRAW);
440 while (internal && text->status() == LyXText::CHANGED_IN_DRAW) {
441 text->fullRebreak(bv);
442 text->setCursor(bv, text->cursor.par(), text->cursor.pos());
443 text->postPaint(*bv, 0);
444 Row * prev = row->previous();
445 RowPainter rp(*bv, *text, *row);
446 if (rp.paint(y + yo, xo, y + text->top_y()))
447 text->markChangeInDraw(bv, row, prev);
453 // maybe we have to clear the screen at the bottom
454 if ((y < y2) && text->isTopLevel()) {
455 workarea().getPainter().fillRectangle(0, y,
456 workarea().workWidth(), y2 - y,
462 void LyXScreen::drawOneRow(LyXText * text, BufferView * bv, Row * row,
463 int y_text, int yo, int xo)
465 int const y = y_text - text->top_y() + yo;
467 if (((y + row->height()) > 0) &&
468 ((y - row->height()) <= static_cast<int>(workarea().workHeight()))) {
469 Row * prev = row->previous();
470 RowPainter rp(*bv, *text, *row);
471 if (rp.paint(y, xo, y + text->top_y()))
472 text->markChangeInDraw(bv, row, prev);