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