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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XStarBasicAccess.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_script_XStarBasicAccess_idl__
  31 #define __com_sun_star_script_XStarBasicAccess_idl__
  32
  33 #ifndef __com_sun_star_container_XNameContainer_idl__
  34 #include <com/sun/star/container/XNameContainer.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39  module com {  module sun {  module star {  module script {
  40
  41 //=============================================================================
  42
  43 /** Interface representing a library and provides access to its modules
  44
  45     @deprecated
  46  */
  47 published interface XStarBasicAccess: com::sun::star::uno::XInterface
  48 {
  49     //-------------------------------------------------------------------------
  50     /** returns
  51         the library container giving access to the libraries stored in a document
  52         or basic library file.
  53      */
  54     com::sun::star::container::XNameContainer getLibraryContainer();
  55
  56     //-------------------------------------------------------------------------
  57     /**
  58         Creates an empty library. This method can be called alternatively to
  59         accessing directly the NameContainer returned by getLibraryContainer.
  60         By using this method together with addModule and addStarBasicDialog
  61         the caller does not have to implement XStarBasicLibraryInfo, XModuleInfo,
  62         and XStarBasicDialogInfo
  63      */
  64     void createLibrary( [in] string LibName, [in] string Password,
  65                         [in] string ExternalSourceURL, [in] string LinkTargetURL )
  66         raises( com::sun::star::container::ElementExistException );
  67
  68     //-------------------------------------------------------------------------
  69     /**
  70         Adds a module to an existing (e.g., created by createLibrary) library.
  71         By using this method together with createLibrary the caller does not have
  72         to implement XStarBasicLibraryInfo and XModuleInfo.
  73
  74         @throws  NoSuchElementException
  75         if the library doesn't exist.
  76      */
  77     void addModule( [in] string LibraryName, [in] string ModuleName,
  78                     [in] string Language, [in] string Source )
  79         raises( com::sun::star::container::NoSuchElementException );
  80
  81     //-------------------------------------------------------------------------
  82     /**
  83         Adds an old style basic dialog (SI controls) to an existing (e.g., created
  84         by createLibrary) library.
  85         By using this method together with createLibrary the caller does not have
  86         to implement XStarBasicLibraryInfo and XStarBasicDialogInfo
  87
  88         @throws  NoSuchElementException
  89         if the library doesn't exist.
  90      */
  91     void addDialog( [in] string LibraryName, [in] string DialogName,
  92                     [in] sequence< byte > Data )
  93         raises( com::sun::star::container::NoSuchElementException );
  94
  95 };
  96
  97 //=============================================================================
  98
  99 }; }; }; };
 100
 101 #endif