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
14 #pragma implementation
23 #include "BufferView.h"
27 #include "font_metrics.h"
31 // Splash screen-specific stuff
35 #include "graphics/GraphicsLoader.h"
36 #include "graphics/GraphicsImage.h"
38 #include "support/filetools.h" // LibFileSearch
40 #include <boost/utility.hpp>
41 #include <boost/bind.hpp>
42 #include <boost/signals/trackable.hpp>
50 class SplashScreen : boost::noncopyable, boost::signals::trackable {
52 /// This is a singleton class. Get the instance.
53 static SplashScreen const & get();
55 grfx::Image const * image() const { return loader_.image(); }
57 string const & text() const { return text_; }
59 LyXFont const & font() const { return font_; }
62 /** Make the c-tor private so we can control how many objects
69 /// The text to be written on top of the pixmap
76 SplashScreen const & SplashScreen::get()
78 static SplashScreen singleton;
83 SplashScreen::SplashScreen()
84 : text_(lyx_version ? lyx_version : "unknown")
86 if (!lyxrc.show_banner)
89 string const file = LibFileSearch("images", "banner", "ppm");
93 // The font used to display the version info
94 font_.setFamily(LyXFont::SANS_FAMILY);
95 font_.setSeries(LyXFont::BOLD_SERIES);
96 font_.setSize(LyXFont::SIZE_NORMAL);
97 font_.setColor(LColor::yellow);
99 // Load up the graphics file
101 // We aren't interested here in when the image is loaded.
102 // If it isn't ready when we want it, then we ignore it.
103 // loader_->statusChanged.connect(
104 // boost::bind(&SplashScreen::statusChanged, this));
105 if (loader_.status() == grfx::WaitingToLoad)
106 loader_.startLoading();
112 LyXScreen::LyXScreen()
113 : force_clear_(true), cursor_visible_(false)
115 // Start loading the pixmap as soon as possible
120 LyXScreen::~LyXScreen()
124 // FIXME: GUII these cursor methods need to decide
125 // whether the workarea is focused or not
127 void LyXScreen::showCursor(LyXText const * text, BufferView const * bv)
132 workarea().getPainter().start();
134 Cursor_Shape shape = BAR_SHAPE;
135 BufferParams const & bp(bv->buffer()->params);
136 LyXFont const & realfont(text->real_current_font);
138 if (realfont.language() != bp.language
139 || realfont.isVisibleRightToLeft()
140 != bp.language->RightToLeft()) {
141 shape = (realfont.isVisibleRightToLeft())
142 ? REVERSED_L_SHAPE : L_SHAPE;
145 showManualCursor(text, text->cursor.x(), text->cursor.y(),
146 font_metrics::maxAscent(realfont),
147 font_metrics::maxDescent(realfont),
150 workarea().getPainter().end();
154 bool LyXScreen::fitManualCursor(BufferView * bv, LyXText * text,
155 int /*x*/, int y, int asc, int desc)
157 int const vheight = workarea().workHeight();
158 int newtop = text->first_y;
160 if (y + desc - text->first_y >= vheight)
161 newtop = y - 3 * vheight / 4; // the scroll region must be so big!!
162 else if (y - asc < text->first_y
163 && text->first_y > 0) {
164 newtop = y - vheight / 4;
167 newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
169 if (newtop != text->first_y) {
170 draw(text, bv, newtop);
171 text->first_y = newtop;
179 void LyXScreen::cursorToggle(BufferView * bv) const
188 unsigned int LyXScreen::topCursorVisible(LyXCursor const & cursor, int top_y)
190 int const vheight = workarea().workHeight();
193 Row * row = cursor.row();
195 // Is this a hack? Yes, probably... (Lgb)
197 return max(newtop, 0);
199 if (cursor.y() - row->baseline() + row->height() - top_y >= vheight) {
200 if (row->height() < vheight
201 && row->height() > vheight / 4) {
204 - row->baseline() - vheight;
208 - vheight / 2; /* the scroll region must be so big!! */
211 } else if (static_cast<int>((cursor.y()) - row->baseline()) <
212 top_y && top_y > 0) {
213 if (row->height() < vheight
214 && row->height() > vheight / 4) {
215 newtop = cursor.y() - row->baseline();
218 newtop = cursor.y() - vheight / 2;
219 newtop = min(newtop, top_y);
223 newtop = max(newtop, 0);
229 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
231 // Is a change necessary?
232 int const newtop = topCursorVisible(text->cursor, text->first_y);
233 bool const result = (newtop != text->first_y);
235 draw(text, bv, newtop);
242 void LyXScreen::update(LyXText * text, BufferView * bv,
245 int const vwidth = workarea().workWidth();
246 int const vheight = workarea().workHeight();
248 workarea().getPainter().start();
250 switch (text->status()) {
251 case LyXText::NEED_MORE_REFRESH:
253 int const y = max(int(text->refresh_y - text->first_y), 0);
254 drawFromTo(text, bv, y, vheight, yo, xo);
256 // otherwise this is called ONLY from BufferView_pimpl(update)
257 // or we should see to set this flag accordingly
258 if (text != bv->text)
259 text->status(bv, LyXText::UNCHANGED);
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 // otherwise this is called ONLY from BufferView_pimpl(update)
272 // or we should see to set this flag accordingly
273 if (text != bv->text)
274 text->status(bv, LyXText::UNCHANGED);
275 expose(0, text->refresh_y - text->first_y + yo,
276 vwidth, text->refresh_row->height());
280 case LyXText::CHANGED_IN_DRAW: // just to remove the warning
281 case LyXText::UNCHANGED:
282 // Nothing needs done
286 workarea().getPainter().end();
290 void LyXScreen::toggleSelection(LyXText * text, BufferView * bv,
294 // only if there is a selection
295 if (!text->selection.set()) return;
297 int const bottom = min(
298 max(static_cast<int>(text->selection.end.y()
299 - text->selection.end.row()->baseline()
300 + text->selection.end.row()->height()),
302 static_cast<int>(text->first_y + workarea().workHeight()));
304 max(static_cast<int>(text->selection.start.y() -
305 text->selection.start.row()->baseline()),
307 static_cast<int>(text->first_y + workarea().workHeight()));
310 text->selection.set(false);
312 workarea().getPainter().start();
314 drawFromTo(text, bv, top - text->first_y, bottom - text->first_y,
316 expose(0, top - text->first_y,
317 workarea().workWidth(),
318 bottom - text->first_y - (top - text->first_y));
320 workarea().getPainter().end();
324 void LyXScreen::toggleToggle(LyXText * text, BufferView * bv,
327 if (text->toggle_cursor.par() == text->toggle_end_cursor.par()
328 && text->toggle_cursor.pos() == text->toggle_end_cursor.pos())
331 int const top_tmp = text->toggle_cursor.y()
332 - text->toggle_cursor.row()->baseline();
333 int const bottom_tmp = text->toggle_end_cursor.y()
334 - text->toggle_end_cursor.row()->baseline()
335 + text->toggle_end_cursor.row()->height();
337 int const offset = yo < 0 ? yo : 0;
338 int const bottom = min(max(bottom_tmp, text->first_y),
339 static_cast<int>(text->first_y + workarea().workHeight())) - offset;
340 int const top = min(max(top_tmp, text->first_y),
341 static_cast<int>(text->first_y + workarea().workHeight())) - offset;
343 workarea().getPainter().start();
345 drawFromTo(text, bv, top - text->first_y,
346 bottom - text->first_y, yo,
348 expose(0, top - text->first_y, workarea().workWidth(),
349 bottom - text->first_y - (top - text->first_y));
351 workarea().getPainter().end();
355 void LyXScreen::redraw(LyXText * text, BufferView * bv)
357 workarea().getPainter().start();
361 expose(0, 0, workarea().workWidth(), workarea().workHeight());
362 workarea().getPainter().end();
366 drawFromTo(text, bv, 0, workarea().workHeight(), 0, 0, text == bv->text);
367 expose(0, 0, workarea().workWidth(), workarea().workHeight());
369 workarea().getPainter().end();
371 if (cursor_visible_) {
372 cursor_visible_ = false;
378 void LyXScreen::greyOut()
380 workarea().getPainter().fillRectangle(0, 0,
381 workarea().workWidth(),
382 workarea().workHeight(),
385 // Add a splash screen to the centre of the work area
386 SplashScreen const & splash = SplashScreen::get();
387 grfx::Image const * const splash_image = splash.image();
389 int const w = splash_image->getWidth();
390 int const h = splash_image->getHeight();
392 int x = (workarea().workWidth() - w) / 2;
393 int y = (workarea().workHeight() - h) / 2;
395 workarea().getPainter().image(x, y, w, h, *splash_image);
397 string const & splash_text = splash.text();
398 LyXFont const & splash_font = splash.font();
403 workarea().getPainter().text(x, y, splash_text, splash_font);
408 void LyXScreen::drawFromTo(LyXText * text, BufferView * bv,
409 int y1, int y2, int yo, int xo,
412 lyxerr[Debug::GUI] << "screen: drawFromTo " << y1 << '-' << y2 << endl;
414 int y_text = text->first_y + y1;
416 // get the first needed row
417 Row * row = text->getRowNearY(y_text);
418 // y_text is now the real beginning of the row
420 int y = y_text - text->first_y;
421 // y1 is now the real beginning of row on the screen
423 while (row != 0 && y < y2) {
424 LyXText::text_status st = text->status();
425 text->getVisibleRow(bv, y + yo,
426 xo, row, y + text->first_y);
427 internal = internal && (st != LyXText::CHANGED_IN_DRAW);
428 while (internal && text->status() == LyXText::CHANGED_IN_DRAW) {
429 text->fullRebreak(bv);
430 st = LyXText::NEED_MORE_REFRESH;
431 text->setCursor(bv, text->cursor.par(), text->cursor.pos());
432 text->status(bv, st);
433 text->getVisibleRow(bv, y + yo,
434 xo, row, y + text->first_y);
439 force_clear_ = false;
441 // maybe we have to clear the screen at the bottom
442 if ((y < y2) && text->bv_owner) {
443 workarea().getPainter().fillRectangle(0, y,
444 workarea().workWidth(), y2 - y,
450 void LyXScreen::drawOneRow(LyXText * text, BufferView * bv, Row * row,
451 int y_text, int yo, int xo)
453 int const y = y_text - text->first_y + yo;
455 if (((y + row->height()) > 0) &&
456 ((y - row->height()) <= static_cast<int>(workarea().workHeight()))) {
457 text->getVisibleRow(bv, y, xo, row, y + text->first_y);
459 force_clear_ = false;