1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir 24cdf0e10cSrcweir#ifndef __com_sun_star_embed_FileSystemStorageFactory_idl__ 25cdf0e10cSrcweir#define __com_sun_star_embed_FileSystemStorageFactory_idl__ 26cdf0e10cSrcweir 27cdf0e10cSrcweir#ifndef __com_sun_star_lang_XSingleServiceFactory_idl__ 28cdf0e10cSrcweir#include <com/sun/star/lang/XSingleServiceFactory.idl> 29cdf0e10cSrcweir#endif 30cdf0e10cSrcweir 31cdf0e10cSrcweir 32cdf0e10cSrcweir//============================================================================ 33cdf0e10cSrcweir 34cdf0e10cSrcweir module com { module sun { module star { module embed { 35cdf0e10cSrcweir 36cdf0e10cSrcweir//============================================================================ 37cdf0e10cSrcweir/** The <type>FileSystemStorageFactory</type> is a service that allows to 38cdf0e10cSrcweir create a <type>FileSystemStorage</type> based on URL. The URL must point 39cdf0e10cSrcweir to a folder. 40cdf0e10cSrcweir */ 41cdf0e10cSrcweirpublished service FileSystemStorageFactory 42cdf0e10cSrcweir{ 43cdf0e10cSrcweir // ---------------------------------------------------------------------- 44cdf0e10cSrcweir /** A storage can be created through this interface. 45cdf0e10cSrcweir 46cdf0e10cSrcweir <p> 47cdf0e10cSrcweir In case 48cdf0e10cSrcweir <method scope="com::sun::star::lang">XSingleServiceFactory::createInstance</method> 49cdf0e10cSrcweir call is used the result storage will be open in readwrite mode based 50cdf0e10cSrcweir on an arbitrary file system folder. 51cdf0e10cSrcweir </p> 52cdf0e10cSrcweir 53cdf0e10cSrcweir <p> 54cdf0e10cSrcweir In case 55cdf0e10cSrcweir <method scope="com::sun::star::lang">XSingleServiceFactory::createInstanceWithArguments</method> 56cdf0e10cSrcweir call is used a sequence of the following parameters can be used: 57cdf0e10cSrcweir </p> 58cdf0e10cSrcweir 59cdf0e10cSrcweir <dl> 60cdf0e10cSrcweir <dt>parameter 1</dt> 61cdf0e10cSrcweir <dd> 62cdf0e10cSrcweir specifies source of the object, it must be a string 63cdf0e10cSrcweir containing URL. 64cdf0e10cSrcweir </dd> 65cdf0e10cSrcweir 66cdf0e10cSrcweir <dt>parameter 2</dt> 67cdf0e10cSrcweir <dd> 68cdf0e10cSrcweir specifies mode the storage should be open in, can take 69cdf0e10cSrcweir values from <type>ElementModes</type> constant set. 70cdf0e10cSrcweir </dd> 71cdf0e10cSrcweir 72cdf0e10cSrcweir <dt>parameter 3</dt> 73cdf0e10cSrcweir <dd> 74cdf0e10cSrcweir allowes to provide 75cdf0e10cSrcweir <type scope="com::sun::star::document">MediaDescryptor</type> 76cdf0e10cSrcweir to the storage so some parts can be used for 77cdf0e10cSrcweir initialization, it can be for example 78cdf0e10cSrcweir <type scope="com::sun::star::task">XInteractionHandler</type> 79cdf0e10cSrcweir implementation. 80cdf0e10cSrcweir </dd> 81cdf0e10cSrcweir </dl> 82cdf0e10cSrcweir 83cdf0e10cSrcweir <p> 84cdf0e10cSrcweir The parameters are optional, that means that sequence can be empty or 85cdf0e10cSrcweir contain only first parameter, or first and second one. In case 86cdf0e10cSrcweir no parameters are provided the call works the same way as 87cdf0e10cSrcweir <member scope="com::sun::star::lang">XSingleServiceFactory::createInstance</member>. 88cdf0e10cSrcweir In case only first parameter is provided, the storage is opened in 89cdf0e10cSrcweir readonly mode. 90cdf0e10cSrcweir </p> 91cdf0e10cSrcweir 92cdf0e10cSrcweir <p> 93cdf0e10cSrcweir The opened storages can support read access in addition to 94cdf0e10cSrcweir specified one. 95cdf0e10cSrcweir </p> 96cdf0e10cSrcweir */ 97cdf0e10cSrcweir interface ::com::sun::star::lang::XSingleServiceFactory; 98cdf0e10cSrcweir}; 99cdf0e10cSrcweir 100cdf0e10cSrcweir//============================================================================ 101cdf0e10cSrcweir 102cdf0e10cSrcweir}; }; }; }; 103cdf0e10cSrcweir 104cdf0e10cSrcweir#endif 105cdf0e10cSrcweir 106