LibreOffice LibreOffice 26.2 SDK API Reference

XStarBasicAccess.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
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/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
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 .
18 */
19
20
21 module com { module sun { module star { module script {
22
23
28published interface XStarBasicAccess: com::sun::star::uno::XInterface
29{
34 com::sun::star::container::XNameContainer getLibraryContainer();
35
43 void createLibrary( [in] string LibName, [in] string Password,
44 [in] string ExternalSourceURL, [in] string LinkTargetURL )
45 raises( com::sun::star::container::ElementExistException );
46
55 void addModule( [in] string LibraryName, [in] string ModuleName,
56 [in] string Language, [in] string Source )
57 raises( com::sun::star::container::NoSuchElementException );
58
68 void addDialog( [in] string LibraryName, [in] string DialogName,
69 [in] sequence< byte > Data )
70 raises( com::sun::star::container::NoSuchElementException );
71
72};
73
74
75}; }; }; };
76
77/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::container::ElementExistException
is thrown by container methods, if an element is added which is already a child of the container.
Definition: ElementExistException.idl:35
com::sun::star::container::NoSuchElementException
is thrown by child access methods of collections, if the addressed child does not exist.
Definition: NoSuchElementException.idl:31
com::sun::star::container::XNameContainer
This is the generic interface for supporting the insertion and removal of named elements.
Definition: XNameContainer.idl:29
com::sun::star::script::XStarBasicAccess
Interface representing a library and provides access to its modules.
Definition: XStarBasicAccess.idl:29
com::sun::star::script::XStarBasicAccess::createLibrary
void createLibrary([in] string LibName, [in] string Password, [in] string ExternalSourceURL, [in] string LinkTargetURL)
Creates an empty library.
com::sun::star::script::XStarBasicAccess::addModule
void addModule([in] string LibraryName, [in] string ModuleName, [in] string Language, [in] string Source)
Adds a module to an existing (e.g., created by createLibrary) library.
com::sun::star::script::XStarBasicAccess::getLibraryContainer
com::sun::star::container::XNameContainer getLibraryContainer()
returns the library container giving access to the libraries stored in a document or basic library fi...
com::sun::star::script::XStarBasicAccess::addDialog
void addDialog([in] string LibraryName, [in] string DialogName, [in] sequence< byte > Data)
Adds an old style basic dialog (SI controls) to an existing (e.g., created by createLibrary) library.
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com::sun::star::util::Language
short Language
This type is used for a language identifier number.
Definition: Language.idl:26
com
Definition: Ambiguous.idl:20