• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • TDevelop API Documentation
 

TDevelop API Documentation

The TDevelop API Documentation

TDevelop is an easy to use IDE (Integrated Development Environment) for developing applications under X11.

Introduction

This document is targeted at all those that want to add or improve TDevelop's source code. If you are instead looking for a user manual, just go to the help menu of your TDevelop and select TDevelop handbook. This documentation contains the TDevelop online class reference for the current development version of TDevelop. Additionally, you can subscribe or read the mailing list for any additions and/or modifications to the API.

An on-line, updated every 24H, html version of this documentation can be found at: http://www.kdevelop.org/HEAD/doc/api/html/index.html

More information about the TDevelop architecture in form of tutorials, HOWTOs, and FAQs can be found at the TDevelop website.

Current Status

Here you can see the current requirements and the features. There is also a Programming Languages Support Status (doc/api/LangSupportStatus.dox file) page and a Editors Support Status (doc/api/EditorsSupportStatus.dox file) page.

How to expand TDevelop

First of all read the TDevelop 3 Architecture (doc/api/Architecture.dox file) then you can find more information on how to expand TDevelop:

  • How to extend TDevelop via plugins (doc/api/HowToAddPlugins.dox file)
  • How to add support for a programming language (doc/api/HowToAddProgrammingLanguages.dox file)
  • How to add application templates to the application wizard part (doc/api/HowToAddApplicationTemplates.dox file)
  • How to add file templates to the file create part (doc/api/HowToAddFileTemplates.dox file)
  • How to add a generic build tool plugins to the generic build tool part (doc/api/HowToAddGenericBuildTools.dox file)

Additionally you may also want to find out How to document TDevelop parts (doc/api/HowToDocument.dox file).

Planned tasks

Here is a priority ordered list:

  1. High priority tasks! (doc/api/HighPriTasks.dox file)
  2. fix the dispersed fixme
  3. reported bugs in bugzilla database
  4. fix the bugs in the bug
  5. fix the dispersed todo all over the code.

There are some unmaintained parts in TDevelop. You migth want to "adopt" one. :)
There is also Future tasks and ideas for the next release of TDevelop (doc/api/FutureTasks.dox file). Put all ideas for the future TDevelop releases there. It is also a good place to comment on those ideas.

Misc

  • authors
  • maintainers
  • FAQ
  • deprecated

Miscellaneous libraries included in TDevelop

  • TDevelop Property Editor library description

How to build a local copy of this documentation

This documentation is very large and changes with every cvs commit, therefore is not available for download. To build your local copy of this documentation you have two choices, depending on your system configuration.

  • If you have doxygen >= 1.3.4 , PHP >= 4.10 and a local running webserver then
    • make apidox
    • make install-apidox (as root)
  • If you have an older system then
    • setenv TDEDIR=/location_of_your_kde_instalation
    • setenv QTDIR=/location_of_your_qt_instalation
    • doxygen Doxyfile
    • make install-apidox (as root)

The advantage of the first method is that you'll get a search engine in your documentation if you read your documentation using your local webserver.

License

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; For details see http://www.gnu.org/copyleft/fdl.html .

TDevelop API Documentation

Skip menu "TDevelop API Documentation"
  • Main Page
  • Related Pages

TDevelop API Documentation

Skip menu "TDevelop API Documentation"
  • buildtools
  •   lib
  •     base
  •     parsers
  •       autotools
  •       qmake
  •     widgets
  •   api
  • languages
  •   lib
  •     debugger
  •     designer_integration
  •     interfaces
  • lib
  •   catalog
  •   interfaces
  •     extensions
  •     external
  •     extras
  •   util
  •   widgets
  •     propeditor
  • parts
  •   documentation
  •     interfaces
  • src
  •   profileengine
  •     lib
Generated for TDevelop API Documentation by doxygen 1.8.13
This website is maintained by Timothy Pearson.