offapi/com/sun/star/embed/BaseStorage.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
  20
  21
  22  module com {  module sun {  module star {  module embed {
  23
  24 /** This is a service that allows to get access to a storage hierarchy.
  25  */
  26 published service BaseStorage
  27 {
  28     /** This is a general interface representing storage functionality.
  29         It allows to copy storages, get access to child elements and to
  30         control lifetime.
  31      */
  32     interface ::com::sun::star::embed::XStorage;
  33
  34     /** allows to get access to storage properties.
  35      */
  36     interface ::com::sun::star::beans::XPropertySet;
  37
  38     /** allows to get the mode the storage is opened in.
  39
  40         <p>
  41         Can be a combination of values from ElementModes.
  42         </p>
  43      */
  44     [property, readonly] long OpenMode;
  45
  46     /** allows to retrieve URL the storage is based on.
  47      */
  48     [property, optional, readonly] string URL;
  49
  50 };
  51
  52
  53 }; }; }; };
  54
  55 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */