udkapi/com/sun/star/script/XStarBasicAccess.idl

   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
  24 /** Interface representing a library and provides access to its modules
  25
  26     @deprecated
  27  */
  28 published interface XStarBasicAccess: com::sun::star::uno::XInterface
  29 {
  30     /** returns
  31         the library container giving access to the libraries stored in a document
  32         or basic library file.
  33      */
  34     com::sun::star::container::XNameContainer getLibraryContainer();
  35
  36     /**
  37         Creates an empty library. This method can be called alternatively to
  38         accessing directly the NameContainer returned by getLibraryContainer.
  39         By using this method together with addModule and addStarBasicDialog
  40         the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo,
  41         and XStarBasicDialogInfo
  42      */
  43     void createLibrary( [in] string LibName, [in] string Password,
  44                         [in] string ExternalSourceURL, [in] string LinkTargetURL )
  45         raises( com::sun::star::container::ElementExistException );
  46
  47     /**
  48         Adds a module to an existing (e.g., created by createLibrary) library.
  49         By using this method together with createLibrary the caller does not have
  50         to implement XStarBasicLibraryInfo and XModuleInfo.
  51
  52         @throws  NoSuchElementException
  53         if the library doesn't exist.
  54      */
  55     void addModule( [in] string LibraryName, [in] string ModuleName,
  56                     [in] string Language, [in] string Source )
  57         raises( com::sun::star::container::NoSuchElementException );
  58
  59     /**
  60         Adds an old style basic dialog (SI controls) to an existing (e.g., created
  61         by createLibrary) library.
  62         By using this method together with createLibrary the caller does not have
  63         to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
  64
  65         @throws  NoSuchElementException
  66         if the library doesn't exist.
  67      */
  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: */