You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
tdegraphics/kview/modules
Timothy Pearson 6adb71382c
Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4
12 years ago
..
browser Update XDG information in support of bug report 892. 13 years ago
effects Update XDG information in support of bug report 892. 13 years ago
presenter Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4 12 years ago
scale Rename KGlobal, KProcess, and KClipboard to avoid conflicts with KDE4 12 years ago
scanner Update XDG information in support of bug report 892. 13 years ago
template Update XDG information in support of bug report 892. 13 years ago
CMakeLists.txt [kdegraphics/kview] initial cmake support 14 years ago
Makefile.am Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 15 years ago
NAMING Copy the KDE 3.5 branch to branches/trinity for new KDE 3.5 features. 15 years ago
README Fix straggling XDG references missed in patch set from June 8, 2012. 13 years ago

README

How to write a plugin for KView
===============================

There are two different kinds of plugins for KView that you may write: KPart
plugins for KView or the KView KPart (KViewViewer).


Writing the Plugin
==================

You have to derive your plugin from KParts::Plugin and install the rc file under
the directory "data" (TDEDIR/share/apps/ usually)+"instancename/kpartplugins/"
(where instancename can be either kview or kviewviewer). If you install it under
kviewviewer the plugin will be loaded for the KPart (meaning it get's loaded in
e.g. Konqueror).  If you install it under kview it only get's loaded when
starting the KView application.

The parent that is passed on to your plugin will be a KImageViewer::Viewer
interface (which is also a KParts::ReadWritePart) if you make it a KViewViewer
plugin, else you'll be passed a pointer to KView (take a look at the template
plugin to see how to get to the KImageViewer::Viewer interface).


Plugin Desktop file
===================

Now you need to write a .desktop file for your plugin, containing the name,
a comment, author, email and plugin name.

Here's a start:
------------------------------------------------------------------------------
[Desktop Entry]
Name=Coolplugin
Comment=This is a very cool plugin doing foo and bar
Type=Plugin

[X-TDE Plugin Info]
Author=Matthias Kretz
Email=kretz@kde.org
PluginName=kviewcool
Version=1.0
------------------------------------------------------------------------------

The "PluginName" entry needs to be the same as the name attribut in your .rc
file (<kpartplugin name="kviewcool" library="kview_coolplugin">).


Examples
========

There are a few modules already in the original KView sources. Just take a look
at tdegraphics/kview/modules/*.