KisPreviewWidget Class Reference

#include <kis_previewwidget.h>

Inherits PreviewWidgetBase.

Public Slots
void	slotSetDevice (KisPaintDeviceSP dev)
void	slotSetAutoUpdate (bool set)
void	setPreviewDisplayed (bool v)
void	needUpdate ()

Signals
void	updated ()

Public Member Functions
	KisPreviewWidget (TQWidget *parent=0, const char *name=0)
bool	getAutoUpdate () const
void	wheelEvent (TQWheelEvent *e)
void	runFilter (KisFilter *filter, KisFilterConfiguration *config)

Detailed Description

A widget that can be used by plugins to show a preview of the effect of the plugin to the user.

This is a convenience class thand handily packs a source and a preview view together with a zoom button. It would be nice if every plugin that needs to show a preview (maybe not those that create a new image) would use this. This can prevent the distracting effect the GIMP has with a different preview for almost every filter.

Definition at line 48 of file kis_previewwidget.h.

Constructor & Destructor Documentation

KisPreviewWidget()

KisPreviewWidget::KisPreviewWidget	(	TQWidget *	parent = 0,
		const char *	name = 0
	)

Constructs the widget.

Definition at line 68 of file kis_previewwidget.cpp.

~KisPreviewWidget()

KisPreviewWidget::~KisPreviewWidget ( )

virtual

Definition at line 124 of file kis_previewwidget.cpp.

Member Function Documentation

getAutoUpdate()

bool KisPreviewWidget::getAutoUpdate

(

)

const

returns if the preview is automatically updated

Definition at line 228 of file kis_previewwidget.cpp.

needUpdate

void KisPreviewWidget::needUpdate ( )

slot

use to indicate that the preview need to be updated.

Definition at line 222 of file kis_previewwidget.cpp.

runFilter()

void KisPreviewWidget::runFilter	(	KisFilter *	filter,
		KisFilterConfiguration *	config
	)

Instructs the KisPreviewWidget to eventually update the preview.

KisPreviewWidget delays the actual running of the filter for 500ms so if the user is changing a configuration setting, it won't run multiple time.

Parameters

filter

to run on the image @config to use when filtering.

Definition at line 302 of file kis_previewwidget.cpp.

setPreviewDisplayed

void KisPreviewWidget::setPreviewDisplayed ( bool  v )

slot

Toggle between display preview and display original.

Definition at line 207 of file kis_previewwidget.cpp.

slotSetAutoUpdate

void KisPreviewWidget::slotSetAutoUpdate ( bool  set )

slot

Enables or disables the automatically updating of the preview.

Definition at line 193 of file kis_previewwidget.cpp.

slotSetDevice

void KisPreviewWidget::slotSetDevice ( KisPaintDeviceSP  dev )

slot

Sets the preview to use the layer specified as argument.

Definition at line 135 of file kis_previewwidget.cpp.

updated

void KisPreviewWidget::updated ( )

signal

This is emitted when the position or zoom factor of the widget has changed.

wheelEvent()

void KisPreviewWidget::wheelEvent

(

TQWheelEvent *

e

)

Definition at line 197 of file kis_previewwidget.cpp.

---

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

• kis_previewwidget.h
• kis_previewwidget.cpp