Warning, /graphics/kst-plot/devel-docs/plugins/StartHere is written in an unsupported language. File is not indexed.

0001 How To Make Kst Plugins
0002 -----------------------
0003 
0004 KstPlugins are modules that can be loaded into Kst to provide additional
0005 functionality.
0006 
0007 
0008 KstPlugins are presently implemented as:
0009 - KstDataSource plugins
0010         + These provide the ability to read in different file formats or data
0011           "sources".
0012 - KstDataObject plugins
0013         + These are advanced data plugins that provide their own configuration dialog.
0014 - KstBasicPlugin plugins
0015         + These are basic data plugins that inherit KstDataObject plugins, but
0016           are provided with a default configuration dialog.
0017 - KstCPlugin plugins
0018         + These are deprecated data plugins replaced by KstBasicPlugins.
0019 - Kst Extensions
0020         + These allow entire subsystems to be added to Kst without touching
0021           the Kst core.
0022 
0023 
0024 All KstPlugins except KstCPlugins are KDE style plugins and therefore require
0025 a .desktop file and must be installed in the KDE standard plugins directories.
0026 They derive from the base servicetype "Kst/Plugin".  This base type includes
0027 two kst specific properties:
0028 
0029 X-Kst-Plugin-Author: A string containing the name of the author.
0030 X-Kst-Plugin-Version: A string containing the version of the plugin.
0031 
0032 ,desktop files also have additional properties.  Here are the required ones:
0033 
0034 Name: A string containing the name of the plugin.  For instance, "My Plugin".
0035 ServiceTypes: For KstDataSource this is "Kst Data Source" and for KstDataObjects this is "Kst Data Object" etc, etc...
0036 X-KDE-ModuleType: This should be set to "Plugin".
0037 X-KDE-Library: The library name.  This is not the filename, but a name
0038                that is used to construct it.  For instance, it could
0039                be "kstobject_myplugin" where the library might be named
0040                "kstobject_myplugin.so".  This must also be a legal C
0041                variable name as it is used to construct the function
0042                names inside the library.  Note: for KstDataSource plugins the
0043                name here is shortened even further: the actual library name is
0044                kstdata_myplugin.so, but you should put "myplugin" as the value
0045                for this property.
0046 
0047 Some other .desktop properties are also common to all plugins:
0048 
0049 Comment: The description of the plugin.
0050 
0051 To find out more about creating these plugins look in the respective file for
0052 the type of plugin you are interested in creating.