kdewidgets/README

   1 KDE Custom Widgets for Qt Designer 2
   2 ====================================
   3
   4
   5 Summary:
   6 ========
   7
   8 This directory contains KDE custom widgets for Qt Designer which comes with
   9 Qt 4. Just make sure that QT_PLUGIN_PATH includes
  10 $KDEDIR/lib/kde4/plugins . With the KDE build system nothing special
  11 (i.e. editing the plugin path) is needed, as uic will automatically be
  12 called with -L <path to the kdewidgets plugin> .
  13
  14 This plugin uses the QWidget plugin API of Qt >= 4.0
  15 Don't expect it to work with any other versions of Qt.
  16
  17
  18 Known Bugs:
  19 ===========
  20
  21 Designer crashes when using widgets that use the kapp pointer.
  22
  23 HOWTO Add Widgets:
  24 ==================
  25 Just add new widgets to kde.widgets like this:
  26 [ClassName]
  27 IncludeFile=myheader.h
  28 IconSet=mycoolwidget.png
  29 ToolTip=My Cool Widget
  30 WhatsThis=Long description of my cool widget
  31 ConstructorArgs=(parent, name, otherNeccessaryArg)
  32 IsContainer=true
  33 Group=MyWidgetCollection
  34
  35 Everything but [ClassName] is optional.
  36 IncludeFile defaults to classname.h (all lowercase)
  37 IconSet defaults to classname.png (all lowercase)
  38 ToolTip defaults to ClassName
  39 WhatsThis defaults to ClassName
  40 ConstructorArgs=(parent, name)
  41 IsContainer defaults to false - note, any value except an empty one is
  42                                 interpreted as true, even if the value
  43                                 is "false" :) So, if the widget is not a
  44                                 container, just omit this line.
  45 Group defaults to "KDE"
  46
  47 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.
  48
  49 There are some global options that you can have.
  50
  51 [Global]
  52 Init=new InitCode();
  53 Destroy= delete object;
  54 PluginName=MyPlugin
  55
  56 PluginName overrides the passed in value at the command line and is optional.
  57 Init and Destroy are both optional arguments that can be used for custom build
  58 up and tear down code.
  59
  60 Have fun!
  61
  62
  63 Ian Reinhart Geiser <geiseri@kde.org>
  64 Daniel Molkentin <molkentin@kde.org>
  65 Malte Starostik <malte@kde.org>