2 * \file render_preview.C
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Angus Leeming
8 * Full author contact details are available in file CREDITS.
13 #include "insets/render_preview.h"
14 #include "insets/inset.h"
16 #include "BufferView.h"
17 #include "dimension.h"
20 #include "metricsinfo.h"
22 #include "frontends/font_metrics.h"
23 #include "frontends/Painter.h"
25 #include "graphics/PreviewImage.h"
26 #include "graphics/PreviewLoader.h"
27 #include "graphics/Previews.h"
29 #include "support/lstrings.h"
31 #include <boost/bind.hpp>
35 namespace graphics = lyx::graphics;
36 namespace support = lyx::support;
39 bool RenderPreview::activated()
41 return graphics::Previews::activated();
45 RenderPreview::RenderPreview()
50 RenderPreview::RenderPreview(RenderPreview const & other)
52 boost::signals::trackable(),
53 snippet_(other.snippet_),
58 RenderBase * RenderPreview::clone() const
60 return new RenderPreview(*this);
66 string const statusMessage(BufferView const * bv, string const & snippet)
68 BOOST_ASSERT(bv && bv->buffer());
70 Buffer const & buffer = *bv->buffer();
71 graphics::Previews const & previews = graphics::Previews::get();
72 graphics::PreviewLoader const & loader = previews.loader(buffer);
73 graphics::PreviewLoader::Status const status = loader.status(snippet);
77 case graphics::PreviewLoader::InQueue:
78 case graphics::PreviewLoader::Processing:
79 message = _("Preview loading");
81 case graphics::PreviewLoader::Ready:
82 message = _("Preview ready");
84 case graphics::PreviewLoader::NotFound:
85 message = _("Preview failed");
95 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
98 dim.asc = pimage_->ascent();
99 dim.des = pimage_->descent();
100 dim.wid = pimage_->width();
105 LyXFont font(mi.base.font);
106 font.setFamily(LyXFont::SANS_FAMILY);
107 font.setSize(LyXFont::SIZE_FOOTNOTE);
109 font_metrics::width(statusMessage(mi.base.bv, snippet_),
117 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
119 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
120 Buffer const & buffer = *pi.base.bv->buffer();
121 startLoading(buffer);
123 if (previewReady()) {
124 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
125 *(pimage_->image()));
129 pi.pain.rectangle(x + InsetOld::TEXT_TO_INSET_OFFSET,
131 dim_.wid - 2 * InsetOld::TEXT_TO_INSET_OFFSET,
135 LyXFont font(pi.base.font);
136 font.setFamily(LyXFont::SANS_FAMILY);
137 font.setSize(LyXFont::SIZE_FOOTNOTE);
138 pi.pain.text(x + InsetOld::TEXT_TO_INSET_OFFSET + 6,
139 y - font_metrics::maxAscent(font) - 4,
140 statusMessage(pi.base.bv, snippet_), font);
144 boost::signals::connection RenderPreview::connect(slot_type const & slot)
146 return preview_ready_signal_.connect(slot);
150 void RenderPreview::startLoading(Buffer const & buffer) const
152 if (!activated() && !snippet_.empty())
155 graphics::Previews & previews = graphics::Previews::get();
156 graphics::PreviewLoader & loader = previews.loader(buffer);
157 loader.startLoading();
161 void RenderPreview::addPreview(string const & latex_snippet,
162 Buffer const & buffer)
167 graphics::Previews & previews = graphics::Previews::get();
168 graphics::PreviewLoader & loader = previews.loader(buffer);
169 addPreview(latex_snippet, loader);
173 void RenderPreview::addPreview(string const & latex_snippet,
174 graphics::PreviewLoader & ploader)
179 snippet_ = support::trim(latex_snippet);
181 if (snippet_.empty())
184 pimage_ = ploader.preview(snippet_);
188 // If this is the first time of calling, connect to the
189 // PreviewLoader signal that'll inform us when the preview image
190 // is ready for loading.
191 if (!ploader_connection_.connected()) {
192 ploader_connection_ = ploader.connect(
193 boost::bind(&RenderPreview::imageReady, this, _1));
196 ploader.add(snippet_);
200 void RenderPreview::removePreview(Buffer const & buffer)
202 if (snippet_.empty())
205 graphics::Previews & previews = graphics::Previews::get();
206 graphics::PreviewLoader & loader = previews.loader(buffer);
207 loader.remove(snippet_);
213 bool RenderPreview::previewReady() const
215 return pimage_ ? pimage_->image() : false;
219 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
221 // Check the current snippet is the same as that previewed.
222 if (snippet_ != pimage.snippet())
226 preview_ready_signal_();
230 void RenderMonitoredPreview::setAbsFile(string const & file)
232 monitor_.reset(file);
236 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
238 RenderPreview::draw(pi, x, y);
244 boost::signals::connection
245 RenderMonitoredPreview::fileChanged(slot_type const & slot)
247 return monitor_.connect(slot);