offapi/com/sun/star/document/XEmbeddedScripts.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: XEmbeddedScripts.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef __com_sun_star_document_XEmbeddedScripts_idl__
  32 #define __com_sun_star_document_XEmbeddedScripts_idl__
  33
  34 #ifndef __com_sun_star_script_XStorageBasedLibraryContainer_idl__
  35 #include <com/sun/star/script/XStorageBasedLibraryContainer.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module document {
  41
  42 //=============================================================================
  43
  44 /** is suppoerted by <type>OfficeDocument</type>s which allow to embed scripts
  45
  46     @since OOo 2.4
  47  */
  48 interface XEmbeddedScripts
  49 {
  50     /** is the container of <code>StarBasic</code> macro libraries contained in the document
  51     */
  52     [attribute, readonly]   ::com::sun::star::script::XStorageBasedLibraryContainer BasicLibraries;
  53
  54     /** is the container of dialogs libraries contained in the document
  55     */
  56     [attribute, readonly]   ::com::sun::star::script::XStorageBasedLibraryContainer DialogLibraries;
  57
  58     /** determines whether executing macros from this document is allowed.
  59
  60         <p>Effectively, this attribute is an evaluation of the document's <type>MacroExecMode</type>
  61         against possibly applicable configuration settings, the document location in relation to the
  62         trusted location, and the like.</p>
  63
  64         @see MacroExecMode
  65     */
  66     [attribute, readonly]   boolean AllowMacroExecution;
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; };
  72
  73 //=============================================================================
  74
  75 #endif