offapi/com/sun/star/ucb/FileContentProvider.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 #ifndef __com_sun_star_ucb_FileContentProvider_idl__
  20 #define __com_sun_star_ucb_FileContentProvider_idl__
  21
  22 #include <com/sun/star/ucb/XContentProvider.idl>
  23 #include <com/sun/star/ucb/XFileIdentifierConverter.idl>
  24 #include <com/sun/star/ucb/XContentIdentifierFactory.idl>
  25 #include <com/sun/star/beans/XPropertySet.idl>
  26
  27
  28 module com { module sun { module star { module ucb {
  29
  30 /** The File Content Provider (FCP) implements a ContentProvider
  31     for the UniversalContentBroker (UCB).
  32
  33     <p>The served contents enable access to the local file system.
  34
  35     <p>The FCP is able to restrict access to the local file system to a number
  36     of directories shown to the client under configurable alias names.
  37
  38     @see com::sun::star::ucb::Content
  39 */
  40 published service FileContentProvider
  41 {
  42     /** provides an object representing either a directory or a file in the
  43         local file system.
  44
  45         @see com::sun::star::ucb::FileContent
  46      */
  47
  48     interface com::sun::star::ucb::XContentProvider;
  49
  50     /** This interface is implemented according to the specification of
  51         service ContentProvider.
  52     */
  53
  54     interface com::sun::star::ucb::XContentIdentifierFactory;
  55
  56     /** provides access to properties supported by the UCP.
  57
  58         <p> The supported properties give two kinds of meta-information about
  59         the environment of the FCP, namely property <b>HostName</b> containing
  60         the name of the computer, and property <b>FileSystemNotation</b>
  61         determining which system dependent notation the file system identifier
  62         follow.
  63
  64            <p>
  65
  66            <b>Supported Properties</b>
  67            <ul>
  68            <li>
  69            string HostName ( read-only )
  70            </li>
  71            <li>
  72            long FileSystemNotation ( read-only, the value is one of the
  73         FileSystemNotation constants )
  74            </li>
  75            </ul>
  76
  77            </p>
  78     */
  79
  80     interface com::sun::star::beans::XPropertySet;
  81
  82     /** specifies methods to convert between (file) URLs and file paths in
  83         system dependent notation
  84     */
  85
  86     interface com::sun::star::ucb::XFileIdentifierConverter;
  87 };
  88
  89
  90 }; }; }; };
  91
  92 #endif
  93
  94 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */