offapi/com/sun/star/embed/BaseStorage.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: BaseStorage.idl,v $
  10  * $Revision: 1.4 $
  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_embed_BaseStorage_idl__
  32 #define __com_sun_star_embed_BaseStorage_idl__
  33
  34 #ifndef __com_sun_star_embed_XStorage_idl__
  35 #include <com/sun/star/embed/XStorage.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_beans_XPropertySet_idl__
  39 #include <com/sun/star/beans/XPropertySet.idl>
  40 #endif
  41
  42
  43 //============================================================================
  44
  45  module com {  module sun {  module star {  module embed {
  46
  47 //============================================================================
  48 /** This is a service that allows to get access to a storage hierarchy.
  49  */
  50 service BaseStorage
  51 {
  52     // -----------------------------------------------------------------------
  53     /** This is a general interface representing storage functionality.
  54         It allows to copy storages, get access to child elements and to
  55         control lifetime.
  56      */
  57     interface ::com::sun::star::embed::XStorage;
  58
  59     // -----------------------------------------------------------------------
  60     /** allows to get access to storage properties.
  61      */
  62     interface ::com::sun::star::beans::XPropertySet;
  63
  64     // -----------------------------------------------------------------------
  65     /** allows to get the mode the storage is opened in.
  66
  67         <p>
  68         Can be a combination of values from <type>ElementModes</type>.
  69         </p>
  70      */
  71     [property, readonly] long OpenMode;
  72
  73     // -----------------------------------------------------------------------
  74     /** allows to retrieve URL the storage is based on.
  75      */
  76     [property, optional, readonly] string URL;
  77
  78 };
  79
  80 //============================================================================
  81
  82 }; }; }; };
  83
  84 #endif
  85