summaryrefslogtreecommitdiff
path: root/source/text/sbasic/shared/03/lib_ScriptForge.xhp
blob: 2813a026d4699e7515628c34b4330a72a18e9613 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
<?xml version="1.0" encoding="UTF-8"?>
<helpdocument version="1.0">
    <!--
    * This file is part of the LibreOffice project.
    *
    * This Source Code Form is subject to the terms of the Mozilla Public
    * License, v. 2.0. If a copy of the MPL was not distributed with this
    * file, You can obtain one at http://mozilla.org/MPL/2.0/.
    *
    -->
    <meta>
        <topic id="toolsbasiclibrary" indexer="include" status="PUBLISH">
            <title id="tit" xml-lang="en-US">ScriptForge Library</title>
            <filename>/text/sbasic/shared/03/lib_ScriptForge.xhp</filename>
        </topic>
    </meta>
    <body>
    <h1 id="hd_id31529004750471" xml-lang="en-US"><variable id="ScriptForge_lib"><link href="text/sbasic/shared/03/lib_ScriptForge.xhp" name="ScriptForge library">The <item type="literal">ScriptForge</item> Library</link></variable></h1>
    <bookmark xml-lang="en-US" branch="index" id="bm_id491529070339774">
        <bookmark_value>BASIC ScriptForge library</bookmark_value>
    </bookmark>
    <section id="howtoget">
        <embed href="text/sbasic/shared/00000003.xhp#basiclibhowtoget"/>
    </section>
    <note id="par_id901528999850603"><embedvar href="text/sbasic/shared/00000003.xhp#basiclibrarynote" markup="keep"/><br/>
        <item type="literal">GlobalScope.BasicLibraries.LoadLibrary("ScriptForge")</item></note>

    <paragraph role="paragraph" id="par_id781606153472028">The described modules and classes are invoked from user scripts as "Services". A generic constructor of those services has been designed for that purpose:</paragraph>
    <bascode>
      <paragraph role="bascode" localize="false" id="bas_id201606153529501">[ScriptForge.][Services.]CreateScriptService("servicename"[, arg0, Arg1, ...])</paragraph>
    </bascode>

    <paragraph role="paragraph" id="par_id891606153700196">Services from external libraries can be registered with the <literal>RegisterScriptServices(...)</literal> method in order to extend the set of available services.</paragraph>
    <note id="par_id851605659675843"><literal>ScriptForge</literal> Basic library is available from %PRODUCTNAME 7.1 onwards.</note>

    <embed href="text/sbasic/shared/03/sf_array.xhp#abstract"/>
    <embed href="text/sbasic/shared/03/sf_calc.xhp#abstract"/>
    <embed href="text/sbasic/shared/03/sf_dictionary.xhp#abstract"/>
    <embed href="text/sbasic/shared/03/sf_document.xhp#abstract"/>
    <embed href="text/sbasic/shared/03/sf_exception.xhp#abstract"/>
    <paragraph role="paragraph" id="par_id1001606151139039">FileSystem Service</paragraph>
    <paragraph role="paragraph" id="par_id511606151140972" localize="false">L10n class Service</paragraph>
    <paragraph role="paragraph" id="par_id781606151141190" localize="false">Platform Service</paragraph>
    <paragraph role="paragraph" id="par_id771606151141575" localize="false">Services class Service</paragraph>
    <paragraph role="paragraph" id="par_id671606151231848" localize="false">Session Service</paragraph>
    <paragraph role="paragraph" id="par_id861606151242391" localize="false">String Service</paragraph>
    <paragraph role="paragraph" id="par_id791606151259895" localize="false">TextStream class Service</paragraph>
    <embed href="text/sbasic/shared/03/sf_timer.xhp#abstract"/>
    <embed href="text/sbasic/shared/03/sf_ui.xhp#abstract"/>

    <comment>Restricted use for SF_Root, SF_Utils modules as well as internal methods</comment>
    <paragraph role="paragraph" id="par_id331608220104798"><emph>Note:</emph> Other <literal>ScriptForge</literal> undescribed modules are reserved for internal use. Their content is subject to change without notice.</paragraph>
    <section id="SF_InternalUse">
    <warning id="par_id851506659675843">All <literal>ScriptForge</literal> Basic routines or identifiers that are prefixed with an underscore character "_" are reserved for internal use. They are not meant be used in Basic macros.</warning>
    </section>
</body>
</helpdocument>