offapi/com/sun/star/ucb/PackageContentProvider.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 module com { module sun { module star { module ucb {
  22
  23 /** The Package Content Provider (PCP) implements a ContentProvider
  24     for the UniversalContentBroker (UCB).
  25
  26     <p>It provides access to packages ( zip / jar archive files ) containing
  27     folders and streams.
  28
  29     @see com::sun::star::ucb::Content
  30 */
  31 published service PackageContentProvider
  32 {
  33     /** provides two types of contents: Stream and Folder.
  34
  35         <p>
  36
  37         <b>PCP Contents</b>
  38         <ol>
  39         <li>
  40         A PCP Stream (PackageStreamContent) is a content which
  41         represents a file inside a package. It is always contained in a PCP
  42         Folder. A PCP Stream has no children.
  43         </li>
  44         <li>
  45         A PCP Folder (PackageFolderContent) is a container for
  46         other PCP Folders and PCP Streams.
  47         </li>
  48         </ol>
  49
  50         <p><b>URL Scheme for PCP Contents</b>
  51
  52         <p>Each HCP content has an identifier corresponding to the following
  53         scheme:
  54
  55         <ul>
  56         <li>
  57         package-URL    = "vnd.sun.star.pkg://" orig-URL [ abs-path ]
  58         </li>
  59         <li>
  60         abs-path       = "/" path-segments
  61         </li>
  62         <li>
  63         path-segments = segment *( "/" segment )
  64         </li>
  65         <li>
  66         segment        = pchar
  67         </li>
  68         <li>
  69         pchar          = unreserved | escaped | ":" | "@" | "&" | "="
  70                          | "+" | "$" | ","
  71         </li>
  72         <li>
  73         unreserved     = alphanum | mark
  74         </li>
  75         <li>
  76         mark           = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")"
  77         </li>
  78         <li>
  79         escaped        = "%" hex hex
  80         </li>
  81         <li>
  82         orig-URL       = 1 *( unreserved | escaped | "$" | "," | ";"
  83                          | ":" | "@" | "&" | "&" | "=" | "+"
  84         </li>
  85         </ul>
  86
  87         <p>Examples:
  88
  89         <ul>
  90         <li>
  91         vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/
  92         ( The root folder of the package located at file:///e:/my.xsw )
  93         </li>
  94         <li>
  95         vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content
  96         ( The folder/stream named "Content" that is contained in the root
  97         folder of the located at file:///e:/my.xsw )
  98         </li>
  99         <li>
 100         vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content%20A
 101         ( The folder/stream named "Content A" that is contained in the root
 102         folder of the located at file:///e:/my.xsw )
 103         </li>
 104         </ul>
 105
 106         </p>
 107      */
 108     interface com::sun::star::ucb::XContentProvider;
 109 };
 110
 111
 112 }; }; }; };
 113
 114 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */