kparts/Mainpage.dox

   1 /** @mainpage Framework for KDE Graphical Components
   2
   3 This library implements the framework for KDE parts, which are
   4 elaborate widgets with a user-interface defined in terms of actions
   5 (menu items, toolbar icons). See KParts::Part.
   6
   7 The library also provides a framework for applications that want to
   8 use parts. Such applications need to inherit their main window
   9 from KParts::MainWindow and provide a so-called shell GUI,
  10 which provides a basic skeleton GUI with part-independent functionality/actions.
  11
  12 Some KParts applications won't be specific to a given part, but expect
  13 to be able to embed, for instance, all types of viewers out there. For this
  14 the basic functionality of any viewer has been implemented in
  15 KParts::ReadOnlyPart, which viewer-like parts should inherit from.
  16 The same applies to KParts::ReadWritePart, which is for editor-like parts.
  17
  18 You can add actions to an existing KParts app from "outside", defining
  19 the code for those actions in a shared library. This mechanism is
  20 obviously called plugins, and implemented by KParts::Plugin.
  21
  22 For a complete, and very simple, example of how to use KParts to display
  23 any kind of file (i.e. making a generic viewer), see the documentation for
  24 KParts::ComponentFactory::createPartInstanceFromQuery.
  25
  26 @authors
  27 Simon Hausmann \<hausmann@kde.org\><br>
  28 David Faure \<faure@kde.org\><br>
  29 Kurt Granroth \<granroth@kde.org\><br>
  30 Michael Koch \<koch@kde.org\>
  31
  32 @maintainers
  33 [Unknown/None]
  34
  35 @licenses
  36 @lgpl
  37
  38 */
  39
  40 // DOXYGEN_REFERENCES = kdecore kdeui kio
  41 // DOXYGEN_SET_PROJECT_NAME = KParts
  42 // vim:ts=4:sw=4:expandtab:filetype=doxygen