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"
28 // Splash screen-specific stuff
32 #include "graphics/GraphicsLoader.h"
33 #include "graphics/GraphicsImage.h"
35 #include "support/filetools.h" // LibFileSearch
37 #include <boost/utility.hpp>
38 #include <boost/bind.hpp>
39 #include <boost/signals/trackable.hpp>
47 class SplashScreen : boost::noncopyable, boost::signals::trackable {
49 /// This is a singleton class. Get the instance.
50 static SplashScreen const & get();
52 grfx::Image const * image() const { return loader_.image(); }
54 string const & text() const { return text_; }
56 LyXFont const & font() const { return font_; }
59 /** Make the c-tor private so we can control how many objects
66 /// The text to be written on top of the pixmap
73 SplashScreen const & SplashScreen::get()
75 static SplashScreen singleton;
80 SplashScreen::SplashScreen()
81 : text_(lyx_version ? lyx_version : "unknown")
83 if (!lyxrc.show_banner)
86 string const file = LibFileSearch("images", "banner", "ppm");
90 // The font used to display the version info
91 font_.setFamily(LyXFont::SANS_FAMILY);
92 font_.setSeries(LyXFont::BOLD_SERIES);
93 font_.setSize(LyXFont::SIZE_NORMAL);
94 font_.setColor(LColor::yellow);
96 // Load up the graphics file
98 // We aren't interested here in when the image is loaded.
99 // If it isn't ready when we want it, then we ignore it.
100 // loader_->statusChanged.connect(
101 // boost::bind(&SplashScreen::statusChanged, this));
102 if (loader_.status() == grfx::WaitingToLoad)
103 loader_.startLoading();
109 LyXScreen::LyXScreen()
110 : force_clear_(true), cursor_visible_(false)
112 // Start loading the pixmap as soon as possible
117 LyXScreen::~LyXScreen()
121 // FIXME: GUII these cursor methods need to decide
122 // whether the workarea is focused or not
124 void LyXScreen::showCursor(LyXText const * text, BufferView const * bv)
129 workarea().getPainter().start();
131 Cursor_Shape shape = BAR_SHAPE;
132 BufferParams const & bp(bv->buffer()->params);
133 LyXFont const & realfont(text->real_current_font);
135 if (realfont.language() != bp.language
136 || realfont.isVisibleRightToLeft()
137 != bp.language->RightToLeft()) {
138 shape = (realfont.isVisibleRightToLeft())
139 ? REVERSED_L_SHAPE : L_SHAPE;
142 showManualCursor(text, text->cursor.x(), text->cursor.y(),
143 font_metrics::maxAscent(realfont),
144 font_metrics::maxDescent(realfont),
147 workarea().getPainter().end();
151 bool LyXScreen::fitManualCursor(BufferView * bv, LyXText * text,
152 int /*x*/, int y, int asc, int desc)
154 int const vheight = workarea().workHeight();
155 int newtop = text->first_y;
157 if (y + desc - text->first_y >= vheight)
158 newtop = y - 3 * vheight / 4; // the scroll region must be so big!!
159 else if (y - asc < text->first_y
160 && text->first_y > 0) {
161 newtop = y - vheight / 4;
164 newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
166 if (newtop != text->first_y) {
167 draw(text, bv, newtop);
168 text->first_y = newtop;
176 void LyXScreen::cursorToggle(BufferView * bv) const
185 unsigned int LyXScreen::topCursorVisible(LyXCursor const & cursor, int top_y)
187 int const vheight = workarea().workHeight();
190 Row * row = cursor.row();
192 // Is this a hack? Yes, probably... (Lgb)
194 return max(newtop, 0);
196 if (cursor.y() - row->baseline() + row->height() - top_y >= vheight) {
197 if (row->height() < vheight
198 && row->height() > vheight / 4) {
201 - row->baseline() - vheight;
205 - vheight / 2; /* the scroll region must be so big!! */
208 } else if (static_cast<int>((cursor.y()) - row->baseline()) <
209 top_y && top_y > 0) {
210 if (row->height() < vheight
211 && row->height() > vheight / 4) {
212 newtop = cursor.y() - row->baseline();
215 newtop = cursor.y() - vheight / 2;
216 newtop = min(newtop, top_y);
220 newtop = max(newtop, 0);
226 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
228 // Is a change necessary?
229 int const newtop = topCursorVisible(text->cursor, text->first_y);
230 bool const result = (newtop != text->first_y);
232 draw(text, bv, newtop);
239 void LyXScreen::update(LyXText * text, BufferView * bv,
242 int const vwidth = workarea().workWidth();
243 int const vheight = workarea().workHeight();
245 workarea().getPainter().start();
247 switch (text->status()) {
248 case LyXText::NEED_MORE_REFRESH:
250 int const y = max(int(text->refresh_y - text->first_y), 0);
251 drawFromTo(text, bv, y, vheight, yo, xo);
253 // otherwise this is called ONLY from BufferView_pimpl(update)
254 // or we should see to set this flag accordingly
255 if (text != bv->text)
256 text->status(bv, LyXText::UNCHANGED);
257 expose(0, y, vwidth, vheight - y);
260 case LyXText::NEED_VERY_LITTLE_REFRESH:
262 // ok I will update the current cursor row
263 drawOneRow(text, bv, text->refresh_row, text->refresh_y,
265 // this because if we had a major update the refresh_row could
266 // have been set to 0!
267 if (text->refresh_row) {
268 // otherwise this is called ONLY from BufferView_pimpl(update)
269 // or we should see to set this flag accordingly
270 if (text != bv->text)
271 text->status(bv, LyXText::UNCHANGED);
272 expose(0, text->refresh_y - text->first_y + yo,
273 vwidth, text->refresh_row->height());
277 case LyXText::CHANGED_IN_DRAW: // just to remove the warning
278 case LyXText::UNCHANGED:
279 // Nothing needs done
283 workarea().getPainter().end();
287 void LyXScreen::toggleSelection(LyXText * text, BufferView * bv,
291 // only if there is a selection
292 if (!text->selection.set()) return;
294 int const bottom = min(
295 max(static_cast<int>(text->selection.end.y()
296 - text->selection.end.row()->baseline()
297 + text->selection.end.row()->height()),
299 static_cast<int>(text->first_y + workarea().workHeight()));
301 max(static_cast<int>(text->selection.start.y() -
302 text->selection.start.row()->baseline()),
304 static_cast<int>(text->first_y + workarea().workHeight()));
307 text->selection.set(false);
309 workarea().getPainter().start();
311 drawFromTo(text, bv, top - text->first_y, bottom - text->first_y,
313 expose(0, top - text->first_y,
314 workarea().workWidth(),
315 bottom - text->first_y - (top - text->first_y));
317 workarea().getPainter().end();
321 void LyXScreen::toggleToggle(LyXText * text, BufferView * bv,
324 if (text->toggle_cursor.par() == text->toggle_end_cursor.par()
325 && text->toggle_cursor.pos() == text->toggle_end_cursor.pos())
328 int const top_tmp = text->toggle_cursor.y()
329 - text->toggle_cursor.row()->baseline();
330 int const bottom_tmp = text->toggle_end_cursor.y()
331 - text->toggle_end_cursor.row()->baseline()
332 + text->toggle_end_cursor.row()->height();
334 int const offset = yo < 0 ? yo : 0;
335 int const bottom = min(max(bottom_tmp, text->first_y),
336 static_cast<int>(text->first_y + workarea().workHeight())) - offset;
337 int const top = min(max(top_tmp, text->first_y),
338 static_cast<int>(text->first_y + workarea().workHeight())) - offset;
340 workarea().getPainter().start();
342 drawFromTo(text, bv, top - text->first_y,
343 bottom - text->first_y, yo,
345 expose(0, top - text->first_y, workarea().workWidth(),
346 bottom - text->first_y - (top - text->first_y));
348 workarea().getPainter().end();
352 void LyXScreen::redraw(LyXText * text, BufferView * bv)
354 workarea().getPainter().start();
358 expose(0, 0, workarea().workWidth(), workarea().workHeight());
359 workarea().getPainter().end();
363 drawFromTo(text, bv, 0, workarea().workHeight(), 0, 0, text == bv->text);
364 expose(0, 0, workarea().workWidth(), workarea().workHeight());
366 workarea().getPainter().end();
368 if (cursor_visible_) {
369 cursor_visible_ = false;
375 void LyXScreen::greyOut()
377 workarea().getPainter().fillRectangle(0, 0,
378 workarea().workWidth(),
379 workarea().workHeight(),
382 // Add a splash screen to the centre of the work area
383 SplashScreen const & splash = SplashScreen::get();
384 grfx::Image const * const splash_image = splash.image();
386 int const w = splash_image->getWidth();
387 int const h = splash_image->getHeight();
389 int x = (workarea().workWidth() - w) / 2;
390 int y = (workarea().workHeight() - h) / 2;
392 workarea().getPainter().image(x, y, w, h, *splash_image);
394 string const & splash_text = splash.text();
395 LyXFont const & splash_font = splash.font();
400 workarea().getPainter().text(x, y, splash_text, splash_font);
405 void LyXScreen::drawFromTo(LyXText * text, BufferView * bv,
406 int y1, int y2, int yo, int xo,
409 lyxerr[Debug::GUI] << "screen: drawFromTo " << y1 << '-' << y2 << endl;
411 int y_text = text->first_y + y1;
413 // get the first needed row
414 Row * row = text->getRowNearY(y_text);
415 // y_text is now the real beginning of the row
417 int y = y_text - text->first_y;
418 // y1 is now the real beginning of row on the screen
420 while (row != 0 && y < y2) {
421 LyXText::text_status st = text->status();
422 text->getVisibleRow(bv, y + yo,
423 xo, row, y + text->first_y);
424 internal = internal && (st != LyXText::CHANGED_IN_DRAW);
425 while (internal && text->status() == LyXText::CHANGED_IN_DRAW) {
426 text->fullRebreak(bv);
427 st = LyXText::NEED_MORE_REFRESH;
428 text->setCursor(bv, text->cursor.par(), text->cursor.pos());
429 text->status(bv, st);
430 text->getVisibleRow(bv, y + yo,
431 xo, row, y + text->first_y);
436 force_clear_ = false;
438 // maybe we have to clear the screen at the bottom
439 if ((y < y2) && text->bv_owner) {
440 workarea().getPainter().fillRectangle(0, y,
441 workarea().workWidth(), y2 - y,
447 void LyXScreen::drawOneRow(LyXText * text, BufferView * bv, Row * row,
448 int y_text, int yo, int xo)
450 int const y = y_text - text->first_y + yo;
452 if (((y + row->height()) > 0) &&
453 ((y - row->height()) <= static_cast<int>(workarea().workHeight()))) {
454 text->getVisibleRow(bv, y, xo, row, y + text->first_y);
456 force_clear_ = false;