offapi/com/sun/star/embed/BaseStorage.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27
  28 #ifndef __com_sun_star_embed_BaseStorage_idl__
  29 #define __com_sun_star_embed_BaseStorage_idl__
  30
  31 #ifndef __com_sun_star_embed_XStorage_idl__
  32 #include <com/sun/star/embed/XStorage.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_beans_XPropertySet_idl__
  36 #include <com/sun/star/beans/XPropertySet.idl>
  37 #endif
  38
  39
  40 //============================================================================
  41
  42  module com {  module sun {  module star {  module embed {
  43
  44 //============================================================================
  45 /** This is a service that allows to get access to a storage hierarchy.
  46  */
  47 published service BaseStorage
  48 {
  49     // -----------------------------------------------------------------------
  50     /** This is a general interface representing storage functionality.
  51         It allows to copy storages, get access to child elements and to
  52         control lifetime.
  53      */
  54     interface ::com::sun::star::embed::XStorage;
  55
  56     // -----------------------------------------------------------------------
  57     /** allows to get access to storage properties.
  58      */
  59     interface ::com::sun::star::beans::XPropertySet;
  60
  61     // -----------------------------------------------------------------------
  62     /** allows to get the mode the storage is opened in.
  63
  64         <p>
  65         Can be a combination of values from <type>ElementModes</type>.
  66         </p>
  67      */
  68     [property, readonly] long OpenMode;
  69
  70     // -----------------------------------------------------------------------
  71     /** allows to retrieve URL the storage is based on.
  72      */
  73     [property, optional, readonly] string URL;
  74
  75 };
  76
  77 //============================================================================
  78
  79 }; }; }; };
  80
  81 #endif
  82