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"
28 #include "insets/updatableinset.h"
30 #include "metricsinfo.h"
32 // Splash screen-specific stuff
36 #include "graphics/GraphicsLoader.h"
37 #include "graphics/GraphicsImage.h"
39 #include "support/filetools.h" // LibFileSearch
41 #include <boost/utility.hpp>
42 #include <boost/bind.hpp>
43 #include <boost/signals/trackable.hpp>
45 using namespace lyx::support;
53 class SplashScreen : boost::noncopyable, boost::signals::trackable {
55 /// This is a singleton class. Get the instance.
56 static SplashScreen const & get();
58 lyx::graphics::Image const * image() const { return loader_.image(); }
60 string const & text() const { return text_; }
62 LyXFont const & font() const { return font_; }
64 void connect(lyx::graphics::Loader::slot_type const & slot) const {
65 loader_.connect(slot);
68 void startLoading() const {
69 if (loader_.status() == lyx::graphics::WaitingToLoad)
70 loader_.startLoading();
74 /** Make the c-tor private so we can control how many objects
80 lyx::graphics::Loader loader_;
81 /// The text to be written on top of the pixmap
88 SplashScreen const & SplashScreen::get()
90 static SplashScreen singleton;
95 SplashScreen::SplashScreen()
96 : text_(lyx_version ? lyx_version : "unknown")
98 if (!lyxrc.show_banner)
101 string const file = LibFileSearch("images", "banner", "ppm");
105 // The font used to display the version info
106 font_.setFamily(LyXFont::SANS_FAMILY);
107 font_.setSeries(LyXFont::BOLD_SERIES);
108 font_.setSize(LyXFont::SIZE_NORMAL);
109 font_.setColor(LColor::yellow);
111 // Load up the graphics file
118 LyXScreen::LyXScreen()
119 : cursor_visible_(false), greyed_out_(true)
121 // Start loading the pixmap as soon as possible
122 if (lyxrc.show_banner) {
123 SplashScreen const & splash = SplashScreen::get();
124 splash.connect(boost::bind(&LyXScreen::greyOut, this));
125 splash.startLoading();
130 LyXScreen::~LyXScreen()
135 void LyXScreen::showCursor(BufferView & bv)
137 // this is needed to make sure we copy back the right
138 // pixmap on the hide for the Qt frontend
139 lyx_gui::sync_events();
147 Cursor_Shape shape = BAR_SHAPE;
149 LyXText const & text = *bv.getLyXText();
150 LyXFont const & realfont = text.real_current_font;
151 BufferParams const & bp = bv.buffer()->params;
152 bool const samelang = realfont.language() == bp.language;
153 bool const isrtl = realfont.isVisibleRightToLeft();
155 if (!samelang || isrtl != bp.language->RightToLeft()) {
158 shape = REVERSED_L_SHAPE;
161 // The ERT language hack needs fixing up
162 if (realfont.language() == latex_language)
165 int ascent = font_metrics::maxAscent(realfont);
166 int descent = font_metrics::maxDescent(realfont);
167 int h = ascent + descent;
170 int const top_y = bv.top_y();
172 if (bv.theLockingInset()) {
173 // Would be nice to clean this up to make some understandable sense...
174 UpdatableInset * inset = bv.theLockingInset();
175 inset->getCursor(bv, x, y);
177 // Non-obvious. The reason we have to have these
178 // extra checks is that the ->getCursor() calls rely
179 // on the inset's own knowledge of its screen position.
180 // If we scroll up or down in a big enough increment, the
181 // inset->draw() is not called: this doesn't update
182 // inset.top_baseline, so getCursor() returns an old value.
185 inset->getCursorPos(&bv, bx, by);
186 by += inset->insetInInsetY() + bv.text->cursor.y();
189 if (by > top_y + workarea().workHeight())
192 x = bv.text->cursor.x();
193 y = bv.text->cursor.y();
199 // if it doesn't fit entirely on the screen, don't try to show it
200 if (y < 0 || y + h > workarea().workHeight())
203 cursor_visible_ = true;
204 showCursor(x, y, h, shape);
208 void LyXScreen::hideCursor()
210 if (!cursor_visible_)
213 cursor_visible_ = false;
218 void LyXScreen::toggleCursor(BufferView & bv)
227 bool LyXScreen::fitManualCursor(BufferView * bv, LyXText *,
228 int /*x*/, int y, int asc, int desc)
230 int const vheight = workarea().workHeight();
231 int const topy = bv->top_y();
235 if (y + desc - topy >= vheight)
236 newtop = y - 3 * vheight / 4; // the scroll region must be so big!!
237 else if (y - asc < topy && topy > 0)
238 newtop = y - vheight / 4;
240 newtop = max(newtop, 0); // can newtop ever be < 0? (Lgb)
250 unsigned int LyXScreen::topCursorVisible(LyXText * text)
252 LyXCursor const & cursor = text->cursor;
253 int top_y = text->bv()->top_y();
255 unsigned int const vheight = workarea().workHeight();
257 RowList::iterator row = text->cursorRow();
259 if (int(cursor.y() - row->baseline() + row->height() - top_y) >= vheight) {
260 if (row->height() < vheight
261 && row->height() > vheight / 4) {
264 - row->baseline() - vheight;
266 // scroll down, the scroll region must be so big!!
267 newtop = cursor.y() - vheight / 2;
270 } else if (int(cursor.y() - row->baseline()) < top_y && top_y > 0) {
271 if (row->height() < vheight && row->height() > vheight / 4) {
272 newtop = cursor.y() - row->baseline();
275 newtop = cursor.y() - vheight / 2;
276 newtop = min(newtop, top_y);
280 return max(newtop, 0);
284 bool LyXScreen::fitCursor(LyXText * text, BufferView * bv)
286 // Is a change necessary?
287 int const newtop = topCursorVisible(text);
288 bool const result = (newtop != bv->top_y());
294 void LyXScreen::redraw(BufferView & bv)
296 greyed_out_ = !bv.text;
303 workarea().getPainter().start();
307 int const y = paintText(bv);
309 // maybe we have to clear the screen at the bottom
310 int const y2 = workarea().workHeight();
311 if (y < y2 && !bv.text->isInInset()) {
312 workarea().getPainter().fillRectangle(0, y,
313 workarea().workWidth(), y2 - y,
317 expose(0, 0, workarea().workWidth(), workarea().workHeight());
319 workarea().getPainter().end();
323 void LyXScreen::greyOut()
328 workarea().getPainter().start();
330 workarea().getPainter().fillRectangle(0, 0,
331 workarea().workWidth(),
332 workarea().workHeight(),
335 // Add a splash screen to the centre of the work area
336 SplashScreen const & splash = SplashScreen::get();
337 lyx::graphics::Image const * const splash_image = splash.image();
339 int const w = splash_image->getWidth();
340 int const h = splash_image->getHeight();
342 int x = (workarea().workWidth() - w) / 2;
343 int y = (workarea().workHeight() - h) / 2;
345 workarea().getPainter().image(x, y, w, h, *splash_image);
350 workarea().getPainter().text(x, y, splash.text(), splash.font());
352 expose(0, 0, workarea().workWidth(), workarea().workHeight());
353 workarea().getPainter().end();