Inheritance diagram for KLFContLatexPreview:

Collaboration diagram for KLFContLatexPreview:

Public Slots
void	setEnabled (bool enabled)
bool	setInput (const KLFBackend::klfInput &input)
bool	setSettings (const KLFBackend::klfSettings &settings, bool disableExtraFormats=true)
bool	setPreviewSize (const QSize &previewSize)
bool	setLargePreviewSize (const QSize &largePreviewSize)
Signals
void	previewReset ()
void	outputAvailable (const KLFBackend::klfOutput &output)
void	previewAvailable (const QImage &preview, const QImage &largePreview, const QImage &fullPreview)
void	previewImageAvailable (const QImage &preview)
void	previewLargeImageAvailable (const QImage &largePreview)
void	previewFullImageAvailable (const QImage &fullPreview)
void	previewError (const QString &errorString, int errorCode)
void	compiling (bool isCompiling)
Public Member Functions
	KLFContLatexPreview (KLFLatexPreviewThread *thread=NULL)
bool	enabled () const
KLFBackend::klfInput	intput () const
KLFBackend::klfSettings	settings () const
QSize	previewSize () const
QSize	largePreviewSize () const
void	setThread (KLFLatexPreviewThread *thread)
Properties
QSize	previewSize
QSize	largePreviewSize

Detailed Description

A helper that runs in a different thread that generates previews in real-time as user types text, without blocking the GUI.

.......... UPDATE DOC FOR NEW THREAD OBJECT STRUCTURE ........

Note:: returns (max.) three different image sizes set by setPreviewSize(), setLargePreviewSize() and the original image size. Setting an invalid size disables image generation of that particular preview size (might save resources by not resizing the image to that size).

Definition at line 152 of file klflatexpreviewthread.h.

Member Function Documentation

void KLFContLatexPreview::compiling ( bool isCompiling ) [signal]

Is emitted whenever there currently is a LaTeX formula compiling

void KLFContLatexPreview::outputAvailable ( const KLFBackend::klfOutput & output ) [signal]

Emitted when a preview was successfully generated (i.e., output.status==0). The full KLFBackend::klfOutput object is given here.

Note that this signal is emitted before the other preview***Available() functions.

void KLFContLatexPreview::previewAvailable	(	const QImage &	preview,
		const QImage &	largePreview,
		const QImage &	fullPreview
	)		`[signal]`

Emitted when a preview was successfully generated. All three images are given here (preview size, large preview size, original image)

void KLFContLatexPreview::previewError	(	const QString &	errorString,
		int	errorCode
	)		`[signal]`

Emitted when generation of the latex preview raised an error. See the error codes defined in klfbackend.h

void KLFContLatexPreview::previewFullImageAvailable ( const QImage & fullPreview ) [signal]

Emitted when a preview was successfully generated. The original image is given.

void KLFContLatexPreview::previewImageAvailable ( const QImage & preview ) [signal]

Emitted when a preview was successfully generated. Preview Size image. See also setPreviewSize().

void KLFContLatexPreview::previewLargeImageAvailable ( const QImage & largePreview ) [signal]

Emitted when a preview was successfully generated. Large preview size image. See also setLargePreviewSize().

void KLFContLatexPreview::previewReset ( ) [signal]

Emitted whenever there is no preview to generate (input latex string empty)

bool KLFContLatexPreview::setInput ( const KLFBackend::klfInput & input ) [slot]

Returns:: TRUE if the input was set, FALSE if current input is already equal to input. The thread will then take care to generate the corresponding preview and emit the previewAvailable() etc. signals.

Definition at line 459 of file klflatexpreviewthread.cpp.

bool KLFContLatexPreview::setLargePreviewSize ( const QSize & largePreviewSize ) [slot]

Returns:: TRUE if the largePreviewSize was set, FALSE if current large preview size is already equal to largePreviewSize

Definition at line 495 of file klflatexpreviewthread.cpp.

bool KLFContLatexPreview::setPreviewSize ( const QSize & previewSize ) [slot]

Returns:: TRUE if the previewSize was set, FALSE if current preview size is already equal to previewSize

Definition at line 487 of file klflatexpreviewthread.cpp.

bool KLFContLatexPreview::setSettings	(	const KLFBackend::klfSettings &	settings,
		bool	disableExtraFormats = `true`
	)		`[slot]`

Returns:: TRUE if the settings were set, FALSE if current settings are already equal to settings

Definition at line 470 of file klflatexpreviewthread.cpp.

The documentation for this class was generated from the following files: