kdelibs/kdewidgets/README

KDE Custom Widgets for Katie Designer
====================================


Summary:
========

This directory contains KDE custom widgets for Katie Designer. The plugins use
the QWidget plugin API of Katie >= 4.13, don't expect it to work with any other
versions of Katie.

HOWTO Add Widgets:
==================
Just add new widgets to kde.widgets like this:
[ClassName]
IncludeFile=myheader.h
IconSet=mycoolwidget.png
ToolTip=My Cool Widget
WhatsThis=Long description of my cool widget
ConstructorArgs=(parent, name, otherNeccessaryArg)
IsContainer=true
Group=MyWidgetCollection

Everything but [ClassName] is optional.
IncludeFile defaults to classname.h (all lowercase)
IconSet defaults to classname.png (all lowercase)
ToolTip defaults to ClassName
WhatsThis defaults to ClassName
ConstructorArgs=(parent, name)
IsContainer defaults to false - note, any value except an empty one is
                                interpreted as true, even if the value
                                is "false" :) So, if the widget is not a
                                container, just omit this line.
Group defaults to "KDE"

Don't forget to add an icon to the pics directory.  Try to make it look similar
to the other icons and be the same size.

There are some global options that you can have.

[Global]
Includes=foo.h,bar.h
Init=new InitCode();
Destroy=delete object;
PluginName=MyPlugin

PluginName overrides the passed in value at the command line and is optional.
Init and Destroy are both optional arguments that can be used for custom build
up and tear down code.

Have fun!


Ian Reinhart Geiser <geiseri@kde.org>
Daniel Molkentin <molkentin@kde.org>
Malte Starostik <malte@kde.org>