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>LibreOffice %PRODUCT_RELEASE% SDK - Developer's Guide Examples
</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"/>
27 <div id=
"BgContainer">
30 <a id=
"Logo" href=
"http://www.libreoffice.org/" title=
"Go to the Home of LibreOffice and the LibreOffice Community page"></a>
31 <p id=
"HeaderTagLine">
32 Software Development Kit %PRODUCT_RELEASE%
38 <div class=
"typography">
40 Developer's Guide Examples
42 <table class=
"table1" cellpadding=
"0">
44 <td colspan=
"3"><img class=
"nothing10"
45 src=
"../../docs/images/nada.gif"/></td>
47 <td colspan=
"3"><table class=
"table2">
50 <table class=
"table3">
55 href=
"https://wiki.openoffice.org/wiki/Documentation/DevGuide/OpenOffice.org_Developers_Guide"
56 title=
"link to the Developer's Guide in the Wiki">Developer's Guide
</a>
57 comes with a wide range of examples from all application areas which
58 shows the use of the API in the context of the different functional
59 areas. Furthermore the examples can be used as a first starting point
60 to modify an existing example to their own needs.
</p>
61 <p>Some of the examples need a running office
62 instance listening on a port. If this is necessary you will get further
63 information in the makefiles.
</p>
64 <p>All examples marked with a
<img
65 src=
"../../docs/images/bluball.gif"/> are executable and be started
66 using a run target in the makefile. The name of the binary (C++) can
67 differ compared to the source file, please see the run target in the
68 appropriate makefile. Some of the examples which create a component
69 have no run target. In these cases a document is provided which
70 instantiates and runs the component (see the makefile output). Also the
71 Basic examples provide documents which use and shows the implemented
72 functionality. The database and forms examples need a running database,
73 please see the description below. But note that is not described in
74 detail how to create a working data source (see the office help).
</p>
79 src=
"../../docs/images/sdk_line-1.gif"/></td>
87 <table class=
"table3">
90 <td class=
"content3"><img
91 src=
"../../docs/images/arrow-1.gif"/></td>
92 <td><a href=
"#FirstSteps"
93 title=
"link to the First Steps examples">First Steps
</a></td>
94 <td class=
"content4"></td>
95 <td class=
"content3"><img
96 src=
"../../docs/images/arrow-1.gif"/></td>
97 <td><a href=
"#ProfessionalUNO"
98 title=
"link to the Professional UNO examples">Professional UNO
</a></td>
99 <td class=
"content10"></td>
100 <td class=
"content3"><img
101 src=
"../../docs/images/arrow-1.gif"/></td>
102 <td><a href=
"#Components"
103 title=
"link to the Components examples">Writing UNO components
</a></td>
106 <td class=
"content3"><img
107 src=
"../../docs/images/arrow-1.gif"/></td>
108 <td><a href=
"#OfficeDevelopment"
109 title=
"link to the Office Development examples">Office Development
</a></td>
110 <td class=
"content4"></td>
111 <td class=
"content3"><img
112 src=
"../../docs/images/arrow-1.gif"/></td>
113 <td><a href=
"#Text" title=
"link to the Text examples">Text
115 <td class=
"content10"></td>
116 <td class=
"content3"><img
117 src=
"../../docs/images/arrow-1.gif"/></td>
118 <td><a href=
"#Spreadsheet"
119 title=
"link to the Spreadsheet examples">Spreadsheet Documents
</a></td>
122 <td class=
"content3"><img
123 src=
"../../docs/images/arrow-1.gif"/></td>
124 <td><a href=
"#Drawing"
125 title=
"link to the Drawing And Presentation examples">Drawing and
126 Presentation Documents
</a></td>
127 <td class=
"content4"></td>
128 <td class=
"content3"><img
129 src=
"../../docs/images/arrow-1.gif"/></td>
130 <td><a href=
"#Charts"
131 title=
"link to the Charts examples">Charts
</a></td>
132 <td class=
"content10"></td>
133 <td class=
"content3"><img
134 src=
"../../docs/images/arrow-1.gif"/></td>
135 <td><a href=
"#BasicandDialogs"
136 title=
"link to the Basic And Dialogs examples">LibreOffice %PRODUCT_RELEASE% Basic and
140 <td class=
"content3"><img
141 src=
"../../docs/images/arrow-1.gif"/></td>
142 <td><a href=
"#Database"
143 title=
"link to the Database examples">Database Access
</a></td>
144 <td class=
"content4"></td>
145 <td class=
"content3"><img
146 src=
"../../docs/images/arrow-1.gif"/></td>
148 title=
"link to the Forms examples">Forms
</a></td>
149 <td class=
"content10"></td>
150 <td class=
"content3"><img
151 src=
"../../docs/images/arrow-1.gif"/></td>
152 <td><a href=
"#UniversalContentBroker"
153 title=
"link to the Universal Content Broker examples">Universal
154 Content Broker (UCB)
</a></td>
157 <td class=
"content3"><img
158 src=
"../../docs/images/arrow-1.gif"/></td>
159 <td><a href=
"#Configuration"
160 title=
"link to the Configuration examples">Configuration Management
</a></td>
161 <td class=
"content4"></td>
162 <td class=
"content3"><img
163 src=
"../../docs/images/arrow-1.gif"/></td>
164 <td><a href=
"#OfficeBean"
165 title=
"link to the OOoBean examples">Office Bean
</a></td>
166 <td class=
"content10"></td>
169 <td class=
"content3"><img
170 src=
"../../docs/images/arrow-1.gif"/></td>
171 <td><a href=
"#ScriptingFramework" title=
"link to the Scripting Framework examples">Scripting Framework
</a></td>
172 <td class=
"content4"></td>
173 <td class=
"content3"><img
174 src=
"../../docs/images/arrow-1.gif"/></td>
175 <td><a href=
"#GraphicalUserInterfaces" title=
"link to the Graphical UserInterfaces examples">Graphical User Interfaces
</a></td>
176 <td class=
"content10"></td>
177 <td class=
"content3"></td>
186 <td class=
"content1"><img class=
"nothing8"
187 src=
"../../docs/images/nada.gif"/></td>
190 <td colspan=
"3"><img class=
"line"
191 src=
"../../docs/images/sdk_line-1.gif"/></td>
194 <td class=
"content1"><img class=
"nothing8"
195 src=
"../../docs/images/nada.gif"/></td>
197 <table class=
"table2">
201 <table class=
"table3">
204 <td colspan=
"2" class=
"head1"><a name=
"FirstSteps">FirstSteps
206 <td align=
"right"> <a href=
"#examples"
207 title=
"link to the Developer's Guide examples overview"><img
208 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
209 href=
"../../index.html" title=
"link to the SDK start page"><img
210 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
218 <table class=
"table4">
221 <td class=
"cell20">Text Document Examples
</td>
222 <td class=
"cell80">Description
</td>
225 <td class=
"cell20"><img
226 src=
"../../docs/images/bluball.gif"/> <a
227 href=
"./FirstSteps/FirstUnoContact.java"
228 title=
"link to FirstSteps/FirstUnoContact.java">FirstUnoContact
</a></td>
229 <td class=
"cell80">Shows how to initialize UNO and
230 get a remote office service manager from a running LibreOffice %PRODUCT_RELEASE% in a
231 different process space.
</td>
234 <td class=
"cell20"><img
235 src=
"../../docs/images/bluball.gif"/> <a
236 href=
"./FirstSteps/FirstLoadComponent.java"
237 title=
"link to FirstSteps/FirstLoadComponent.java">FirstLoadComponent
</a></td>
238 <td class=
"cell80">Demonstrates how to load a
239 component into LibreOffice %PRODUCT_RELEASE% by a Java application.
</td>
242 <td class=
"cell20"><img
243 src=
"../../docs/images/bluball.gif"/> <a
244 href=
"./FirstSteps/HelloTextTableShape.java"
245 title=
"link to FirstSteps/HelloTextTableShape.java">HelloTextTableShape
</a></td>
246 <td class=
"cell80">Performs some generic text and
247 shape operations on a text document, a spreadsheet document and a
248 drawing document.
</td>
257 <td class=
"content1"><img class=
"nothing8"
258 src=
"../../docs/images/nada.gif"/></td>
261 <td colspan=
"3"><img class=
"line"
262 src=
"../../docs/images/sdk_line-1.gif"/></td>
265 <td class=
"content1"><img class=
"nothing8"
266 src=
"../../docs/images/nada.gif"/></td>
268 <table class=
"table2">
272 <table class=
"table3">
275 <td colspan=
"2" class=
"head1"><a
276 name=
"ProfessionalUNO">Professional UNO examples1
</a></td>
277 <td align=
"right"> <a href=
"#examples"
278 title=
"link to the Developer's Guide examples overview"><img
279 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
280 href=
"../../index.html" title=
"link to the SDK start page"><img
281 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
289 <table class=
"table4">
292 <td class=
"cell20">Lifetime Examples
</td>
293 <td class=
"cell80">Description
</td>
296 <td class=
"cell20"><img
297 src=
"../../docs/images/bluball.gif"/> <a
298 href=
"./ProfUNO/Lifetime/MyUnoObject.java"
299 title=
"link to ProfUNO/Lifetime/MyUnoObject.java">MyUnoObject
</a></td>
300 <td class=
"cell80">Shows that it depends on the
301 implementation of the Java VM whether finalize() will be called or not.
</td>
304 <td class=
"cell20"><img
305 src=
"../../docs/images/bluball.gif"/> <a
306 href=
"./ProfUNO/Lifetime/object_lifetime.cxx"
307 title=
"link to ProfUNO/Lifetime/object_lifetime.java">object_lifetime.cxx
308 (ProfUnoLifetime)
</a></td>
309 <td class=
"cell80">Shows the UNO reference counting
310 mechanism in C++.
</td>
318 <table class=
"table4">
321 <td class=
"cell20">Interprocess Connection Example
</td>
322 <td class=
"cell80">Description
</td>
325 <td class=
"cell20"><img
326 src=
"../../docs/images/bluball.gif"/> <a
327 href=
"./ProfUNO/InterprocessConn/ConnectionAwareClient.java"
328 title=
"link to ProfUNO/InterprocessConn/ConnectionAwareClient/.java">ConnectionAwareClient
</a></td>
329 <td class=
"cell80">Implements a client which is aware
330 of losing connection to LibreOffice %PRODUCT_RELEASE%.
</td>
333 <td class=
"cell20"><img
334 src=
"../../docs/images/bluball.gif"/> <a
335 href=
"./ProfUNO/InterprocessConn/UrlResolver.java"
336 title=
"link to ProfUNO/InterProcessConn/UrlResolver.java">UrlResolver
</a></td>
337 <td class=
"cell80">Builds a connection to
338 LibreOffice %PRODUCT_RELEASE% using the URL given on the command line. This example
339 shows the usage of
<a
340 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1bridge_1_1XUnoUrlResolver.html"
341 title=
"link to the reference documentation of com.sun.star.bridge.XUnoResolver"><code>XUnoUrlResolver
</code></a>.
</td>
349 <table class=
"table4">
352 <td class=
"cell20">C++ Binding Examples
</td>
353 <td class=
"cell80">Description
</td>
356 <td class=
"cell20"><img
357 src=
"../../docs/images/bluball.gif"/> <a
358 href=
"./ProfUNO/CppBinding/office_connect.cxx"
359 title=
"link to ProfUNO/CppBinding/office_connect.java">office_connect.cxx
</a></td>
360 <td class=
"cell80">Builds a connection to
361 LibreOffice %PRODUCT_RELEASE% using C++.
</td>
364 <td class=
"cell20"><img
365 src=
"../../docs/images/bluball.gif"/> <a
366 href=
"./ProfUNO/CppBinding/string_samples.cxx"
367 title=
"link to ProfUNO/Cppbinding/string_samples.java">string_samples.cxx
</a></td>
368 <td class=
"cell80">Demonstrates usage of RTL string
369 classes
<a href=
"%DOXYGEN_PREFIX2%/docs/cpp/ref/names/rtl/c-OString.html"
370 title=
"link to the reference documentation of rtl::OString"><code>OString
</code></a>,
371 <a href=
"%DOXYGEN_PREFIX2%/docs/cpp/ref/names/rtl/c-OUString.html"
372 title=
"link to the reference documentation of rtl::OUString"><code>OUString
</code></a>
373 and
<a href=
"%DOXYGEN_PREFIX2%/docs/cpp/ref/names/rtl/c-OUStringBuffer.html"
374 title=
"link to the reference documentation of rtl::OUStringBuffer"><code>OUStringBuffer
</code></a>.
</td>
382 <table class=
"table4">
385 <td class=
"cell20">SimpleBootstrap Java Example
</td>
386 <td class=
"cell80">Description
</td>
389 <td class=
"cell20"><img
390 src=
"../../docs/images/bluball.gif"/> <a
391 href=
"./ProfUNO/SimpleBootstrap_java/SimpleBootstrap_java.java"
392 title=
"link to ProfUNO/SimpleBootstrap_java/SimpleBootstrap_java.java">SimpleBootstrap_java.java
</a></td>
393 <td class=
"cell80">Shows the transparent use of
394 office UNO components from Java. The remote office component context is
395 obtained by using the
<code>com.sun.star.comp.helper.Bootstrap.bootstrap()
</code>
396 method, which bootstraps the component context from a UNO installation.
</td>
399 <td class=
"cell20"><a
400 href=
"./ProfUNO/SimpleBootstrap_java/manifest.mf"
401 title=
"link to ProfUNO/SimpleBootstrap_java/manifest.mf"> manifest.mf
</a></td>
402 <td class=
"cell80">Contains the additional manifest
412 <table class=
"table4">
415 <td class=
"cell20">SimpleBootstrap C++ Example
</td>
416 <td class=
"cell80">Description
</td>
419 <td class=
"cell20"><img
420 src=
"../../docs/images/bluball.gif"/> <a
421 href=
"./ProfUNO/SimpleBootstrap_cpp/SimpleBootstrap_cpp.cxx"
422 title=
"link to ProfUNO/SimpleBootstrap_cpp/SimpleBootstrap_cpp.cxx">SimpleBootstrap_cpp.cxx
</a></td>
423 <td class=
"cell80">Shows the transparent use of
424 office UNO components from C++. The remote office component context is
425 obtained by using the
<code>::cppu::bootstrap()
</code> function, which
426 bootstraps the component context from a UNO installation.
</td>
434 <table class=
"table4">
437 <td class=
"cell20">Deployment Features
</td>
438 <td class=
"cell80">Description
</td>
441 <td class=
"cell20"> <a
442 href=
"./Components/SimpleLicense/description.xml"
443 title=
"link to Components/SimpleLicense/description.xml">description.xml
</a></td>
444 <td class=
"cell80">Demonstrates how license files can be embedded, so that they are shown to the user during installation.
</td>
455 <td class=
"content1"><img class=
"nothing8"
456 src=
"../../docs/images/nada.gif"/></td>
459 <td class=
"content1"><img class=
"nothing8"
460 src=
"../../docs/images/nada.gif"/></td>
462 <table class=
"table2">
466 <table class=
"table3">
469 <td colspan=
"2" class=
"head1"><a name=
"Components">Writing
470 UNO components examples
</a></td>
471 <td align=
"right"> <a href=
"#examples"
472 title=
"link to the Developer's Guide examples overview"><img
473 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
474 href=
"../../index.html" title=
"link to the SDK start page"><img
475 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
483 <table class=
"table4">
486 <td class=
"cell20">Jobs Addon Example
</td>
487 <td class=
"cell80">Description
</td>
490 <td class=
"cell20"><a
491 href=
"./Components/Addons/JobsAddon/AsyncJob.java"
492 title=
"link to Components/Addons/JobsAddon/AsyncJob.java">AsyncJob
</a></td>
493 <td class=
"cell80">An java example showing how a job
494 can analyze the given arguments and how the environment can be
495 detected, in which the job is executed.
</td>
498 <td class=
"cell20"><a
499 href=
"./Components/Addons/JobsAddon/Jobs.xcu"
500 title=
"link to Components/Addons/JobsAddon/Jobs.xcu">Jobs.xcu
</a></td>
501 <td class=
"cell80">Contains the example job
505 <td class=
"cell20"><a
506 href=
"./Components/Addons/JobsAddon/Addons.xcu"
507 title=
"link to Components/Addons/JobsAddon/Addons.xcu">Addons.xcu
</a></td>
508 <td class=
"cell80">Contains the configuration entries
509 for the Jobs addon where different entries are configured.
</td>
517 <table class=
"table4">
520 <td class=
"cell20">ProtocolHandler Addon Java
</td>
521 <td class=
"cell80">Description
</td>
524 <td class=
"cell20"><a
525 href=
"./Components/Addons/ProtocolHandlerAddon_java/ProtocolHandlerAddon.java"
526 title=
"link to Components/Addons/ProtocolHandlerAddon_java/ProtocolHandlerAddon.java">ProtocolHandlerAddon
</a></td>
527 <td class=
"cell80">Implements a ProtocolHandler addon
528 component in Java.
</td>
531 <td class=
"cell20"><a
532 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu"
533 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu">ProtocolHandler.xcu
</a></td>
534 <td class=
"cell80">Contains the ProtocolHandler
538 <td class=
"cell20"><a
539 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu"
540 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu">Addons.xcu
</a></td>
541 <td class=
"cell80">Contains the configuration entries
542 for the ProtocolHandler addon where different entries are configured.
</td>
550 <table class=
"table4">
553 <td class=
"cell20">ProtocolHandler Addon C++
</td>
554 <td class=
"cell80">Description
</td>
557 <td class=
"cell20"><a
558 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/addon.cxx"
559 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/addon.cxx">addon.cxx
</a></td>
560 <td class=
"cell80">Implements a ProtocolHandler addon
561 component in C++.
</td>
564 <td class=
"cell20"><a
565 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/addon.hxx"
566 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/addon.hxx">addon.hxx
</a></td>
567 <td class=
"cell80">Contains the class definition of
568 the c++ ProtocolHandler example.
</td>
571 <td class=
"cell20"><a
572 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/component.cxx"
573 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/component.cxx">component.cxx
</a></td>
574 <td class=
"cell80">Implements the administrative
575 component functions (component_writeInfo, component_getFactory, component_getImplementationEnvironment).
</td>
578 <td class=
"cell20"><a
579 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu"
580 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/ProtocolHandler.xcu">ProtocolHandler.xcu
</a></td>
581 <td class=
"cell80">Contains the ProtocolHandler
585 <td class=
"cell20"><a
586 href=
"./Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu"
587 title=
"link to Components/Addons/ProtocolHandlerAddon_cpp/Addons.xcu">Addons.xcu
</a></td>
588 <td class=
"cell80">Contains the configuration entries
589 for the ProtocolHandler addon where different entries are configured.
</td>
597 <table class=
"table4">
600 <td class=
"cell20">Java Component Example
</td>
601 <td class=
"cell80">Description
</td>
604 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/> <a
605 href=
"./Components/JavaComponent/TestJavaComponent.java"
606 title=
"link to Components/JavaComponent/TestJavaComponent.java">TestJavaComponent
</a></td>
607 <td class=
"cell80">Demonstrates how to extend the
608 service provider with a new factory and instantiates the example
612 <td class=
"cell20"><a
613 href=
"./Components/JavaComponent/TestComponentA.java"
614 title=
"link to Components/JavaComponent/TestComponentA.java">TestComponentA
</a></td>
615 <td class=
"cell80">Shows a simple demo component
617 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XTypeProvider.html"
618 title=
"link to the reference documentation of com.sun.star.lang.XTypeProvider"><code>XTypeProvider
</code></a>,
620 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XServiceInfo.html"
621 title=
"link to the reference documentation of com.sun.star.lang.XServicedInfo">
622 <code>XServiceInfo
</code></a> and an own interface
<code>XSomethingA
</code>.
</td>
625 <td class=
"cell20"><a
626 href=
"./Components/JavaComponent/TestComponentB.java"
627 title=
"link to Components/JavaComponent/TestComponentB.java">TestComponentB
</a></td>
628 <td class=
"cell80">Shows a simple demo component
630 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XTypeProvider.html"
631 title=
"link to the reference documentation of com.sun.star.lang.XTypeProvider">
632 <code>XTypeProvider
</code></a>,
<a
633 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1lang_1_1XServiceInfo.html"
634 title=
"link to the reference documentation of com.sun.star.lang.XServiceInfo"><code>XServiceInfo
</code></a>
635 and an own interface
<code>XSomethingB
</code>.
</td>
638 <td class=
"cell20"><a
639 href=
"./Components/JavaComponent/TestServiceProvider.java"
640 title=
"link to Components/JavaComponent/TestServiceProvider.java">TestServiceProvider
</a></td>
641 <td class=
"cell80">Implements a factory (service
642 provider) which can create the two test components.
</td>
650 <table class=
"table4">
653 <td class=
"cell20">C++ Component Example
</td>
654 <td class=
"cell80">Description
</td>
657 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/> <a
658 href=
"./Components/CppComponent/TestCppComponent.cxx"
659 title=
"link to Components/CppComponent/TestCppComponent.cxx">TestCppComponent.cxx
</a></td>
660 <td class=
"cell80">Shows how to create new instances
661 of the demo services and calls some methods of the demo interface.
</td>
664 <td class=
"cell20"><a
665 href=
"./Components/CppComponent/service1_impl.cxx"
666 title=
"link to Components/CppComponent/service1_impl.cxx">service1_impl.cxx
</a></td>
667 <td class=
"cell80">Implements a simple UNO service
668 with an own interface in C++.
</td>
671 <td class=
"cell20"><a
672 href=
"./Components/CppComponent/service2_impl.cxx"
673 title=
"link to Components/CppComponent/service2_impl.cxx">service2_impl.cxx
</a></td>
674 <td class=
"cell80">Implements another simple UNO
683 <table class=
"table4">
686 <td class=
"cell20">Thumbs Example
</td>
687 <td class=
"cell80">Description
</td>
690 <td class=
"cell20"><a
691 href=
"./Components/Thumbs/org/openoffice/comp/test/ImageShrink.java"
692 title=
"link to Components/Thumbs/org/openoffice/comp/test/ImageShrink.java">ImageShrink
</a></td>
693 <td class=
"cell80">Contains a framework for a
694 component which scales images in a directory and stores them to another
695 directory. This code does not really do anything, it just contains the
699 <td class=
"cell20"><a
700 href=
"./Components/Thumbs/org/openoffice/comp/test/Thumbs.java"
701 title=
"link to Components/Thumbs/org/openoffice/comp/test/Thumbs.java">Thumbs
</a></td>
702 <td class=
"cell80">This example registers a factory
703 for the image shrink component and instantiates it.
</td>
711 <table class=
"table4">
714 <td class=
"cell20">Dialog Component Example
</td>
715 <td class=
"cell80">Description
</td>
718 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/> <a
719 href=
"./Components/DialogComponent/DialogComponent.java"
720 title=
"link to Components/DialogComponent/DialogComponent.java">DialogComponent.java
</a></td>
721 <td class=
"cell80">Implements a component accessing a dialog created
722 with the LibreOffice %PRODUCT_RELEASE% Basic IDE. The component provides methods that
723 can be bound to dialog respectively control events .
</td>
726 <td class=
"cell20"><a
727 href=
"./Components/DialogComponent/XTestDialogHandler.idl"
728 title=
"link to Components/DialogComponent/XTestDialogHandler.idl">XTestDialogHandler.idl
</a></td>
729 <td class=
"cell80">Interface implementing a createDialog method showing the
730 dialog and some methods to be used as event handler for the dialog.
734 <td class=
"cell20"><a
735 href=
"./Components/DialogComponent/TestDialogHandler.idl"
736 title=
"link to Components/DialogComponent/TestDialogHandler.idl">TestDialogHandler.idl
</a></td>
738 Service definition for the component implementing
739 its own interface
<code>XTestDialogHandler
</code>.
743 <td class=
"cell20"><a
744 href=
"./Components/DialogComponent/DialogComponent.odt"
745 title=
"link to Components/DialogComponent/DialogComponent.odt">DialogComponent.odt
</a></td>
746 <td class=
"cell80">Document containing Basic code to
747 instantiate the Dialog Components and a Dialog containing
748 controls with events bound to methods supported by the
749 Dialog Component.
</td>
758 <td class=
"content1"><img class=
"nothing8"
759 src=
"../../docs/images/nada.gif"/></td>
762 <td colspan=
"3"><img class=
"line"
763 src=
"../../docs/images/sdk_line-1.gif"/></td>
766 <td class=
"content1"><img class=
"nothing8"
767 src=
"../../docs/images/nada.gif"/></td>
769 <table class=
"table2">
773 <table class=
"table3">
776 <td colspan=
"2" class=
"head1"><a
777 name=
"OfficeDevelopment">Office Development examples
</a></td>
778 <td align=
"right"> <a href=
"#examples"
779 title=
"link to the Developer's Guide examples overview"><img
780 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
781 href=
"../../index.html" title=
"link to the SDK start page"><img
782 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
790 <table class=
"table4">
793 <td class=
"cell20">Ascii Filter Example
</td>
794 <td class=
"cell80">Description
</td>
797 <td class=
"cell20"><a
798 href=
"./OfficeDev/FilterDevelopment/AsciiFilter/AsciiReplaceFilter.java"
799 title=
"link to OfficeDev/FilterDevelopment/AsciiFilter/AsciiReplaceFilter.java">AsciiReplaceFilter
</a></td>
800 <td class=
"cell80">Implements an example for an
801 import/export filter service.
</td>
804 <td class=
"cell20"><a
805 href=
"./OfficeDev/FilterDevelopment/AsciiFilter/FilterOptions.java"
806 title=
"link to OfficeDev/FilterDevelopment/AsciiFilter/FilterOptions.java">FilterOptions
</a></td>
807 <td class=
"cell80">Offers some helper methods to
808 analyze and prepare the arguments of the filter method.
</td>
811 <td class=
"cell20"><a
812 href=
"./OfficeDev/FilterDevelopment/AsciiFilter/TypeDetection.xcu"
813 title=
"link to OfficeDev/FilterDevelopment/AsciiFilter/TypeDetection.xcu">TypeDetection.xcu
</a></td>
814 <td class=
"cell80">Contains the necessary
815 configuration items for the AsciiReplaceFilter.
</td>
823 <table class=
"table4">
826 <td class=
"cell20">FlatXmlFilter C++ Example
</td>
827 <td class=
"cell80">Description
</td>
830 <td class=
"cell20"><a
831 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXml.cxx"
832 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXml.cxx">FlatXml.cxx
</a></td>
833 <td class=
"cell80">Implements an import/export filter
834 storing the data in one xml stream instead of the normal three streams
835 in for example an .odt file. The example is implemented in C++.
</td>
838 <td class=
"cell20"><a
839 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXmlFilter_cpp.xcu"
840 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilter_cpp/FlatXmlFilter_cpp.xcu">FlatXmlFilter_cpp.xcu
</a></td>
841 <td class=
"cell80">Contains the necessary
842 configuration items for the C++ flat xml filter.
</td>
850 <table class=
"table4">
853 <td class=
"cell20">FlatXmlFilter Java Example
</td>
854 <td class=
"cell80">Description
</td>
857 <td class=
"cell20"><a
858 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXml.java"
859 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXml.java">FlatXml
</a></td>
860 <td class=
"cell80">Implements an import/export filter
861 storing the data in one xml stream instead of the normal three streams
862 in for example an .odt file. The example is implemented in Java.
</td>
865 <td class=
"cell20"><a
866 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXmlFilter_java.xcu"
867 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilter_java/FlatXmlFilter_java.xcu">FlatXmlFilter_java.xcu
</a></td>
868 <td class=
"cell80">Contains the necessary
869 configuration items for the Java flat xml filter.
</td>
877 <table class=
"table4">
880 <td class=
"cell20">FlatXml FilterDetection Example
</td>
881 <td class=
"cell80">Description
</td>
884 <td class=
"cell20"><a
885 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.cxx"
886 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.cxx">filterdetect.cxx
</a></td>
887 <td class=
"cell80">Implements an example filter
888 detection for the flat xml filter. The example is implemented in C++.
</td>
891 <td class=
"cell20"><a
892 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.hxx"
893 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/filterdetect.hxx">filterdetect.hxx
</a></td>
894 <td class=
"cell80">Contains the class definition of
895 the filter detection example.
</td>
898 <td class=
"cell20"><a
899 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/fdcomp.cxx"
900 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/fdcomp.cxx">fdcomp.cxx
</a></td>
901 <td class=
"cell80">Implements the administrative
902 component functions (component_writeInfo, component_getFactory, component_getImplementationEnvironment).
</td>
905 <td class=
"cell20"><a
906 href=
"./OfficeDev/FilterDevelopment/FlatXmlFilterDetection/FlatXmlTypeDetection.xcu"
907 title=
"link to OfficeDev/FilterDevelopment/FlatXmlFilterDetection/FlatXmlTypeDetection.xcu">FlatXmlTypeDetection.xcu
</a></td>
908 <td class=
"cell80">Contains the necessary
909 configuration items for the C++ flat xml type detection.
</td>
917 <table class=
"table4">
920 <td class=
"cell20">Desktop Environment Example
</td>
921 <td class=
"cell80">Description
</td>
924 <td class=
"cell20"><a
925 href=
"./OfficeDev/DesktopEnvironment/CustomizeView.java"
926 title=
"link to OfficeDev/DesktopEnvironment/CustomizeView.java">CustomizeView
</a></td>
927 <td class=
"cell80">Offers a view which allows hiding
928 and showing of the menubar, toolbar and objectbar of the related
929 document component.
</td>
932 <td class=
"cell20"><img
933 src=
"../../docs/images/bluball.gif"/> <a
934 href=
"./OfficeDev/DesktopEnvironment/Desk.java"
935 title=
"link to OfficeDev/DesktopEnvironment/Desk.java">Desk
</a></td>
936 <td class=
"cell80">This is the main part of a demo
937 application based on the framework APIs. It mainly shows the mechanisms
938 to load, store and convert documents, as well as dispatch and dispatch
939 interception. It integrates windows from LibreOffice %PRODUCT_RELEASE% via system
940 window handle. This is the same mechanism as used by the OOoBean, but
941 the OOoBean itself is not used here, just the JNI window handle access.
</td>
944 <td class=
"cell20"><a
945 href=
"./OfficeDev/DesktopEnvironment/DocumentView.java"
946 title=
"link to OfficeDev/DesktopEnvironment/DocumentView.java">DocumentView
</a></td>
947 <td class=
"cell80">Deals with the application window
948 and it's actions.
</td>
951 <td class=
"cell20"><a
952 href=
"./OfficeDev/DesktopEnvironment/FunctionHelper.java"
953 title=
"link to OfficeDev/DesktopEnvironment/FunctionHelper.java">FunctionHelper
</a></td>
954 <td class=
"cell80">This helper comprises all
955 LibreOffice %PRODUCT_RELEASE% API calls. Thus it is possible to learn about these
956 aspects separately from the rest of the application example.
</td>
959 <td class=
"cell20"><a
960 href=
"./OfficeDev/DesktopEnvironment/IOnewayLink.java"
961 title=
"link to OfficeDev/DesktopEnvironment/IOnewayLink.java">IOnewayLink
</a></td>
962 <td class=
"cell80">This is an interface to receive
963 asynchronous events from UNO oneway calls.
</td>
966 <td class=
"cell20"><a
967 href=
"./OfficeDev/DesktopEnvironment/IShutdownListener.java"
968 title=
"link to OfficeDev/DesktopEnvironment/IShutdownListener.java">IShutdownListener
</a></td>
969 <td class=
"cell80">This is a listener interface to
970 clean up on shutdown of LibreOffice %PRODUCT_RELEASE%.
</td>
973 <td class=
"cell20"><a
974 href=
"./OfficeDev/DesktopEnvironment/Interceptor.java"
975 title=
"link to OfficeDev/DesktopEnvironment/Interceptor.java">Interceptor
</a></td>
976 <td class=
"cell80">This implements a dispatch
977 interceptor for a specific URL.
</td>
980 <td class=
"cell20"><a
981 href=
"./OfficeDev/DesktopEnvironment/JavaWindowPeerFake.java"
982 title=
"link to OfficeDev/DesktopEnvironment/JavaWindowPeerFake.java">JavaWindowPeerFake
</a></td>
983 <td class=
"cell80">Fakes an
<a
984 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1awt_1_1XWindowPeer.html"
985 title=
" link to the reference documentation of com.sun.star.awt.XWindowPeer"><code>XWindowPeer
</code></a>
986 for the Java native window handle to create a child window for the
990 <td class=
"cell20"><a
991 href=
"./OfficeDev/DesktopEnvironment/NativeView.java"
992 title=
"link to OfficeDev/DesktopEnvironment/NativeView.java">NativeView
</a></td>
993 <td class=
"cell80">Implements native JNI methods to
994 get the window handle of the Java window.
</td>
997 <td class=
"cell20"><a
998 href=
"./OfficeDev/DesktopEnvironment/OfficeConnect.java"
999 title=
" link to OfficeDev/DesktopEnvironment/OfficeConnect.java">OfficeConnect
</a></td>
1000 <td class=
"cell80">Builds the remote bridge to
1001 LibreOffice %PRODUCT_RELEASE% and exports its UNO service manager for the Java side of
1002 the application.
</td>
1005 <td class=
"cell20"><a
1006 href=
"./OfficeDev/DesktopEnvironment/OnewayExecutor.java"
1007 title=
"link to OfficeDev/DesktopEnvironment/OnewayExecutor.java">OnewayExecutor
</a></td>
1008 <td class=
"cell80">Implements
<code>IOnewayLink
</code>
1009 to decouple asynchronous oneway calls in the Java process.
</td>
1012 <td class=
"cell20"><a
1013 href=
"./OfficeDev/DesktopEnvironment/StatusListener.java"
1014 title=
"link to OfficeDev/DesktopEnvironment/StatusListener.java">StatusListener
</a></td>
1015 <td class=
"cell80">Implements a listener for a
<a
1016 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/structcom_1_1sun_1_1star_1_1frame_1_1FeatureStateEvent.html"
1017 title=
"link to the reference documentation of com.sun.star.frame.FeatureStateEvent">
1018 <code>FeatureStateEvent
</code></a>.
</td>
1021 <td class=
"cell20"><a
1022 href=
"./OfficeDev/DesktopEnvironment/StatusView.java"
1023 title=
"link to OfficeDev/DesktopEnvironment/StatusView.java">StatusView
</a></td>
1024 <td class=
"cell80">Shows the current status for which
1025 the application is registered as an event listener.
</td>
1028 <td class=
"cell20"><a
1029 href=
"./OfficeDev/DesktopEnvironment/ViewContainer.java"
1030 title=
"link to OfficeDev/DesktopEnvironment/ViewContainer.java">ViewContainer
</a></td>
1031 <td class=
"cell80">Performs a clean up on the Java
1032 side on LibreOffice %PRODUCT_RELEASE% shutdown.
</td>
1040 <table class=
"table4">
1043 <td class=
"cell20">Office Development Examples
</td>
1044 <td class=
"cell80">Description
</td>
1047 <td class=
"cell20"><a
1048 href=
"./OfficeDev/OfficeConnect.java"
1049 title=
"link to OfficeDev/OfficeConnect.java">OfficeConnect
</a></td>
1050 <td class=
"cell80">Builds the remote bridge to
1051 LibreOffice %PRODUCT_RELEASE% and exports its UNO service manager to the Java side.
</td>
1054 <td class=
"cell20"><img
1055 src=
"../../docs/images/bluball.gif"/> <a
1056 href=
"./OfficeDev/ContextMenuInterceptor.java"
1057 title=
"link to OfficeDev/ContextMenuInterceptor.java">ContextMenuInterceptor
</a></td>
1058 <td class=
"cell80">This example shows a context menu
1059 interceptor that creates a new menu entry that has a sub menu. This sub
1060 menu is in inserted into the context menu on the topmost position. It
1061 provides some helper functions to the user that are reachable through
1065 <td class=
"cell20"><a
1066 href=
"./OfficeDev/MenuElement.java"
1067 title=
"link to OfficeDev/MenuElement.java">MenuElement
</a></td>
1068 <td class=
"cell80">A helper class for the context
1069 menu interceptor example. It determines the menu element type.
</td>
1072 <td class=
"cell20"><img
1073 src=
"../../docs/images/bluball.gif"/> <a
1074 href=
"./OfficeDev/Number_Formats.java"
1075 title=
"link to OfficeDev/Number_Formats.java">Number_Formats
</a></td>
1076 <td class=
"cell80">Demonstrates the use of number
1077 formats in a spreadsheet document.
</td>
1085 <table class=
"table4">
1088 <td class=
"cell20">Termination Test Example
</td>
1089 <td class=
"cell80">Description
</td>
1092 <td class=
"cell20"><img
1093 src=
"../../docs/images/bluball.gif"/> <a
1094 href=
"./OfficeDev/TerminationTest/TerminationTest.java"
1095 title=
"link to OfficeDev/TerminationTest/TerminationTest.java">TerminationTest
</a></td>
1096 <td class=
"cell80">This example uses the
1097 TerminateListener and shows the use of them in a running program.
</td>
1100 <td class=
"cell20"><a
1101 href=
"./OfficeDev/TerminationTest/TerminateListener.java"
1102 title=
"link to OfficeDev/TerminationTest/TerminateListener.java">TerminateListener
</a></td>
1103 <td class=
"cell80">An example implementation of
<a
1104 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1frame_1_1XTerminateListener.html"
1105 title=
"link to the reference documentation of com.sun.star.frame.XTerminationListener">
1106 <code>XTerminateListener
</code></a>. It is called
1107 when LibreOffice %PRODUCT_RELEASE% terminates.
</td>
1115 <table class=
"table4">
1118 <td class=
"cell20">Clipboard Example
</td>
1119 <td class=
"cell80">Description
</td>
1122 <td class=
"cell20"><img
1123 src=
"../../docs/images/bluball.gif"/> <a
1124 href=
"./OfficeDev/Clipboard/Clipboard.java"
1125 title=
"link to OfficeDev/Clipboard/Clipboard.java">Clipboard
</a></td>
1126 <td class=
"cell80">Demonstrates the usage of the
1127 clipboard service by registering a clipboard listener, getting a list
1128 of formats from the current clipboard content and copying some data to
1132 <td class=
"cell20"><a
1133 href=
"./OfficeDev/Clipboard/ClipboardListener.java"
1134 title=
"link to OfficeDev/Clipboard/ClipboardListener.java">ClipboardListener
</a></td>
1135 <td class=
"cell80">Implements a clipboard listener
1136 for the Clipboard example. In such a class, actions can be implemented
1137 which happen whenever the clipboard content changes.
</td>
1140 <td class=
"cell20"><a
1141 href=
"./OfficeDev/Clipboard/ClipboardOwner.java"
1142 title=
"link to OfficeDev/Clipboard/ClipboardOwner.java">ClipboardOwner
</a></td>
1143 <td class=
"cell80">Implements a clipboard owner for
1144 the Clipboard example. This class is notified when it loses ownership
1145 of the clipboard.
</td>
1148 <td class=
"cell20"><a
1149 href=
"./OfficeDev/Clipboard/TextTransferable.java"
1150 title=
"link to OfficeDev/Clipboard/TextTransferable.java">TextTransferable
</a></td>
1151 <td class=
"cell80">Implements a data object for the
1152 Clipboard example. Such classes supply clients with data in a variety
1161 <table class=
"table4">
1164 <td class=
"cell20">Linguistic Example
</td>
1165 <td class=
"cell80">Description
</td>
1168 <td class=
"cell20"><img
1169 src=
"../../docs/images/bluball.gif"/> <a
1170 href=
"./OfficeDev/Linguistic/LinguisticExamples.java"
1171 title=
"link to OfficeDev/Linguistic/LinguisticExamples.java">LinguisticExamples
</a></td>
1172 <td class=
"cell80">A short example that uses most of
1173 the functionality from the LibreOffice %PRODUCT_RELEASE% linguistic API.
</td>
1176 <td class=
"cell20"><a
1177 href=
"./OfficeDev/Linguistic/OneInstanceFactory.java"
1178 title=
"link to OfficeDev/Linguistic/OneInstanceFactory.java">OneInstanceFactory
</a></td>
1179 <td class=
"cell80">This class is used to provide a
1180 service factory for the linguistic services. It enforces that the
1181 actual implementations are only instantiated once.
</td>
1184 <td class=
"cell20"><a
1185 href=
"./OfficeDev/Linguistic/PropChgHelper.java"
1186 title=
"link to OfficeDev/Linguistic/PropChgHelper.java">PropChgHelper
</a></td>
1187 <td class=
"cell80">The base class for several
1188 property change helpers which are used to keep track of the changes of
1189 the service relevant linguistic properties. It is also used by the
1190 thesaurus directly.
</td>
1193 <td class=
"cell20"><a
1194 href=
"./OfficeDev/Linguistic/PropChgHelper_Hyph.java"
1195 title=
"link to OfficeDev/Linguistic/PropChgHelper_Hyph.java">PropChgHelper_Hyph
</a></td>
1196 <td class=
"cell80">The property change helper that is
1197 tracking the hyphenation relevant properties.
</td>
1200 <td class=
"cell20"><a
1201 href=
"./OfficeDev/Linguistic/PropChgHelper_Spell.java"
1202 title=
"link to OfficeDev/Linguistic/PropChgHelper_Spell.java">PropChgHelper_Spell
</a></td>
1203 <td class=
"cell80">The property change helper that is
1204 tracking the spell checking relevant properties.
</td>
1207 <td class=
"cell20"><a
1208 href=
"./OfficeDev/Linguistic/SampleHyphenator.java"
1209 title=
"link to OfficeDev/Linguistic/SampleHyphenator.java">SampleHyphenator
</a></td>
1210 <td class=
"cell80">A simple implementation for a
<a
1211 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1linguistic2_1_1Hyphenator.html"
1212 title=
"link to the reference documentation of com.sun.star.linguistic2.Hyphenator"><code>Hyphenator
</code></a>
1216 <td class=
"cell20"><a
1217 href=
"./OfficeDev/Linguistic/SampleSpellChecker.java"
1218 title=
"link to OfficeDev/Linguistic/SampleSpellChecker.java">SampleSpellChecker
</a></td>
1219 <td class=
"cell80">A simple implementation for a
<a
1220 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1linguistic2_1_1SpellChecker.html"
1221 title=
"link to the reference documentation of com.sun.star.linguistic2.SpellChecker"><code>SpellChecker
</code></a>
1225 <td class=
"cell20"><a
1226 href=
"./OfficeDev/Linguistic/SampleThesaurus.java"
1227 title=
"link to OfficeDev/Linguistic/SampleThesaurus.java">SampleThesaurus
</a></td>
1228 <td class=
"cell80">A simple implementation for a
<a
1229 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1linguistic2_1_1Thesaurus.html"
1230 title=
"link to the reference documentation of com.sun.star.linguistic2.Thesaurus"><code>Thesaurus
</code></a>
1234 <td class=
"cell20"><a
1235 href=
"./OfficeDev/Linguistic/XHyphenatedWord_impl.java"
1236 title=
"link to OfficeDev/Linguistic/XHyphenatedWord_impl.java">XHyphenatedWord_impl
</a></td>
1237 <td class=
"cell80">An object implementing the
<a
1238 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1linguistic2_1_1XHyphenatedWord.html"
1239 title=
"link to the reference documentation of com.sun.star.linguistic2/XHyphenatedWord"><code>XHyphenatedWord
</code></a>
1240 interface. An instance of this type may be returned by the hyphenator.
</td>
1243 <td class=
"cell20"><a
1244 href=
"./OfficeDev/Linguistic/XMeaning_impl.java"
1245 title=
"link to OfficeDev/Linguistic/XMeaning_impl.java">XMeaning_impl
</a></td>
1246 <td class=
"cell80">An object implementing the
<a
1247 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1linguistic2_1_1XMeaning.html"
1248 title=
"link to the reference documentation of com.sun.star.linguistic2.XMeaning"><code>XMeaning
</code></a>
1249 interface. An instance of this type may be returned by the thesaurus.
</td>
1252 <td class=
"cell20"><a
1253 href=
"./OfficeDev/Linguistic/XPossibleHyphens_impl.java"
1254 title=
"link to OfficeDev/Linguistic/XPossibleHyphens_impl.java">XPossibleHyphens_impl
</a></td>
1255 <td class=
"cell80">An object implementing the
<a
1256 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1linguistic2_1_1XPossibleHyphens.html"
1257 title=
"link to the reference documentation of com.sun.star.linguistic2.XPossibleHyphens">
1258 <code>XPossibleHyphens
</code></a> interface. An
1259 instance of this type may be returned by the hyphenator.
</td>
1262 <td class=
"cell20"><a
1263 href=
"./OfficeDev/Linguistic/XSpellAlternatives_impl.java"
1264 title=
"link to OfficeDev/Linguistic/XSpellAlternatives_impl.java">XSpellAlternatives_impl
</a></td>
1265 <td class=
"cell80">An object implementing the
<a
1266 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1linguistic2_1_1XSpellAlternatives.html"
1267 title=
"link to the reference documentation of com.sun.star.linguistic2.XSpellAlternatives">
1268 <code>XSpellAlternatives
</code></a> interface. An
1269 instance of this type may be returned by the spell checker.
</td>
1277 <table class=
"table4">
1280 <td class=
"cell20">Path Settings Example
</td>
1281 <td class=
"cell80">Description
</td>
1284 <td class=
"cell20"><a
1285 href=
"./OfficeDev/PathSettings/PathSettingsTest.java"
1286 title=
"link to OfficeDev/PathSettings/PathSettingsTest.java">PathsettingsTest
</a></td>
1287 <td class=
"cell80">This code example creates the
1289 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1util_1_1PathSettings.html"
1290 title=
"link to the reference documentation of com.sun.star.util.PathSettings">
1291 <code>com.sun.star.util.PathSettings
</code></a> and
1292 retrieves all path properties from it. It shows how a developer can
1293 change the path properties using the
<a
1294 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1beans_1_1XPropertySet.html"
1295 title=
"link to the reference documentation of com.sun.star.beans.XPropertySet"><code>XPropertySet
</code></a>
1304 <table class=
"table4">
1307 <td class=
"cell20">Path Substitution Example
</td>
1308 <td class=
"cell80">Description
</td>
1311 <td class=
"cell20"><a
1312 href=
"./OfficeDev/PathSubstitution/PathSubstitutionTest.java"
1313 title=
"link to OfficeDev/PathSubstitution/PathSubstitutionTest.java">PathSubstitutionTest
</a></td>
1314 <td class=
"cell80">This code example creates the path
1315 substitution service
<a
1316 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1util_1_1PathSubstitution.html"
1317 title=
"link to the reference documentation of com.sun.star.util.PathSubstitution">
1318 <code>com.sun.star.util.PathSubstitution
</code></a>
1319 and retrieves the pre-defined Office path variables. It shows the
1320 variable values on the screen. The reSubstiuteVariables function is
1321 used to show how the service exchanges parts of a path with a path
1322 variable supporting platform independent path usage.
</td>
1330 <table class=
"table4">
1333 <td class=
"cell20">Disable Commands Example
</td>
1334 <td class=
"cell80">Description
</td>
1337 <td class=
"cell20"><a
1338 href=
"./OfficeDev/DisableCommands/DisableCommandsTest.java"
1339 title=
"link to OfficeDev/DisableCommands/DisableCommandsTest.java">DisableCommandsTest
</a></td>
1340 <td class=
"cell80">Implements an example showing how
1341 a developer can use the configuration API to disable/enable commands at
1351 <td class=
"content1"><img class=
"nothing8"
1352 src=
"../../docs/images/nada.gif"/></td>
1355 <td colspan=
"3"><img class=
"line"
1356 src=
"../../docs/images/sdk_line-1.gif"/></td>
1359 <td class=
"content1"><img class=
"nothing8"
1360 src=
"../../docs/images/nada.gif"/></td>
1362 <table class=
"table2">
1366 <table class=
"table3">
1369 <td colspan=
"2" class=
"head1"><a name=
"Text">Text
1370 Documents examples
</a></td>
1371 <td align=
"right"> <a href=
"#examples"
1372 title=
"link to the Developer's Guide examples overview"><img
1373 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
1374 href=
"../../index.html" title=
"link to the SDK start page"><img
1375 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
1383 <table class=
"table4">
1386 <td class=
"cell20"> Example
</td>
1387 <td class=
"cell80">Description
</td>
1390 <td class=
"cell20"><img
1391 src=
"../../docs/images/bluball.gif"/> <a
1392 href=
"./Text/TextDocuments.java"
1393 title=
"link to Text/TextDocuments.java">TextDocuments
</a></td>
1395 <p>Demonstrates a wide variety of API functions in
1396 text documents and text document views.
</p>
1398 <li>use of templates
</li>
1399 <li>using the view cursor, including visible text
1401 <li>changing the paragraph style
</li>
1402 <li>using various editing facilities like text
1404 <li>using various cursor interfaces
</li>
1405 <li>creating text contents, like tables, sections
1406 and frames, well as text fields and columns
</li>
1407 <li>using stylesheets
</li>
1408 <li>applying numbering styles
</li>
1409 <li>using references, indexes, footnotes and
1411 <li>loading, storing and printing a text document
</li>
1413 <p>Adjust the strings at the beginning of the class
1414 definition to match your installation!
</p>
1424 <td class=
"content1"><img class=
"nothing8"
1425 src=
"../../docs/images/nada.gif"/></td>
1428 <td colspan=
"3"><img class=
"line"
1429 src=
"../../docs/images/sdk_line-1.gif"/></td>
1432 <td class=
"content1"><img class=
"nothing8"
1433 src=
"../../docs/images/nada.gif"/></td>
1435 <table class=
"table2">
1439 <table class=
"table3">
1442 <td colspan=
"2" class=
"head1"><a name=
"Spreadsheet">Spreadsheet
1443 Documents examples
</a></td>
1444 <td align=
"right"> <a href=
"#examples"
1445 title=
"link to the Developer's Guide examples overview"><img
1446 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
1447 href=
"../../index.html" title=
"link to the SDK start page"><img
1448 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
1456 <table class=
"table4">
1459 <td class=
"cell20"> Example
</td>
1460 <td class=
"cell80">Description
</td>
1463 <td class=
"cell20"><a
1464 href=
"./Spreadsheet/ExampleAddIn.java"
1465 title=
"link to Spreadsheet/ExampleAddIn.java">ExampleAddIn
</a></td>
1466 <td class=
"cell80">Implements a simple add-in
1467 component for spreadsheet documents. This component needs to be
1468 deployed before it can be used.
</td>
1471 <td class=
"cell20"><a
1472 href=
"./Spreadsheet/ExampleDataPilotSource.java"
1473 title=
"link to Spreadsheet/ExampleDataPilotSource.java">ExampleDataPilotSource
</a></td>
1474 <td class=
"cell80">Shows usage of a wide variety of
1475 spreadsheet interfaces like
<a
1476 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XCellRangeData.html"
1477 title=
"link to the reference documentation of com.sun.star.sheet.XCellRangeData">
1478 <code>XCellRangeData
</code></a>,
<a
1479 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XCellSeries.html"
1480 title=
"link to the reference documentation of com.sun.star.sheet.XCellSeries"><code>XCellSeries
</code></a>,
1482 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XArrayFormulaRange.html"
1483 title=
"link to the reference documentation of com.sun.star.sheet.XArrayFormularRange"><code>XArrayFormulaRange
</code></a>
1485 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sheet_1_1XMultipleOperation.html"
1486 title=
"link to the reference documentation of com.sun.star.sheet.XMultipleOperation"><code>XMultipleOperations
</code></a>
1487 as well as named ranges, label ranges and data pilot.
</td>
1490 <td class=
"cell20"><img
1491 src=
"../../docs/images/bluball.gif"/> <a
1492 href=
"./Spreadsheet/GeneralTableSample.java"
1493 title=
"link to Spreadsheet/GeneralTableSample.java">GeneralTableSample
</a></td>
1494 <td class=
"cell80">Executes some examples working on
1495 generic tables.
</td>
1498 <td class=
"cell20"><a
1499 href=
"./Spreadsheet/SpreadsheetDocHelper.java"
1500 title=
"link to Spreadsheet/SpreadsheetDocHelper.java">SpreadsheetDocHelper
</a></td>
1501 <td class=
"cell80">Defines a helper class for the
1502 other examples to access spreadsheet documents, sheets and cells.
</td>
1505 <td class=
"cell20"><img
1506 src=
"../../docs/images/bluball.gif"/> <a
1507 href=
"./Spreadsheet/SpreadsheetSample.java"
1508 title=
"link to Spreadsheet/SpreadsheetSample.java">SpreadsheetSample
</a></td>
1509 <td class=
"cell80">Executes some examples working on
1510 a spreadsheet document.
</td>
1513 <td class=
"cell20"><img
1514 src=
"../../docs/images/bluball.gif"/> <a
1515 href=
"./Spreadsheet/ViewSample.java"
1516 title=
"link to Spreadsheet/ViewSample.java">ViewSample
</a></td>
1517 <td class=
"cell80">Shows how to manipulate view
1518 settings like splitting sheeting sheets and selecting cells.
</td>
1527 <td class=
"content1"><img class=
"nothing8"
1528 src=
"../../docs/images/nada.gif"/></td>
1531 <td colspan=
"3"><img class=
"line"
1532 src=
"../../docs/images/sdk_line-1.gif"/></td>
1535 <td class=
"content1"><img class=
"nothing8"
1536 src=
"../../docs/images/nada.gif"/></td>
1538 <table class=
"table2">
1542 <table class=
"table3">
1545 <td colspan=
"2" class=
"head1"><a name=
"Drawing">Drawing
1546 and Presentation Documents examples
</a></td>
1547 <td align=
"right"> <a href=
"#examples"
1548 title=
"link to the Developer's Guide examples overview"><img
1549 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
1550 href=
"../../index.html" title=
"link to the SDK start page"><img
1551 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
1559 <table class=
"table4">
1562 <td class=
"cell20"> Example
</td>
1563 <td class=
"cell80">Description
</td>
1566 <td class=
"cell20"><img
1567 src=
"../../docs/images/bluball.gif"/> <a
1568 href=
"./Drawing/ChangeOrderDemo.java"
1569 title=
"link to Drawing/ChangeOrderDemo.java">ChangeOrderDemo
</a></td>
1570 <td class=
"cell80">Shows how to change the painting
1571 order of shapes.
</td>
1574 <td class=
"cell20"><img
1575 src=
"../../docs/images/bluball.gif"/> <a
1576 href=
"./Drawing/ControlAndSelectDemo.java"
1577 title=
"link to Drawing/ControlAndSelectDemo.java">ControlAndSelectDemo
</a></td>
1578 <td class=
"cell80">Demonstrates the creation of a
1579 control shape and selects it in the current view.
</td>
1582 <td class=
"cell20"><img
1583 src=
"../../docs/images/bluball.gif"/> <a
1584 href=
"./Drawing/CustomShowDemo.java"
1585 title=
"link to Drawing/CustomShowDemo.java">CustomShowDemo
</a></td>
1586 <td class=
"cell80">Creates two custom shows and
1587 selects one of these.
</td>
1590 <td class=
"cell20"><img
1591 src=
"../../docs/images/bluball.gif"/> <a
1592 href=
"./Drawing/DrawViewDemo.java"
1593 title=
"link to Drawing/DrawViewDemo.java">DrawViewDemo
</a></td>
1594 <td class=
"cell80">Prints the view data properties
1595 and the controller properties of a drawing view and shows an example of
1596 setting such a property.
</td>
1599 <td class=
"cell20"><img
1600 src=
"../../docs/images/bluball.gif"/> <a
1601 href=
"./Drawing/DrawingDemo.java"
1602 title=
"link to Drawing/DrawingDemo.java">DrawingDemo
</a></td>
1603 <td class=
"cell80">Creates several shapes on several
1604 slides. Nice pattern included!
</td>
1607 <td class=
"cell20"><img
1608 src=
"../../docs/images/bluball.gif"/> <a
1609 href=
"./Drawing/FillAndLineStyleDemo.java"
1610 title=
"link to Drawing/FillAndLineStyleDemo.java">FillAndLineStyleDemo
</a></td>
1611 <td class=
"cell80">Demonstrates usage of area fill
1612 and line style properties.
</td>
1615 <td class=
"cell20"><img
1616 src=
"../../docs/images/bluball.gif"/> <a
1617 href=
"./Drawing/GluePointDemo.java"
1618 title=
"link to Drawing/GluePointDemo.java">GluePointDemo
</a></td>
1619 <td class=
"cell80">Creates two shapes with glue
1620 points and connects them with two connectors.
</td>
1623 <td class=
"cell20"><img
1624 src=
"../../docs/images/bluball.gif"/> <a
1625 href=
"./Drawing/GraphicExportDemo.java"
1626 title=
"link to Drawing/GraphicExportDemo.java">GraphicExportDemo
</a></td>
1627 <td class=
"cell80">Loads a drawing document and
1628 exports it to a GIF file. Run this program with source URL, target URL
1629 and page index on the command line, where the URLs are fully qualified
1633 <td class=
"cell20"><a href=
"./Drawing/Helper.java"
1634 title=
"link to Drawing/Helper.java">Helper
</a></td>
1635 <td class=
"cell80">Contains a helper class for the
1636 other examples to connect to LibreOffice %PRODUCT_RELEASE% and open or create a drawing
1640 <td class=
"cell20"><img
1641 src=
"../../docs/images/bluball.gif"/> <a
1642 href=
"./Drawing/LayerDemo.java" title=
"link to Drawing/LayerDemo.java">LayerDemo
</a></td>
1643 <td class=
"cell80">Creates shapes in different layers
1644 to show how to protect shapes from modifications.
</td>
1647 <td class=
"cell20"><img
1648 src=
"../../docs/images/bluball.gif"/> <a
1649 href=
"./Drawing/ObjectTransformationDemo.java"
1650 title=
"link to Drawing/ObjectTransformationDemo.java">ObjectTransformationDemo
</a></td>
1651 <td class=
"cell80">Shows geometric transformations on
1652 a shape using a homogeneous matrix.
</td>
1655 <td class=
"cell20"><img
1656 src=
"../../docs/images/bluball.gif"/> <a
1657 href=
"./Drawing/Organigram.java"
1658 title=
"link to Drawing/Organigram.java">Organigram
</a></td>
1659 <td class=
"cell80">Demonstrates the creation of an
1660 organigram consisting of shapes and connectors.
</td>
1663 <td class=
"cell20"><a href=
"./Drawing/PageHelper.java"
1664 title=
"link to Drawing/PageHelper.java">PageHelper
</a></td>
1665 <td class=
"cell80">Contains a helper class for
1666 accessing several kinds of draw pages in a presentation or drawing
1670 <td class=
"cell20"><img
1671 src=
"../../docs/images/bluball.gif"/> <a
1672 href=
"./Drawing/PresentationDemo.java"
1673 title=
"link to Drawing/PresentationDemo.java">PresentationDemo
</a></td>
1674 <td class=
"cell80">Creates a presentation and runs it
1675 with some user interaction.
</td>
1678 <td class=
"cell20"><a
1679 href=
"./Drawing/ShapeHelper.java"
1680 title=
"link to Drawing/ShapeHelper.java">ShapeHelper
</a></td>
1681 <td class=
"cell80">Contains a helper class for
1682 accessing and creating shapes for the other examples.
</td>
1685 <td class=
"cell20"><img
1686 src=
"../../docs/images/bluball.gif"/> <a
1687 href=
"./Drawing/StyleDemo.java" title=
"link to Drawing/StyleDemo.java">StyleDemo
</a></td>
1688 <td class=
"cell80">Creates a shape and applies a
1689 predefined shape stylesheet.
</td>
1692 <td class=
"cell20"><img
1693 src=
"../../docs/images/bluball.gif"/> <a href=
"./Drawing/TextDemo.java"
1694 title=
"link to Drawing/TextDemo.java">TextDemo
</a></td>
1695 <td class=
"cell80">Demonstrates usage of text and
1696 text styles in shapes.
</td>
1705 <td class=
"content1"><img class=
"nothing8"
1706 src=
"../../docs/images/nada.gif"/></td>
1709 <td colspan=
"3"><img class=
"line"
1710 src=
"../../docs/images/sdk_line-1.gif"/></td>
1713 <td class=
"content1"><img class=
"nothing8"
1714 src=
"../../docs/images/nada.gif"/></td>
1716 <table class=
"table2">
1720 <table class=
"table3">
1723 <td colspan=
"2" class=
"head1"><a name=
"Charts">Charts
1725 <td align=
"right"> <a href=
"#examples"
1726 title=
"link to the Developer's Guide examples overview"><img
1727 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
1728 href=
"../../index.html" title=
"link to the SDK start page"><img
1729 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
1737 <table class=
"table4">
1740 <td class=
"cell20"> Example
</td>
1741 <td class=
"cell80">Description
</td>
1744 <td class=
"cell20"><a href=
"./Charts/CalcHelper.java"
1745 title=
"link to Charts/CalcHelper.java">CalcHelper
</a></td>
1746 <td class=
"cell80">Contains some helper methods for
1747 charts in spreadsheet documents, like accessing sheets by name,
1748 inserting a chart into a sheet, filling cell ranges with random numbers
1752 <td class=
"cell20"><a href=
"./Charts/ChartHelper.java"
1753 title=
"link to Charts/ChartHelper.java">ChartHelper
</a></td>
1754 <td class=
"cell80">Contains some helper methods for
1755 charts, like creating a chart as an embedded object.
</td>
1758 <td class=
"cell20"><img
1759 src=
"../../docs/images/bluball.gif"/> <a
1760 href=
"./Charts/ChartInCalc.java"
1761 title=
"link to Charts/ChartInCalc.java">ChartInCalc
</a></td>
1762 <td class=
"cell80">Demonstrates how to create an
1763 embedded chart object with a random scatter chart within a spreadsheet.
</td>
1766 <td class=
"cell20"><img
1767 src=
"../../docs/images/bluball.gif"/> <a
1768 href=
"./Charts/ChartInDraw.java"
1769 title=
"link to Charts/ChartInDraw.java">ChartInDraw
</a></td>
1770 <td class=
"cell80">Inserts a
3D-bar chart into a
1771 drawing document.
</td>
1774 <td class=
"cell20"><img
1775 src=
"../../docs/images/bluball.gif"/> <a
1776 href=
"./Charts/ChartInWriter.java"
1777 title=
"link to Charts/ChartInWriter.java">ChartInWriter
</a></td>
1778 <td class=
"cell80">Inserts an embedded chart object
1779 with a random bar chart in a text document. This example does not
1780 really work, because the API for embedding objects into text documents
1781 is not implemented. To be more precise.
</td>
1784 <td class=
"cell20"><a href=
"./Charts/Helper.java"
1785 title=
"link to Charts/Helper.java">Helper
</a></td>
1786 <td class=
"cell80">Shows how to connect to
1787 LibreOffice %PRODUCT_RELEASE% and create text, drawing or spreadsheet document. This
1788 class is used as a helper class for the other examples.
</td>
1791 <td class=
"cell20"><a
1792 href=
"./Charts/JavaSampleChartAddIn.java"
1793 title=
"link to Charts/JavaSampleChartAddIn.java">JavaSampleChartAddIn
</a></td>
1794 <td class=
"cell80">Gives an example of how to
1795 implement chart add-ins to create new or specialized diagram types. The
1796 resulting component has to be deployed before it can be used.
</td>
1799 <td class=
"cell20"><img
1800 src=
"../../docs/images/bluball.gif"/> <a
1801 href=
"./Charts/ListenAtCalcRangeInDraw.java"
1802 title=
"link to Charts/ListenAtCalcRangeInDraw.java">ListenAtCalcRangeInDraw
</a></td>
1803 <td class=
"cell80">This helper class is used to build
1804 connection between an embedded chart object in a drawing document and a
1805 data range in a spreadsheet document.
</td>
1808 <td class=
"cell20"><img
1809 src=
"../../docs/images/bluball.gif"/> <a
1810 href=
"./Charts/SelectionChangeListener.java"
1811 title=
"link to Charts/SelectionChangeListener.java">SelectionChangeListener
</a></td>
1812 <td class=
"cell80">Shows how to register a handler
1813 which is called when the selection within an embedded chart object
1823 <td class=
"content1"><img class=
"nothing8"
1824 src=
"../../docs/images/nada.gif"/></td>
1827 <td colspan=
"3"><img class=
"line"
1828 src=
"../../docs/images/sdk_line-1.gif"/></td>
1831 <td class=
"content1"><img class=
"nothing8"
1832 src=
"../../docs/images/nada.gif"/></td>
1834 <table class=
"table2">
1838 <table class=
"table3">
1841 <td colspan=
"2" class=
"head1"><a
1842 name=
"BasicandDialogs">LibreOffice %PRODUCT_RELEASE% Basic and Dialogs examples
</a></td>
1843 <td align=
"right"> <a href=
"#examples"
1844 title=
"link to the Developer's Guide examples overview"><img
1845 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
1846 href=
"../../index.html" title=
"link to the SDK start page"><img
1847 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
1855 <table class=
"table4">
1858 <td class=
"cell20">Example
</td>
1859 <td class=
"cell80">Description
</td>
1862 <td class=
"cell20"><a
1863 href=
"./BasicAndDialogs/FirstStepsBasic.odt"
1864 title=
"link to BasicAndDialogs/FirstStepsBasic.odt">FirstStepsBasic.odt
</a></td>
1865 <td class=
"cell80">This StarBasic example shows how to
1866 create an own dialog which inserts a graphics object into a text
1870 <td class=
"cell20"><a
1871 href=
"./BasicAndDialogs/CreatingDialogs/SampleDialog.java"
1872 title=
"link to BasicAndDialogs/CreatingDialogs/SampleDialog.java">SampleDialog
</a></td>
1873 <td class=
"cell80">This example builds a Java
1874 component which creates a simple dialog.
</td>
1877 <td class=
"cell20"><a
1878 href=
"./BasicAndDialogs/CreatingDialogs/CreatingDialogs.odt"
1879 title=
"link to BasicAndDialogs/CreatingDialogs/CreatingDialogs.odt">CreatingDialogs.odt
</a></td>
1880 <td class=
"cell80">This document contains a simple
1881 Basic macro which loads the SampleDialog component. The macro will be
1882 executed by pressing a Push button.
</td>
1885 <td class=
"cell20"><a
1886 href=
"./BasicAndDialogs/ToolkitControls/ToolkitControls"
1887 title=
"link to BasicAndDialogs/ToolkitControls">ToolkitControls
</a></td>
1888 <td class=
"cell80">In this directory you find a Basic
1889 library which implements several examples using toolkit controls. You
1890 can easy pack this Basic library as a UNO package and can install it
1891 using the package manager (see the makefile output).
<br/>
1892 After the installation you will find a new library
"ToolkitControls" in
1893 the Basic IDE containing
4 modules and the necessary dialogs.
<br/>
1894 <p>Select one of the following modules and press the
1897 <li>FileDialog = simple dialog which ask for a
1898 filename (nothing else)
</li>
1899 <li>MultiPage = a more complex dialog with several
1901 <li>ProgressBar = a dialog which shows a progress
1903 <li>ScrollBar = a dialog which shows a scroll bar
</li>
1914 <td class=
"content1"><img class=
"nothing8"
1915 src=
"../../docs/images/nada.gif"/></td>
1918 <td colspan=
"3"><img class=
"line"
1919 src=
"../../docs/images/sdk_line-1.gif"/></td>
1922 <td class=
"content1"><img class=
"nothing8"
1923 src=
"../../docs/images/nada.gif"/></td>
1925 <table class=
"table2">
1929 <table class=
"table3">
1932 <td colspan=
"2" class=
"head1"><a name=
"Database">Database
1933 Access examples
</a></td>
1934 <td align=
"right"> <a href=
"#examples"
1935 title=
"link to the Developer's Guide examples overview"><img
1936 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
1937 href=
"../../index.html" title=
"link to the SDK start page"><img
1938 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
1941 <td colspan=
"3"> The Database examples use a SQL
1942 database named
"MYDB0" with write access. Make sure that you have a
1943 data source operating on such a database in your office before you run
1952 <table class=
"table4">
1955 <td class=
"cell20">Database Examples
</td>
1956 <td class=
"cell80">Description
</td>
1959 <td class=
"cell20"><img
1960 src=
"../../docs/images/bluball.gif"/> <a
1961 href=
"./Database/CodeSamples.java"
1962 title=
"link to Database/CodeSamples.java">CodeSamples
</a></td>
1963 <td class=
"cell80">Creates the connection to
1964 LibreOffice %PRODUCT_RELEASE% and executes the code SalesMan samples for database API.
</td>
1967 <td class=
"cell20"><img
1968 src=
"../../docs/images/bluball.gif"/> <a
1969 href=
"./Database/OpenQuery.java"
1970 title=
"link to Database/OpenQuery.java">OpenQuery
</a></td>
1971 <td class=
"cell80">Demonstrates the use of
<a
1972 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sdbc_1_1XResultSetUpdate.html"
1973 title=
"link to the reference documentation of com.sun.star.sdbc.XResultSetUpdate"><code>XResultSetUpdate
</code></a>
1974 and
<a href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1sdbc_1_1XRowUpdate.html"
1975 title=
"link to the reference documentation of com.sun.star.sdbc.XRowUpdate">
1976 <code>XRowUpdate
</code></a>.
</td>
1979 <td class=
"cell20"><img
1980 src=
"../../docs/images/bluball.gif"/> <a href=
"./Database/RowSet.java"
1981 title=
"link to Database/RowSet.java">RowSet
</a></td>
1982 <td class=
"cell80">Demonstrates the usage of a row
1986 <td class=
"cell20"><a
1987 href=
"./Database/RowSetEventListener.java"
1988 title=
"link to Database/RowSetEventListener.java">RowSetEventListener
</a></td>
1989 <td class=
"cell80">Demonstrates how to define
1990 listener for the row set example.
</td>
1993 <td class=
"cell20"><a href=
"./Database/Sales.java"
1994 title=
"link to Database/Sales.java">Sales
</a></td>
1995 <td class=
"cell80">Creates a simple database table.
</td>
1998 <td class=
"cell20"><a href=
"./Database/SalesMan.java"
1999 title=
"link to Database/SalesMan.java">SalesMan
</a></td>
2000 <td class=
"cell80">Creates a simple database table.
</td>
2003 <td class=
"cell20"><a href=
"./Database/sdbcx.java"
2004 title=
"link to Database/sdbcx.java">sdbcx
</a></td>
2005 <td class=
"cell80">Demonstrates the usage of the
2006 SDBCX layer services.
</td>
2014 <table class=
"table4">
2017 <td class=
"cell20">Driver Skeleton Example
</td>
2018 <td class=
"cell80">Description
</td>
2021 <td class=
"cell20"><a
2022 href=
"./Database/DriverSkeleton/OSubComponent.hxx"
2023 title=
"link to Database/DriverSkeleton/OSubComponent.hxx">OSubComponent.hxx
</a></td>
2024 <td class=
"cell80">Helper class to delegate special
2025 dispose handling.
</td>
2028 <td class=
"cell20"><a
2029 href=
"./Database/DriverSkeleton/OTypeInfo.hxx"
2030 title=
"link to Database/DriverSkeleton/OTypeInfo.hxx">OTypeInfo.hxx
</a></td>
2031 <td class=
"cell80">Contains the database types from
2032 the DatabaseMetaData getTypes call.
</td>
2035 <td class=
"cell20"><a
2036 href=
"./Database/DriverSkeleton/SConnection.hxx"
2037 title=
"link to Database/DriverSkeleton/SConnection.hxx">SConnection.hxx
</a></td>
2038 <td class=
"cell80">This file contains the declaration
2039 of a class implementing the service
<code>com.sun.star.sdbc.Connection
</code>.
</td>
2042 <td class=
"cell20"><a
2043 href=
"./Database/DriverSkeleton/SConnection.cxx"
2044 title=
"link to Database/DriverSkeleton/SConnection.cxx">SConnection.cxx
</a></td>
2045 <td class=
"cell80">This file contains the
2046 implementation of the class declared in SConnection.hxx.
</td>
2049 <td class=
"cell20"><a
2050 href=
"./Database/DriverSkeleton/SDatabaseMetaData.hxx"
2051 title=
"link to Database/DriverSkeleton/SDatabaseMetaData.hxx">SDatabaseMetaData.hxx
</a></td>
2052 <td class=
"cell80">This file contains the declaration
2053 of a class implementing the interface
<code>com.sun.star.sdbc.XDatabaseMetaData
</code>.
</td>
2056 <td class=
"cell20"><a
2057 href=
"./Database/DriverSkeleton/SDatabaseMetaData.cxx"
2058 title=
"link to Database/DriverSkeleton/SDatabaseMetaData.cxx">SDatabaseMetaData.cxx
</a></td>
2059 <td class=
"cell80">This file contains the
2060 implementation of the class declared in SDatabaseMetaData.hxx.
</td>
2063 <td class=
"cell20"><a
2064 href=
"./Database/DriverSkeleton/SDriver.hxx"
2065 title=
"link to Database/DriverSkeleton/SDriver.hxx">SDriver.hxx
</a></td>
2066 <td class=
"cell80">This file contains the declaration
2067 of a class implementing the service
<code>com.sun.star.sdbc.Driver
</code>.
</td>
2070 <td class=
"cell20"><a
2071 href=
"./Database/DriverSkeleton/SDriver.cxx"
2072 title=
"link to Database/DriverSkeleton/SDriver.cxx">SDriver.cxx
</a></td>
2073 <td class=
"cell80">This file contains the
2074 implementation of the class declared in SDriver.hxx.
</td>
2077 <td class=
"cell20"><a
2078 href=
"./Database/DriverSkeleton/SPreparedStatement.hxx"
2079 title=
"link to Database/DriverSkeleton/SPreparedStatement.hxx">SPreparedStatement.hxx
</a></td>
2080 <td class=
"cell80">This file contains the declaration
2081 of a class implementing the service
<code>com.sun.star.sdbc.PreparedStatement
</code>.
2085 <td class=
"cell20"><a
2086 href=
"./Database/DriverSkeleton/SPreparedStatement.cxx"
2087 title=
"link to Database/DriverSkeleton/SPreparedStatement.cxx">SPreparedStatement.cxx
</a></td>
2088 <td class=
"cell80">This file contains the
2089 implementation of the class declared in SPreparedStatement.hxx.
</td>
2092 <td class=
"cell20"><a
2093 href=
"./Database/DriverSkeleton/SResultSet.hxx"
2094 title=
"link to Database/DriverSkeleton/SResultSet.hxx">SResultSet.hxx
</a></td>
2095 <td class=
"cell80">This file contains the declaration
2096 of a class implementing the service
<code>com.sun.star.sdbc.ResultSet
</code>.
</td>
2099 <td class=
"cell20"><a
2100 href=
"./Database/DriverSkeleton/SResultSet.cxx"
2101 title=
"link to Database/DriverSkeleton/SResultSet.cxx">SResultSet.cxx
</a></td>
2102 <td class=
"cell80">This file contains the
2103 implementation of the class declared in SResultSet.hxx.
</td>
2106 <td class=
"cell20"><a
2107 href=
"./Database/DriverSkeleton/SResultSetMetaData.hxx"
2108 title=
"link to Database/DriverSkeleton/SResultSetMetaData.hxx">SResultSetMetaData.hxx
</a></td>
2109 <td class=
"cell80">This file contains the declaration
2110 of a class implementing the interface
<code>com.sun.star.sdbc.XResultSetMetaData
</code>.
</td>
2113 <td class=
"cell20"><a
2114 href=
"./Database/DriverSkeleton/SResultSetMetaData.cxx"
2115 title=
"link to Database/DriverSkeleton/SResultSetMetaData.cxx">SResultSetMetaData.cxx
</a></td>
2116 <td class=
"cell80">This file contains the
2117 implementation of the class declared in SResultSetMetaData.hxx.
</td>
2120 <td class=
"cell20"><a
2121 href=
"./Database/DriverSkeleton/SServices.cxx"
2122 title=
"link to Database/DriverSkeleton/SServices.cxx">SServices.cxx
</a></td>
2123 <td class=
"cell80">This file contains a class
2124 implementing the service needed to register the driver.
</td>
2127 <td class=
"cell20"><a
2128 href=
"./Database/DriverSkeleton/SStatement.hxx"
2129 title=
"link to Database/DriverSkeleton/SStatement.hxx">SStatement.hxx
</a></td>
2130 <td class=
"cell80">This file contains the declaration
2131 of a class implementing the service
<code>com.sun.star.sdbc.Statement
</code>.
</td>
2134 <td class=
"cell20"><a
2135 href=
"./Database/DriverSkeleton/SStatement.cxx"
2136 title=
"link to Database/DriverSkeleton/SStatement.cxx">SStatement.cxx
</a></td>
2137 <td class=
"cell80">This file contains the
2138 implementation of the class declared in SStatement.hxx.
</td>
2141 <td class=
"cell20"><a
2142 href=
"./Database/DriverSkeleton/propertyids.hxx"
2143 title=
"link to Database/DriverSkeleton/propertyids.hxx">propertyids.hxx
</a></td>
2144 <td class=
"cell80">Defines some common used strings
2145 and declare a helper class for properties.
</td>
2148 <td class=
"cell20"><a
2149 href=
"./Database/DriverSkeleton/propertyids.cxx"
2150 title=
"link to Database/DriverSkeleton/propertyids.cxx">propertyids.cxx
</a></td>
2151 <td class=
"cell80">Implements the property helper
2161 <td class=
"content1"><img class=
"nothing8"
2162 src=
"../../docs/images/nada.gif"/></td>
2165 <td colspan=
"3"><img class=
"line"
2166 src=
"../../docs/images/sdk_line-1.gif"/></td>
2169 <td class=
"content1"><img class=
"nothing8"
2170 src=
"../../docs/images/nada.gif"/></td>
2172 <table class=
"table2">
2176 <table class=
"table3">
2179 <td colspan=
"2" class=
"head1"><a name=
"Forms">Forms
2181 <td align=
"right"> <a href=
"#examples"
2182 title=
"link to the Developer's Guide examples overview"><img
2183 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
2184 href=
"../../index.html" title=
"link to the SDK start page"><img
2185 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
2193 <table class=
"table4">
2196 <td class=
"cell20">Example
</td>
2197 <td class=
"cell80">Description
</td>
2200 <td class=
"cell20"><a
2201 href=
"./Forms/BooleanValidator.java"
2202 title=
"link to Forms/BooleanValidator.java">BooleanValidator
</a></td>
2203 <td class=
"cell80">The class
<code>BooleanOperator
</code>
2205 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
2206 title=
"link to the reference documentation of com.sun.star.form.validation.XValidator">validator
</a>
2207 for a form control, which can veto certain radio button or check box
2211 <td class=
"cell20"><a
2212 href=
"./Forms/ButtonOperator.java"
2213 title=
"link to Forms/ButtonOperator.java">ButtonOperator
</a></td>
2214 <td class=
"cell80">The form created by the sample
2215 program contains various buttons which are tied to certain
2216 functionality. The class ButtonOperator, well, operates these buttons.
</td>
2219 <td class=
"cell20"><a
2220 href=
"./Forms/ComponentTreeTraversal.java"
2221 title=
"link to Forms/ComponentTreeTraversal.java">ComponentTreeTraversal
</a></td>
2222 <td class=
"cell80">Helper classes for traveling
2223 through a tree of
<a
2224 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1form_1_1FormComponent.html"
2225 title=
"link to the reference documentation of com.sun.star.form.FormComponent">
2226 <code>FormComponent's
</code></a>.
</td>
2229 <td class=
"cell20"><a href=
"./Forms/ControlLock.java"
2230 title=
"link to Forms/ControlLock.java">ControlLock
</a></td>
2231 <td class=
"cell80">Helper class for implementing the
2232 locking of control depending on the state of the underlying
<a
2233 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1RowSet.html"
2234 title=
"link to the reference documentation of com.sun.star.sdb.RowSet"><code>RowSet
</code></a>.
</td>
2237 <td class=
"cell20"><img
2238 src=
"../../docs/images/bluball.gif"/> <a
2239 href=
"./Forms/ControlValidation.java"
2240 title=
"link to Forms/ControlValidation.java">ControlValidation
</a></td>
2241 <td class=
"cell80">This is the main class for the
2242 control validation example. It creates a sample document, fills it with
2243 controls, and attaches several validators to those controls
</td>
2246 <td class=
"cell20"><a
2247 href=
"./Forms/ControlValidator.java"
2248 title=
"link to Forms/ControlValidator.java">ControlValidator
</a></td>
2249 <td class=
"cell80">Base class implementing the common
2250 denominator for components
<a
2251 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1form_1_1validation_1_1ValidatableControlModel.html"
2252 title=
"link to the reference documentation of com.sun.star.form.validation.ValidatableControlModel">validating
2253 form controls.
</a></td>
2256 <td class=
"cell20"><img
2257 src=
"../../docs/images/bluball.gif"/> <a
2258 href=
"./Forms/DataAwareness.java"
2259 title=
"link to Forms/DataAwareness.java">DataAwareness
</a></td>
2260 <td class=
"cell80">This class implements the basic
2261 example for a form working on a database. Two tables will be created
2262 and a form (writer document) with a business example will fill its
2263 fields from these tables.
</td>
2266 <td class=
"cell20"><a
2267 href=
"./Forms/DateValidator.java"
2268 title=
"link to Forms/DateValidator.java">DateValidator
</a></td>
2269 <td class=
"cell80">The class
<code>DateValidator
</code>
2271 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
2272 title=
"link to the reference documentation of com.sun.star.form.validation.XValidator">validator
</a>
2273 for a form control, which can check the content of a form date field.
</td>
2276 <td class=
"cell20"><a
2277 href=
"./Forms/DocumentBasedExample.java"
2278 title=
"link to Forms/DocumentBasedExample.java">DocumentBasedExample
</a></td>
2279 <td class=
"cell80">This class collects common
2280 functionality of examples which require a document.
</td>
2283 <td class=
"cell20"><a
2284 href=
"./Forms/DocumentHelper.java"
2285 title=
"link to Forms/DocumentHelper.java">DocumentHelper
</a></td>
2286 <td class=
"cell80">Helper class for encapsulating
2287 working with a document.
</td>
2290 <td class=
"cell20"><a href=
"./Forms/DocumentType.java"
2291 title=
"link to Forms/DocumentType.java">DocumentType
</a></td>
2292 <td class=
"cell80">A simple enumeration class for
2293 classifying a document.
</td>
2296 <td class=
"cell20"><a
2297 href=
"./Forms/DocumentViewHelper.java"
2298 title=
"link to Forms/DocumentViewHelper.java">DocumentViewHelper
</a></td>
2299 <td class=
"cell80">Helper class for encapsulating
2300 working with a view for a document.
</td>
2303 <td class=
"cell20"><a href=
"./Forms/FLTools.java"
2304 title=
"link to Forms/FLTools.java">FLTools
</a></td>
2305 <td class=
"cell80">Various small tools for the form
2306 layer sample program.
</td>
2309 <td class=
"cell20"><a href=
"./Forms/FormLayer.java"
2310 title=
"link to Forms/FormLayer.java">FormLayer
</a></td>
2311 <td class=
"cell80">Helper class for accessing and
2312 manipulating the form layer of a document.
</td>
2315 <td class=
"cell20"><a
2316 href=
"./Forms/GridFieldValidator.java"
2317 title=
"link to Forms/GridFieldValidator.java">GridFieldValidator
</a></td>
2318 <td class=
"cell80"><code>GridFieldValidator
</code> is
2319 responsible for validating the input in a specific grid control column.
2320 This is not to be mixed up with the control-based validation as
2322 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/namespacecom_1_1sun_1_1star_1_1form_1_1validation.html"
2323 title=
"link to the reference documentation of com.sun.star.form.validation">validation
</a>
2324 module. Instead, a
<code>GridFieldValidator
</code> assembles and uses
2325 various other concepts.
</td>
2328 <td class=
"cell20"><a
2329 href=
"./Forms/InteractionRequest.java"
2330 title=
"link to Forms/InteractionRequest.java">InteractionRequest
</a></td>
2331 <td class=
"cell80">A simple implementation of a
<a
2332 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1task_1_1XInteractionRequest.html"
2333 title=
"link to the reference documentation of com.sun.star.task.XInteractionRequest"><code>XInteractionRequest
</code></a>.
2334 Not tied to the form layer example, but a general helper.
</td>
2337 <td class=
"cell20"><a href=
"./Forms/KeyGenerator.java"
2338 title=
"link to Forms/KeyGenerator.java">KeyGenerator
</a></td>
2339 <td class=
"cell80">Helper class which is able to
2340 generate (unique) keys for a (
<a
2341 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1sdb_1_1RowSet.html"
2342 title=
"link to the reference documentation of com.sun.star.sdb.RowSet"><code>RowSet
</code>
2343 </a>) column. An instance of this class can be tied
2344 to a specific row set column. It then monitors the state of the
2345 underlying row set, and upon inserting a new record into it (two
2346 operation modi are possible here), it automatically inserts a newly
2347 created (two modi, too) key into the column.
</td>
2350 <td class=
"cell20"><a
2351 href=
"./Forms/ListSelectionValidator.java"
2352 title=
"link to Forms/ListSelectionValidator.java">ListSelectionValidator
</a></td>
2353 <td class=
"cell80">The class
<code>ListSelectionValidator
</code>
2355 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form/validation_1_1XValidator.html"
2356 title=
"link to the reference documentation of com.sun.star.form.validation.XValidator">validator
</a>
2357 for a form control, which can veto certain selections in a list box
2361 <td class=
"cell20"><a
2362 href=
"./Forms/NumericValidator.java"
2363 title=
"link to Forms/NumericValidator.java">NumericValidator
</a></td>
2364 <td class=
"cell80">The class
<code>NumericValidator
</code>
2366 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form/validation_1_1XValidator.html"
2367 title=
"link to the reference documentation of com.sun.star.form.validation.XValidator">validator
</a>
2368 for a form control, which can veto certain values in every control
2369 which allows exchanging numerical values.
</td>
2372 <td class=
"cell20"><a
2373 href=
"./Forms/SingleControlValidation.java"
2374 title=
"link to Forms/SingleControlValidation.java">SingleControlValidation
</a></td>
2375 <td class=
"cell80">Though form documents feature
2376 inbuilt mechanisms for visually indicating invalid control content (see
2378 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/namespacecom_1_1sun_1_1star_1_1form_1_1validation.html"
2379 title=
"link to the reference documentation of com.sun.star.form.validation"><code>com.sun.star.form.validation
</code>
2380 </a> for discussions about validity), the
<a
2381 href=
"./Forms/ControlValidation.java"
2382 title=
"link to Forms/ControlValidation.java">ControlValidation
</a>
2383 example extends this. The validity state of every control in this
2384 example, as well as possible explanations for invalidity, are displayed
2385 in dedicated texts. The
<code>SingleControlValidation
</code> class
2386 ties together a validatable control and those status texts.
</td>
2389 <td class=
"cell20"><a
2390 href=
"./Forms/SpreadsheetDocument.java"
2391 title=
"link to Forms/SpreadsheetDocument.java">SpreadsheetDocument
</a></td>
2392 <td class=
"cell80">A specialized
<a
2393 href=
"./Forms/DocumentHelper.java"
2394 title=
"link to Forms/DocumentHelper.java"><code>DocumentHelper
</code></a>
2395 which represents a spreadsheet document, and offers some form related
2396 functionality. For instance, this class allows the creation of
<a
2397 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/servicecom_1_1sun_1_1star_1_1table_1_1CellValueBinding.html"
2398 title=
"link to the reference documentation of com.sun.star.table.CellValueBinding">
2399 <code>CellValueBinding
</code></a> instances, which
2400 can be used to couple the content of a form control with the content of
2401 a spreadsheet cell.
</td>
2404 <td class=
"cell20"><img
2405 src=
"../../docs/images/bluball.gif"/> <a
2406 href=
"./Forms/SpreadsheetValueBinding.java"
2407 title=
"link to Forms/SpreadsheetValueBinding.java">SpreadsheetValueBinding
</a></td>
2408 <td class=
"cell80">This example demonstrates how to
2409 bind form controls to spreadsheet cells.
</td>
2412 <td class=
"cell20"><a
2413 href=
"./Forms/SpreadsheetView.java"
2414 title=
"link to Forms/SpreadsheetView.java">SpreadsheetView
</a></td>
2415 <td class=
"cell80">A specialized
<a
2416 href=
"./Forms/DocumentViewHelper.java"
2417 title=
"link to Forms/DocumentViewHelper.java"><code>DocumentViewHelper
</code></a>
2418 which represents a view to a spreadsheet document.
</td>
2421 <td class=
"cell20"><a
2422 href=
"./Forms/TableCellTextBinding.java"
2423 title=
"link to Forms/TableCellTextBinding.java">TableCellTextBinding
</a></td>
2424 <td class=
"cell80">This class allows binding the
2425 control of a form control with a table cell in a text document. For
2426 this, it uses the mechanisms of the
<a
2427 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/namespacecom_1_1sun_1_1star_1_1form_1_1binding.html"
2428 title=
"link to the reference documentation of com.sun.star.form.binding">
2429 <code>com.sun.star.form.binding
</code></a> module.
</td>
2432 <td class=
"cell20"><a
2433 href=
"./Forms/TextValidator.java"
2434 title=
"link to Forms/TextValidator.java">TextValidator
</a></td>
2435 <td class=
"cell80">The class
<code>TextValidator
</code>
2437 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
2438 title=
"link to the reference documentation of com.sun.star.form.validation.XValidator">validator
</a>
2439 for a form control, which can monitor a form text field.
</td>
2442 <td class=
"cell20"><a
2443 href=
"./Forms/TimeValidator.java"
2444 title=
"link to Forms/TimeValidator.java">TimeValidator
</a></td>
2445 <td class=
"cell80">The class
<code>TimeValidator
</code>
2447 href=
"%DOXYGEN_PREFIX2%/docs/idl/ref/interfacecom_1_1sun_1_1star_1_1form_1_1validation_1_1XValidator.html"
2448 title=
"link to the reference documentation of com.sun.star.form.validation.XValidator">validator
</a>
2449 for a form control, which can monitor the content of a form time field.
2453 <td class=
"cell20"><a href=
"./Forms/UNO.java"
2454 title=
"link to Forms/UNO.java">UNO
</a></td>
2455 <td class=
"cell80">A small UNO-syntax related helper
2459 <td class=
"cell20"><img
2460 src=
"../../docs/images/bluball.gif"/> <a
2461 href=
"./Forms/ValueBinding.java"
2462 title=
"link to Forms/ValueBinding.java">ValueBinding
</a></td>
2463 <td class=
"cell80">An example how to bind the content
2464 of a form control to a table cell in a text document.
</td>
2467 <td class=
"cell20"><a href=
"./Forms/WaitForInput.java"
2468 title=
"link to Forms/WaitForInput.java">WaitForInput
</a></td>
2469 <td class=
"cell80">A pretty small helper for the
2470 interactive examples, which notifies another instance when the user
2471 pressed key on the console.
</td>
2480 <td class=
"content1"><img class=
"nothing8"
2481 src=
"../../docs/images/nada.gif"/></td>
2484 <td colspan=
"3"><img class=
"line"
2485 src=
"../../docs/images/sdk_line-1.gif"/></td>
2488 <td class=
"content1"><img class=
"nothing8"
2489 src=
"../../docs/images/nada.gif"/></td>
2491 <table class=
"table2">
2495 <table class=
"table3">
2498 <td colspan=
"2" class=
"head1"><a
2499 name=
"UniversalContentBroker">Universal Content Broker (UCB)
2501 <td align=
"right"> <a href=
"#examples"
2502 title=
"link to the Developer's Guide examples overview"><img
2503 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
2504 href=
"../../index.html" title=
"link to the SDK start page"><img
2505 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
2513 <table class=
"table4">
2516 <td class=
"cell20">Example
</td>
2517 <td class=
"cell80">Description
</td>
2520 <td class=
"cell20"><img
2521 src=
"../../docs/images/bluball.gif"/> <a
2522 href=
"./UCB/ChildrenRetriever.java"
2523 title=
"link to UCB/ChildrenRetriever.java">ChildrenRetriever
</a></td>
2524 <td class=
"cell80">Shows child entries of a given
2525 folder. Try -help or -? on the command line to view optional parameters.
</td>
2528 <td class=
"cell20"><img
2529 src=
"../../docs/images/bluball.gif"/> <a
2530 href=
"./UCB/DataStreamComposer.java"
2531 title=
"link to UCB/DataStreamComposer.java">DataStreamComposer
</a></td>
2532 <td class=
"cell80">Demonstrates usage of the data
2533 stream by copying the data from one UCB node to another.
</td>
2536 <td class=
"cell20"><img
2537 src=
"../../docs/images/bluball.gif"/> <a
2538 href=
"./UCB/DataStreamRetriever.java"
2539 title=
"link to UCB/DataStreamRetriever.java">DataStreamRetriever
</a></td>
2540 <td class=
"cell80">Shows how to obtain the data
2541 stream from a document resource.
</td>
2544 <td class=
"cell20"><a href=
"./UCB/Helper.java"
2545 title=
"link to UCB/Helper.java">Helper
</a></td>
2546 <td class=
"cell80">Some helper methods to access the
2547 UCB which are used by the other examples.
</td>
2550 <td class=
"cell20"><a
2551 href=
"./UCB/MyActiveDataSink.java"
2552 title=
"link to UCB/MyActiveDataSink.java">MyActiveDataSink
</a></td>
2553 <td class=
"cell80">A helper class for the
<code>DataStreamRetriever
</code>
2554 example which implements a data sink.
</td>
2557 <td class=
"cell20"><img
2558 src=
"../../docs/images/bluball.gif"/> <a
2559 href=
"./UCB/PropertiesComposer.java"
2560 title=
"link to UCB/PropertiesComposer.java">PropertiesComposer
</a></td>
2561 <td class=
"cell80">Shows how to set property values
2562 of a UCB resource.
</td>
2565 <td class=
"cell20"><img
2566 src=
"../../docs/images/bluball.gif"/> <a
2567 href=
"./UCB/PropertiesRetriever.java"
2568 title=
"link to UCB/PropertiesRetriever.java">PropertiesRetriever
</a></td>
2569 <td class=
"cell80">Shows how to access property
2570 values of a UCB resource.
</td>
2573 <td class=
"cell20"><img
2574 src=
"../../docs/images/bluball.gif"/> <a
2575 href=
"./UCB/ResourceCreator.java"
2576 title=
"link to UCB/ResourceCreator.java">ResourceCreator
</a></td>
2577 <td class=
"cell80">Creates a new file in an existing
2578 file system folder.
</td>
2581 <td class=
"cell20"><img
2582 src=
"../../docs/images/bluball.gif"/> <a
2583 href=
"./UCB/ResourceManager.java"
2584 title=
"link to UCB/ResourceManager.java">ResourceManager
</a></td>
2585 <td class=
"cell80">Demonstrates how to copy and move
2589 <td class=
"cell20"><img
2590 src=
"../../docs/images/bluball.gif"/> <a
2591 href=
"./UCB/ResourceRemover.java"
2592 title=
"link to UCB/ResourceRemover.java">ResourceRemover
</a></td>
2593 <td class=
"cell80">Demonstrates how to remove UCB
2603 <td class=
"content1"><img class=
"nothing8"
2604 src=
"../../docs/images/nada.gif"/></td>
2607 <td colspan=
"3"><img class=
"line"
2608 src=
"../../docs/images/sdk_line-1.gif"/></td>
2611 <td class=
"content1"><img class=
"nothing8"
2612 src=
"../../docs/images/nada.gif"/></td>
2614 <table class=
"table2">
2618 <table class=
"table3">
2621 <td colspan=
"2" class=
"head1"><a name=
"Configuration">Configuration
2622 Management examples
</a></td>
2623 <td align=
"right"> <a href=
"#examples"
2624 title=
"link to the Developer's Guide examples overview"><img
2625 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
2626 href=
"../../index.html" title=
"link to the SDK start page"><img
2627 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
2635 <table class=
"table4">
2638 <td class=
"cell20">Example
</td>
2639 <td class=
"cell80">Description
</td>
2642 <td class=
"cell20"><img
2643 src=
"../../docs/images/bluball.gif"/> <a
2644 href=
"./Config/ConfigExamples.java"
2645 title=
"link to Config/ConfigExamples.java">ConfigExamples
</a></td>
2646 <td class=
"cell80">This example connects to a
2647 LibreOffice %PRODUCT_RELEASE%, gets the configuration manager and accesses the
2648 configuration in various ways.
</td>
2657 <td class=
"content1"><img class=
"nothing8"
2658 src=
"../../docs/images/nada.gif"/></td>
2661 <td colspan=
"3"><img class=
"line"
2662 src=
"../../docs/images/sdk_line-1.gif"/></td>
2665 <td class=
"content1"><img class=
"nothing8"
2666 src=
"../../docs/images/nada.gif"/></td>
2668 <table class=
"table2">
2672 <table class=
"table3">
2675 <td colspan=
"2" class=
"head1"><a name=
"OfficeBean">Office
2676 Bean example
</a></td>
2677 <td align=
"right"> <a href=
"#examples"
2678 title=
"link to the Developer's Guide examples overview"><img
2679 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
2680 href=
"../../index.html" title=
"link to the SDK start page"><img
2681 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
2689 <table class=
"table4">
2692 <td class=
"cell20"> Example
</td>
2693 <td class=
"cell80">Description
</td>
2696 <td class=
"cell20"><img
2697 src=
"../../docs/images/bluball.gif"/> <a
2698 href=
"./OfficeBean/OOoBeanViewer.java"
2699 title=
"link to OfficeBean/OOoBeanViewer.java">OOoBeanViewer
</a></td>
2700 <td class=
"cell80">Shows how to use the
<code>OOoBean
</code>
2701 embedded in a Java AWT component. It shows how to load and store
2702 documents as well as how to control toolbar visibility.
</td>
2711 <td class=
"content1"><img class=
"nothing8"
2712 src=
"../../docs/images/nada.gif"/></td>
2715 <td colspan=
"3"><img class=
"line"
2716 src=
"../../docs/images/sdk_line-1.gif"/></td>
2719 <td class=
"content1"><img class=
"nothing8"
2720 src=
"../../docs/images/nada.gif"/></td>
2722 <table class=
"table2">
2726 <table class=
"table3">
2729 <td colspan=
"2" class=
"head1"><a
2730 name=
"ScriptingFramework">Scripting Framework Examples
</a></td>
2731 <td align=
"right"> <a href=
"#examples"
2732 title=
"link to the Developer's Guide examples overview"><img
2733 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
2734 href=
"../../index.html" title=
"link to the SDK start page"><img
2735 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
2743 <table class=
"table4">
2746 <td class=
"cell20"> Example
</td>
2747 <td class=
"cell80">Description
</td>
2750 <td class=
"cell20"><a
2751 href=
"./ScriptingFramework/SayHello/SayHello/SayHello.java"
2752 title=
"link to ScriptingFramework/SayHello/SayHello/SayHello.java">SayHello
</a></td>
2753 <td class=
"cell80">A Scripting Framework Java macro
2754 that opens a new Writer document and inserts the word Hello in it.
</td>
2757 <td class=
"cell20"><a
2758 href=
"./ScriptingFramework/ScriptSelector/ScriptSelector/ScriptSelector.java"
2759 title=
"link to ScriptingFramework/ScriptSelector/ScriptSelector/ScriptSelector.java">ScriptSelector
</a></td>
2760 <td class=
"cell80">A Scripting Framework Java macro
2761 that opens a Java Swing dialog with a tree view of the macro hierarchy
2762 for the Office application.
</td>
2773 <td colspan=
"3"><img class=
"line"
2774 src=
"../../docs/images/sdk_line-1.gif"/></td>
2777 <td class=
"content1"><img class=
"nothing8"
2778 src=
"../../docs/images/nada.gif"/></td>
2780 <table class=
"table2">
2784 <table class=
"table3">
2787 <td colspan=
"2" class=
"head1"><a
2788 name=
"GraphicalUserInterfaces">Graphical User Interfaces
</a></td>
2789 <td align=
"right"> <a href=
"#examples"
2790 title=
"link to the Developer's Guide examples overview"><img
2791 class=
"navigate" src=
"../../docs/images/nav_up.png"/></a> <a
2792 href=
"../../index.html" title=
"link to the SDK start page"><img
2793 class=
"navigate" src=
"../../docs/images/nav_home.png"/></a> </td>
2801 <table class=
"table4">
2804 <td class=
"cell20"> Example
</td>
2805 <td class=
"cell80">Description
</td>
2808 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2809 <a href=
"./GUI/DialogDocument.java" title=
"link to GUI/DialogDocument.java">DialogDocument
</a></td>
2810 <td class=
"cell80">A sample showing how to display an office document in a dialog window.
</td>
2813 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2814 <a href=
"./GUI/Messagebox.java" title=
"link to GUI/MessageBox.java">MessageBox
</a></td>
2815 <td class=
"cell80">A sample showing how to display a simple message box.
</td>
2818 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2819 <a href=
"./GUI/UnoDialogSample.java" title=
"link to GUI/UnoDialogSample.java">UnoDialogSample
</a></td>
2820 <td class=
"cell80">A sample showing how to create various controls in a dialog (fixed text field, currency field, progress bar, fixed line, group box, edit field, time field, date field, pattern field, numeric field, progressbar, check box, radio button, list box, combo box, formatted field, file control, button control, roadmap control)
</td>
2823 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2824 <a href=
"./GUI/UnoDialogSample2.java" title=
"link to GUI/UnoDialogSample2.java">UnoDialogSample2
</a></td>
2825 <td class=
"cell80">A dialog sample showing how to use a roadmap control.
</td>
2828 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2829 <a href=
"./GUI/UnoMenu.java" title=
"link to GUI/UnoMenu.java">UnoMenu
</a></td>
2830 <td class=
"cell80">A sample showing a top window with some menus.
</td>
2833 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2834 <a href=
"./GUI/UnoMenu2.java" title=
"link to GUI/UnoMenu2.java">UnoMenu2
</a></td>
2835 <td class=
"cell80">A dialog sample showing how to use or work with a context menu.
</td>
2838 <td class=
"cell20"><img src=
"../../docs/images/bluball.gif"/>
2839 <a href=
"./GUI/ImageControlSample.java" title=
"link to GUI/ImageControlSample.java">ImageControlSample2
</a></td>
2840 <td class=
"cell80">Dialog sample showing how to use an image control.
</td>
2851 <td colspan=
"3"><img class=
"nothing30"
2852 src=
"../../docs/images/nada.gif"/></td>
2857 <div id=
"FooterText">
2859 Copyright ©
2000–
2019 LibreOffice contributors. All rights reserved.
2861 LibreOffice was created by The Document Foundation,
2862 based on Apache OpenOffice, which is Copyright
2011
2863 The Apache Software Foundation.
2865 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>.
2871 <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>
2872 | 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>.