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>
36 namespace graphics = lyx::graphics;
37 namespace support = lyx::support;
40 bool RenderPreview::activated()
42 return graphics::Previews::activated();
46 RenderPreview::RenderPreview()
51 RenderPreview::RenderPreview(RenderPreview const & other)
53 boost::signals::trackable(),
54 snippet_(other.snippet_),
59 auto_ptr<RenderBase> RenderPreview::clone() const
61 return auto_ptr<RenderBase>(new RenderPreview(*this));
67 string const statusMessage(BufferView const * bv, string const & snippet)
69 BOOST_ASSERT(bv && bv->buffer());
71 Buffer const & buffer = *bv->buffer();
72 graphics::Previews const & previews = graphics::Previews::get();
73 graphics::PreviewLoader const & loader = previews.loader(buffer);
74 graphics::PreviewLoader::Status const status = loader.status(snippet);
78 case graphics::PreviewLoader::InQueue:
79 case graphics::PreviewLoader::Processing:
80 message = _("Preview loading");
82 case graphics::PreviewLoader::Ready:
83 message = _("Preview ready");
85 case graphics::PreviewLoader::NotFound:
86 message = _("Preview failed");
96 void RenderPreview::metrics(MetricsInfo & mi, Dimension & dim) const
99 dim.asc = pimage_->ascent();
100 dim.des = pimage_->descent();
101 dim.wid = pimage_->width();
106 LyXFont font(mi.base.font);
107 font.setFamily(LyXFont::SANS_FAMILY);
108 font.setSize(LyXFont::SIZE_FOOTNOTE);
110 font_metrics::width(statusMessage(mi.base.bv, snippet_),
118 void RenderPreview::draw(PainterInfo & pi, int x, int y) const
120 BOOST_ASSERT(pi.base.bv && pi.base.bv->buffer());
121 Buffer const & buffer = *pi.base.bv->buffer();
122 startLoading(buffer);
124 if (previewReady()) {
125 pi.pain.image(x, y - dim_.asc, dim_.wid, dim_.height(),
126 *(pimage_->image()));
130 pi.pain.rectangle(x + InsetOld::TEXT_TO_INSET_OFFSET,
132 dim_.wid - 2 * InsetOld::TEXT_TO_INSET_OFFSET,
136 LyXFont font(pi.base.font);
137 font.setFamily(LyXFont::SANS_FAMILY);
138 font.setSize(LyXFont::SIZE_FOOTNOTE);
139 pi.pain.text(x + InsetOld::TEXT_TO_INSET_OFFSET + 6,
140 y - font_metrics::maxAscent(font) - 4,
141 statusMessage(pi.base.bv, snippet_), font);
145 boost::signals::connection RenderPreview::connect(slot_type const & slot)
147 return preview_ready_signal_.connect(slot);
151 void RenderPreview::startLoading(Buffer const & buffer) const
153 if (!activated() && !snippet_.empty())
156 graphics::Previews & previews = graphics::Previews::get();
157 graphics::PreviewLoader & loader = previews.loader(buffer);
158 loader.startLoading();
162 void RenderPreview::addPreview(string const & latex_snippet,
163 Buffer const & buffer)
168 graphics::Previews & previews = graphics::Previews::get();
169 graphics::PreviewLoader & loader = previews.loader(buffer);
170 addPreview(latex_snippet, loader);
174 void RenderPreview::addPreview(string const & latex_snippet,
175 graphics::PreviewLoader & ploader)
180 snippet_ = support::trim(latex_snippet);
182 if (snippet_.empty())
185 pimage_ = ploader.preview(snippet_);
189 // If this is the first time of calling, connect to the
190 // PreviewLoader signal that'll inform us when the preview image
191 // is ready for loading.
192 if (!ploader_connection_.connected()) {
193 ploader_connection_ = ploader.connect(
194 boost::bind(&RenderPreview::imageReady, this, _1));
197 ploader.add(snippet_);
201 void RenderPreview::removePreview(Buffer const & buffer)
203 if (snippet_.empty())
206 graphics::Previews & previews = graphics::Previews::get();
207 graphics::PreviewLoader & loader = previews.loader(buffer);
208 loader.remove(snippet_);
214 bool RenderPreview::previewReady() const
216 return pimage_ ? pimage_->image() : false;
220 void RenderPreview::imageReady(graphics::PreviewImage const & pimage)
222 // Check the current snippet is the same as that previewed.
223 if (snippet_ != pimage.snippet())
227 preview_ready_signal_();
231 void RenderMonitoredPreview::setAbsFile(string const & file)
233 monitor_.reset(file);
237 void RenderMonitoredPreview::draw(PainterInfo & pi, int x, int y) const
239 RenderPreview::draw(pi, x, y);
245 boost::signals::connection
246 RenderMonitoredPreview::fileChanged(slot_type const & slot)
248 return monitor_.connect(slot);