1 <!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 3.2 Final//EN">
3 * This file is part of the LibreOffice project.
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
9 * This file incorporates work covered by the following license notice:
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
21 <title>%PRODUCTNAME% %PRODUCT_RELEASE% SDK - Overview
</title>
22 <link rel=
"stylesheet" type=
"text/css" href=
"docs/sdk_styles.css"/>
23 <meta http-equiv=
"Content-Type" content=
"text/html;charset=utf-8"/>
26 <div id=
"BgContainer">
29 <a id=
"Logo" href=
"http://www.libreoffice.org/" title=
"Go to the Home of LibreOffice and the LibreOffice Community page"></a>
30 <p id=
"HeaderTagLine">%PRODUCTNAME% API Documentation
</p>
32 <div class=
"clear"></div>
34 <div class=
"typography">
35 <h1>%PRODUCTNAME% API Documentation
</h1>
36 <table class=
"table1" cellpadding=
"0">
38 <td colspan=
"3"><img class=
"nothing30" src=
"docs/images/nada.gif"/></td>
42 <table class=
"table2">
44 <td><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
46 <p>%PRODUCTNAME% %PRODUCT_RELEASE% software is a complete, feature-rich
47 office productivity suite that provides, in combination with this
48 SDK, all the essential tools for building and deploying custom
49 solutions that build on, or integrate with, the %PRODUCTNAME% %PRODUCT_RELEASE% suite
51 <p>The SDK is a development kit for %PRODUCTNAME% %PRODUCT_RELEASE%, which
52 eases the development of office components. It provides a set of
53 libraries, binaries, header, and IDL files which have final API's
54 and can only be extended with new functionality. This set of libraries
55 and binaries is the minimum set of functions needed to use system
56 abstraction for base functionality and for using UNO (Universal
57 Network Objects) component technology. The UNO component model is the
58 base of the whole Office API. The SDK provides everything necessary
59 to use the Office API from external programs (e.g. Java, C++) or to
60 extend the Office functionality with new components (e.g. new filter
61 components, CalcAddin functions). It is compatible over several
62 versions because the API remains unaffected and will only be extended
63 with new functions.
</p>
64 <p>The SDK provides the basic building blocks for external developers
65 to develop components in any language for which a binding exists.
66 Currently, there are language bindings for %PRODUCTNAME% %PRODUCT_RELEASE% Basic, Java, Python,
67 and different C++ compilers on different platforms, for %PRODUCTNAME% %PRODUCT_RELEASE%,
68 thus covering the most commonly used programming languages. There
69 will be no limit for office automation in heterogeneous environments.
70 Currently supported platforms of the SDK are Linux, Solaris (sparc,
71 x86), and Windows.
</p>
72 <p>The SDK also contains
<a href=
"%DOXYGEN_PREFIX0%/docs/idl/ref/index.html" title=
"link to the IDL reference documentation"> reference
</a> documentation
73 for the API and a complete
<a href=
"https://wiki.documentfoundation.org/Documentation/DevGuide" title=
"link to the Developer's Guide in the Wiki">Developer's Guide
</a> is available online in TDF Wiki, with
74 lots of examples, which introduce the API, explain the concepts behind
75 it, and make it possible for all users to quickly get started with
78 <td><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
81 <td><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
82 <td><img class=
"line" src=
"docs/images/sdk_line-1.gif"/></td>
83 <td><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
86 <td><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
88 <table class=
"table3">
90 <td colspan=
"4" class=
"head1">Content
</td>
93 <td colspan=
"4"><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
96 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
97 <td colspan=
"2"><a href=
"docs/install.html" title=
"link to the installation guide">Installation Guide
</a></td>
98 <td class=
"content70">An overview of all necessary
99 installation steps (e.g. environment variables) to use this SDK.
</td>
102 <td><img class=
"nothing10" src=
"docs/images/nada.gif"/></td>
103 <td colspan=
"3"><img class=
"line" src=
"docs/images/sdk_line-1.gif"/></td>
106 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
107 <td colspan=
"2"><a href=
"https://wiki.documentfoundation.org/Documentation/DevGuide" title=
"link to the Developer's Guide in the Wiki">Developer's Guide
</a></td>
108 <td class=
"content70">Detailed documentation, explaining the %PRODUCTNAME% %PRODUCT_RELEASE%
109 API and the concepts behind it, with a rich set of examples,
110 implemented mainly in Java. This documentation is online in TDF Wiki.
</td>
113 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
114 <td colspan=
"2"><a href=
"%DOXYGEN_PREFIX0%/docs/idl/ref/index.html" title=
"link to the IDL reference documentation">IDL Reference
</a></td>
115 <td class=
"content70">Complete %PRODUCTNAME% %PRODUCT_RELEASE% API reference.
</td>
118 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
119 <td colspan=
"2"><a href=
"%JAVADOC_PREFIX0%/docs/java/ref/index.html" title=
"link to the Java UNO runtime API reference documentation">Java UNO Runtime Reference
</a></td>
120 <td class=
"content70">Reference documentation of the Java UNO runtime API.
</td>
123 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
124 <td colspan=
"2"><a href=
"%DOXYGEN_PREFIX0%/docs/cpp/ref/index.html" title=
"link to the C++ API reference documentation">C++ Reference
</a></td>
125 <td class=
"content70">Reference documentation of the C++ UNO runtime and a
126 set of C/C++ base and helper functions and classes to abstract from
127 the system layer.
</td>
130 <td><img class=
"nothing10" src=
"docs/images/nada.gif"/></td>
131 <td colspan=
"3"><img class=
"line" src=
"docs/images/sdk_line-1.gif"/></td>
134 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
135 <td colspan=
"2"><a href=
"docs/tools.html" title=
"link to the tools overview page">Development Tools
</a></td>
136 <td class=
"content70">Overview and a short description of the UNO
137 development tools.
</td>
140 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
141 <td colspan=
"2"><a href=
"examples/examples.html" title=
"link to the examples overview page">Examples
</a></td>
142 <td class=
"content70">A collection of examples in different
143 programming languages (Java, Python, C++, Basic, OLE, CLI).
</td>
146 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
147 <td colspan=
"2"><a href=
"https://gerrit.libreoffice.org/gitweb?p=sdk-examples.git;a=blob;f=README;hb=HEAD" title=
"link to the git repository README file">Additional Examples
</a></td>
148 <td class=
"content70">A git repository with additional examples
149 from various contributors:
<code>git clone
150 https://gerrit.libreoffice.org/sdk-examples
</code></td>
153 <td><img class=
"nothing10" src=
"docs/images/nada.gif"/></td>
154 <td colspan=
"3"><img class=
"line" src=
"docs/images/sdk_line-1.gif"/></td>
157 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
158 <td colspan=
"2"><a href=
"http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office" title=
"link to the OASIS Open Office XML Format TC (online)">OASIS Open Document Format for Office Applications (OpenDocument) TC
</a></td>
159 <td class=
"content70">Link to the OASIS Open Document Format for
160 Office Applications (OpenDocument) Technical Committee where you
161 can find the latest information about the OASIS Open Document XML
162 file format which is the default document format
163 for %PRODUCTNAME% %PRODUCT_RELEASE%.
</td>
166 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
167 <td colspan=
"2"><a href=
"http://xml.openoffice.org/xml_specification.pdf" title=
"link to the OpenOffice.org XML File Format Specification">OpenOffice.org XML File Format
</a></td>
168 <td class=
"content70">Specification of the initial OpenOffice.org XML File Format.
</td>
171 <td><img class=
"nothing10" src=
"docs/images/nada.gif"/></td>
172 <td colspan=
"3"><img class=
"line" src=
"docs/images/sdk_line-1.gif"/></td>
175 <td class=
"content4"><img src=
"docs/images/arrow-1.gif"/></td>
176 <td colspan=
"2"><a href=
"share/readme/LICENSE.html" title=
"link to the SDK license file">License
</a></td>
177 <td class=
"content70">The license for the %PRODUCTNAME% %PRODUCT_RELEASE% SDK.
</td>
181 <td><img class=
"nothing8" src=
"docs/images/nada.gif"/></td>
189 <div id=
"FooterText">
191 Copyright
© 2000–
2024 LibreOffice contributors. All rights reserved.
193 LibreOffice was created by The Document Foundation,
194 based on OpenOffice.org.
196 The Document Foundation acknowledges all community members, please find more info
<a href=
"https://www.libreoffice.org/about-us/credits/" target=
"_blank">at our website
</a>.
202 <a href=
"http://www.documentfoundation.org/privacy" target=
"_blank">Privacy Policy
</a> |
<a href=
"http://www.documentfoundation.org/imprint" target=
"_blank">Impressum (Legal Info)
</a>
203 | Copyright information: The source code of LibreOffice is licensed under the Mozilla Public License v2.0 (
<a href=
"http://www.libreoffice.org/download/license/" target=
"_blank">MPLv2
</a>).
"LibreOffice" and
"The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our
<a href=
"http://wiki.documentfoundation.org/TradeMark_Policy" target=
"_blank">trademark policy
</a>.