summaryrefslogtreecommitdiffstats
path: root/odk/index.html
blob: 6cc5beaae2c9ec45af036f6e38c7da39e41d1771 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!--
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
-->
<html>
<head>
  <title>LibreOffice %PRODUCT_RELEASE% SDK - Overview</title>
  <link rel="stylesheet" type="text/css" href="docs/sdk_styles.css"/>
  <meta http-equiv="Content-Type" content="text/html;charset=utf-8"/>
</head>
<body>
<div id="BgContainer">
    <div id="Container">
        <div id="TopHeader">
            <a id="Logo" href="http://www.libreoffice.org/" title="Go to the Home of LibreOffice and the LibreOffice Community page"></a>
            <p id="HeaderTagLine">LibreOffice API Documentation</p>
         </div>
         <div class="clear"></div>
    <div id="Layout">
    <div class="typography">
        <h1>LibreOffice API Documentation</h1>
<table class="table1" cellpadding="0">
  <tr>
    <td colspan="3"><img  class="nothing30" src="docs/images/nada.gif"/></td>
  </tr>
  <tr>
    <td colspan="3">
      <table class="table2">
        <tr>
          <td><img class="nothing8" src="docs/images/nada.gif"/></td>
          <td>
            <p>LibreOffice %PRODUCT_RELEASE% software is a complete, feature-rich
              office productivity suite that provides, in combination with this
			  SDK, all the essential tools for building and deploying custom
			  solutions that build on, or integrate with, the LibreOffice %PRODUCT_RELEASE% suite
			  of products.</p>
            <p>The SDK is a development kit for LibreOffice %PRODUCT_RELEASE%, which
			  eases the development of office components. It provides a set of
			  libraries, binaries, header, and IDL files which have final API's
			  and can only be extended with new functionality. This set of libraries
			  and binaries is the minimum set of functions needed to use system
			  abstraction for base functionality and for using UNO (Universal
			  Network Objects) component technology. The UNO component model is the
			  base of the whole Office API. The SDK provides everything necessary
			  to use the Office API from external programs (e.g. Java, C++) or to
			  extend the Office functionality with new components (e.g. new filter
			  components, CalcAddin functions). It is compatible over several
			  versions because the API remains unaffected and will only be extended
			  with new functions.</p>
            <p>The SDK provides the basic building blocks for external developers
			  to develop components in any language for which a binding exists.
			  Currently, there are language bindings for LibreOffice %PRODUCT_RELEASE% Basic, Java, Python,
			  and different C++ compilers on different platforms, for LibreOffice %PRODUCT_RELEASE%,
			  thus covering the most commonly used programming languages. There
			  will be no limit for office automation in heterogeneous environments.
			  Currently supported platforms of the SDK are Linux, Solaris (sparc,
			  x86), and Windows.</p>
            <p>The SDK also contains <a href="%DOXYGEN_PREFIX0%/docs/idl/ref/index.html" title="link to the IDL reference documentation"> reference</a> documentation
              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
			  lots of examples, which introduce the API, explain the concepts behind
			  it, and make it possible for all users to quickly get started with
			  the Office API.</p>
          </td>
          <td><img class="nothing8" src="docs/images/nada.gif"/></td>
        </tr>
        <tr>
          <td><img class="nothing8" src="docs/images/nada.gif"/></td>
          <td><img class="line" src="docs/images/sdk_line-1.gif"/></td>
          <td><img class="nothing8" src="docs/images/nada.gif"/></td>
        </tr>
        <tr>
          <td><img class="nothing8" src="docs/images/nada.gif"/></td>
          <td>
             <table class="table3">
              <tr valign="top">
                <td colspan="4" class="head1">Content</td>
              </tr>
              <tr>
			    <td colspan="4"><img class="nothing8" src="docs/images/nada.gif"/></td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <td colspan="2"><a href="docs/install.html" title="link to the installation guide">Installation Guide</a></td>
                <td class="content70">An overview of all necessary
				installation steps (e.g. environment variables) to use this SDK.</td>
              </tr>
              <tr valign="middle">
                <td><img class="nothing10" src="docs/images/nada.gif"/></td>
                <td colspan="3"><img class="line" src="docs/images/sdk_line-1.gif"/></td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <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>
                <td class="content70">Detailed documentation, explaining the LibreOffice %PRODUCT_RELEASE%
				API and the concepts behind it, with a rich set of examples,
				implemented mainly in Java. This documentation is online in TDF Wiki.</td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <td colspan="2"><a href="%DOXYGEN_PREFIX0%/docs/idl/ref/index.html" title="link to the IDL reference documentation">IDL Reference</a></td>
                <td class="content70">Complete LibreOffice %PRODUCT_RELEASE% API reference.</td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <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>
                <td class="content70">Reference documentation of the Java UNO runtime API.</td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <td colspan="2"><a href="%DOXYGEN_PREFIX0%/docs/cpp/ref/index.html" title="link to the C++ API reference documentation">C++ Reference</a></td>
                <td class="content70">Reference documentation of the C++ UNO runtime and a
				set of C/C++ base and helper functions and classes to abstract from
				the system layer.</td>
              </tr>
              <tr valign="middle">
                <td><img class="nothing10" src="docs/images/nada.gif"/></td>
                <td colspan="3"><img class="line" src="docs/images/sdk_line-1.gif"/></td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <td colspan="2"><a href="docs/tools.html" title="link to the tools overview page">Development Tools</a></td>
                <td class="content70">Overview and a short description of the UNO
				development tools.</td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <td colspan="2"><a href="examples/examples.html" title="link to the examples overview page">Examples</a></td>
                <td class="content70">A collection of examples in different
				programming languages (Java, Python, C++, Basic, OLE, CLI).</td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <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>
                <td class="content70">A git repository with additional examples
                  from various contributors: <code>git clone
                  https://gerrit.libreoffice.org/sdk-examples</code></td>
              </tr>
              <tr valign="middle">
                <td><img class="nothing10" src="docs/images/nada.gif"/></td>
                <td colspan="3"><img class="line" src="docs/images/sdk_line-1.gif"/></td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <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>
                <td class="content70">Link to the OASIS Open Document Format for
				Office Applications (OpenDocument) Technical Committee where you
				can find the latest information about the OASIS Open Document XML
				file format which is the default document format
				for LibreOffice %PRODUCT_RELEASE%.</td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <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>
                <td class="content70">Specification of the initial OpenOffice.org XML File Format.</td>
              </tr>
              <tr valign="middle">
                <td><img class="nothing10" src="docs/images/nada.gif"/></td>
                <td colspan="3"><img class="line" src="docs/images/sdk_line-1.gif"/></td>
              </tr>
              <tr valign="top">
                <td class="content4"><img src="docs/images/arrow-1.gif"/></td>
                <td colspan="2"><a href="share/readme/LICENSE.html" title="link to the SDK license file">License</a></td>
                <td class="content70">The license for the LibreOffice %PRODUCT_RELEASE% SDK.</td>
              </tr>
            </table>
          </td>
          <td><img class="nothing8" src="docs/images/nada.gif"/></td>
        </tr>
      </table>
    </td>
  </tr>
</table>
                </div>
                <div id="Footer">
                    <div id="FooterText">
                        <p>
                            Copyright &copy; 2000–2023 LibreOffice contributors. All rights reserved.
                            <br/>
                            LibreOffice was created by The Document Foundation,
                            based on OpenOffice.org.
                            <br/>
                            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>.
                        </p>
                        <p>
                            &nbsp;
                        </p>
                        <p>
                            <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>
                            | 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>.
                        </p>
                    </div>
                </div>
            </div>
        </div>
        </div>
    </body>
</html>