Version 5.4.3.2, tag libreoffice-5.4.3.2
[LibreOffice.git] / scripting / README
blob1ca4fe97bdd9b48c60db8287ddeebcf5f4426b69
1 This module provides the source code for the Scripting Framework.
3 For more information on the Scripting Framework, see the project web page:
4 [http://framework.openoffice.org/scripting/]
6 This module uses astyle to keep consistent java coding style. Please run
8 ./Format_java_code.sh
10 before committing.
12 == Source Code Structure ==
14 The following directories contain the source code currently used
15 by the Scripting Framework:
17 - source/provider
19 C++ source for the implementations of the com.sun.star.script.provider.*
20 and com.sun.star.script.browse.* UNO types. These types are used for
21 browsing and executing scripts.
23 - source/protocolhandler
25 C++ for a ProtocolHandler implementation that handles vnd.sun.star.script
26 URIs and dispatches them for execution to the Scripting Framework.
28 - source/basprov
30 C++ implementation of the LanguageScriptProvider UNO service for Basic
32 - source/dlgprov
34 C++ implementation of the DialogProvider UNO service used for loading
35 UNO dialogs from various languages
37 - java/com/sun/star/script/framework/provider
39 Implementation of an abstract base class ScriptProvider which provides
40 core methods for implementing Java based LanguageScriptProvider implementations
42 - java/com/sun/star/script/framework/provider/*
44 BeanShell, JavaScript and Java LanguageScriptProvider implementations
46 - java/com/sun/star/script/framework/browse/*
48 BrowseNode implementations for the Java based LanguageScriptProviders
50 - java/com/sun/star/script/framework/io
51 - java/com/sun/star/script/framework/container
53 Classes for performing script IO
55 - examples
57 Example scripts in BeanShell, JavaScript, Java and Python
60 == Deprecated Code ==
62 - java/org/openoffice/*
64 Support for developing scripts in IDEs such as NetBeans.
66 - source/pyprov
68 LanguageScriptProvider for Python