From ed5640d8b587fbcfed7dd7967f3de04b37a76f26 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Sun, 7 Apr 2024 11:06:44 +0200 Subject: Adding upstream version 4:7.4.7. Signed-off-by: Daniel Baumann --- offapi/com/sun/star/ucb/PackageContentProvider.idl | 120 +++++++++++++++++++++ 1 file changed, 120 insertions(+) create mode 100644 offapi/com/sun/star/ucb/PackageContentProvider.idl (limited to 'offapi/com/sun/star/ucb/PackageContentProvider.idl') diff --git a/offapi/com/sun/star/ucb/PackageContentProvider.idl b/offapi/com/sun/star/ucb/PackageContentProvider.idl new file mode 100644 index 000000000..ae51059ce --- /dev/null +++ b/offapi/com/sun/star/ucb/PackageContentProvider.idl @@ -0,0 +1,120 @@ +/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */ +/* + * This file is part of the LibreOffice project. + * + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + * + * This file incorporates work covered by the following license notice: + * + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed + * with this work for additional information regarding copyright + * ownership. The ASF licenses this file to you under the Apache + * License, Version 2.0 (the "License"); you may not use this file + * except in compliance with the License. You may obtain a copy of + * the License at http://www.apache.org/licenses/LICENSE-2.0 . + */ +#ifndef __com_sun_star_ucb_PackageContentProvider_idl__ +#define __com_sun_star_ucb_PackageContentProvider_idl__ + +#include + + +module com { module sun { module star { module ucb { + +/** The Package Content Provider (PCP) implements a ContentProvider + for the UniversalContentBroker (UCB). + +

It provides access to packages ( zip / jar archive files ) containing + folders and streams. + + @see com::sun::star::ucb::Content +*/ +published service PackageContentProvider +{ + /** provides two types of contents: Stream and Folder. + +

+ + PCP Contents +

    +
  1. + A PCP Stream (PackageStreamContent) is a content which + represents a file inside a package. It is always contained in a PCP + Folder. A PCP Stream has no children. +
    2. +
  2. + A PCP Folder (PackageFolderContent) is a container for + other PCP Folders and PCP Streams. +
    3. +
+ +

URL Scheme for PCP Contents + +

Each HCP content has an identifier corresponding to the following + scheme: + +

    +
  • + package-URL = "vnd.sun.star.pkg://" orig-URL [ abs-path ] +
    • +
  • + abs-path = "/" path-segments +
    • +
  • + path-segments = segment *( "/" segment ) +
    • +
  • + segment = pchar +
    • +
  • + pchar = unreserved | escaped | ":" | "@" | "&" | "=" + | "+" | "$" | "," +
    • +
  • + unreserved = alphanum | mark +
    • +
  • + mark = "-" | "_" | "." | "!" | "~" | "*" | "'" | "(" | ")" +
    • +
  • + escaped = "%" hex hex +
    • +
  • + orig-URL = 1 *( unreserved | escaped | "$" | "," | ";" + | ":" | "@" | "&" | "&" | "=" | "+" +
    • +
+ +

Examples: + +

    +
  • + vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/ + ( The root folder of the package located at file:///e:/my.xsw ) +
    • +
  • + vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content + ( The folder/stream named "Content" that is contained in the root + folder of the located at file:///e:/my.xsw ) +
    • +
  • + vnd.sun.star.pkg://file:%2F%2F%2Fe:%2Fmy.xsw/Content%20A + ( The folder/stream named "Content A" that is contained in the root + folder of the located at file:///e:/my.xsw ) +
    • +
+ +

+ */ + interface com::sun::star::ucb::XContentProvider; +}; + + +}; }; }; }; + +#endif + +/* vim:set shiftwidth=4 softtabstop=4 expandtab: */ -- cgit v1.2.3