API
| Project Lead | Jürgen Schmidt |
| Co-Lead | Steffen Grund |
The OpenOffice.org API Wiki. API stands for Application programming interface.
OpenOffice.org offers a language independent API which allows to program the office in different programming languages (e.g. C++, Java, Python, CLI, StarBasic, ...). It allows to use OpenOffice.org as service provider in other applications, extend it with new functionality or simply customize and control OpenOffice.org.
The API is based on the UNO component technology and that makes it really flexible and makes it possible to use one and the same API from different programming languages, all languages which are supported by UNO.
Contents
API Reference
We try to provide always the latest version of a generated API IDL reference documentation online. You can find it on the api.openoffice.org on left side under IDL reference. Maybe interesting for you are the two links Use' and DevGuide in the top menubar of a single type documentation page.
- Use: links to an overview page where you can find all places where this type is used or referenced in the API and in the Developer's Guide
- DevGuide: links to a sub-section of the documentation page where you can find cross references into the Developer's Guide where this type is described in detail and especially the concepts behind.
Also of interest here are the online available reference documentation of the UNO runtime for C++ and Java.
Supported Languages
Code Snippets
The idea of the Code Snippet Base is to provide a collection of small code snippets for various simple or even more complex API use cases. Ideally all snippets would be available in all supported languages. The snippet base is organized in categories for the main applications or office wide. Each category itself is divided in language sections so that it should be easy to find an appropriate snippet for your specific use case.
Things in progress - Efforts
- Groovy UNO Extension
- OpenOffice CMake Integration
- OpenOffice Eclipse Integration
- OpenOffice Gradle Integration
- OpenOffice Maven2 Integration
- OpenOffice NetBeans Integration
Things to be Done
- API/To-Dos - An overview of API To-Dos where you will hopefully find something interesting if you plan to support the API project.
FAQ
- API/FAQ - A list of frequently asked questions related to the API
