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 #ifndef __com_sun_star_script_XStarBasicAccess_idl__
  20 #define __com_sun_star_script_XStarBasicAccess_idl__
  21
  22 #include <com/sun/star/container/XNameContainer.idl>
  23
  24
  25  module com {  module sun {  module star {  module script {
  26
  27
  28 /** Interface representing a library and provides access to its modules
  29
  30     @deprecated
  31  */
  32 published interface XStarBasicAccess: com::sun::star::uno::XInterface
  33 {
  34     /** returns
  35         the library container giving access to the libraries stored in a document
  36         or basic library file.
  37      */
  38     com::sun::star::container::XNameContainer getLibraryContainer();
  39
  40     /**
  41         Creates an empty library. This method can be called alternatively to
  42         accessing directly the NameContainer returned by getLibraryContainer.
  43         By using this method together with addModule and addStarBasicDialog
  44         the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo,
  45         and XStarBasicDialogInfo
  46      */
  47     void createLibrary( [in] string LibName, [in] string Password,
  48                         [in] string ExternalSourceURL, [in] string LinkTargetURL )
  49         raises( com::sun::star::container::ElementExistException );
  50
  51     /**
  52         Adds a module to an existing (e.g., created by createLibrary) library.
  53         By using this method together with createLibrary the caller does not have
  54         to implement XStarBasicLibraryInfo and XModuleInfo.
  55
  56         @throws  NoSuchElementException
  57         if the library doesn't exist.
  58      */
  59     void addModule( [in] string LibraryName, [in] string ModuleName,
  60                     [in] string Language, [in] string Source )
  61         raises( com::sun::star::container::NoSuchElementException );
  62
  63     /**
  64         Adds an old style basic dialog (SI controls) to an existing (e.g., created
  65         by createLibrary) library.
  66         By using this method together with createLibrary the caller does not have
  67         to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
  68
  69         @throws  NoSuchElementException
  70         if the library doesn't exist.
  71      */
  72     void addDialog( [in] string LibraryName, [in] string DialogName,
  73                     [in] sequence< byte > Data )
  74         raises( com::sun::star::container::NoSuchElementException );
  75
  76 };
  77
  78
  79 }; }; }; };
  80
  81 #endif
  82
  83 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */