offapi/com/sun/star/embed/FileSystemStorageFactory.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 #ifndef __com_sun_star_embed_FileSystemStorageFactory_idl__
  21 #define __com_sun_star_embed_FileSystemStorageFactory_idl__
  22
  23 #include <com/sun/star/lang/XSingleServiceFactory.idl>
  24
  25
  26
  27  module com {  module sun {  module star {  module embed {
  28
  29 /** The FileSystemStorageFactory is a service that allows to
  30     create a FileSystemStorage based on URL. The URL must point
  31     to a folder.
  32
  33     <p>
  34     In case
  35     com::sun::star::lang::XSingleServiceFactory::createInstance()
  36     call is used the result storage will be open in read-write mode based
  37     on an arbitrary file system folder.
  38     </p>
  39
  40     <p>
  41     In case
  42     com::sun::star::lang::XSingleServiceFactory::createInstanceWithArguments()
  43     call is used a sequence of the following parameters can be used:
  44     </p>
  45
  46     <dl>
  47         <dt>parameter 1</dt>
  48         <dd>
  49                   specifies source of the object, it must be a string
  50                   containing URL.
  51         </dd>
  52
  53         <dt>parameter 2</dt>
  54         <dd>
  55                   specifies mode the storage should be open in, can take
  56                   values from ElementModes constant set.
  57         </dd>
  58
  59         <dt>parameter 3</dt>
  60         <dd>
  61                   allows to provide
  62                   com::sun::star::document::MediaDescryptor
  63                   to the storage so some parts can be used for
  64                   initialization, it can be for example
  65                   com::sun::star::task::XInteractionHandler
  66                   implementation.
  67         </dd>
  68     </dl>
  69
  70     <p>
  71     The parameters are optional, that means that sequence can be empty or
  72     contain only first parameter, or first and second one. In case
  73     no parameters are provided the call works the same way as
  74     com::sun::star::lang::XSingleServiceFactory::createInstance().
  75     In case only first parameter is provided, the storage is opened in
  76     readonly mode.
  77     </p>
  78
  79     <p>
  80     The opened storages can support read access in addition to
  81     specified one.
  82     </p>
  83 */
  84 published service FileSystemStorageFactory
  85     : ::com::sun::star::lang::XSingleServiceFactory;
  86
  87
  88 }; }; }; };
  89
  90 #endif
  91
  92 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */