LibreOffice
LibreOffice 6.2 SDK API Reference
Exported Interfaces | List of all members
PackageContentProvider Service Referencepublished

The Package Content Provider (PCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...

import"PackageContentProvider.idl";

Inheritance diagram for PackageContentProvider:
XContentProvider XInterface

Exported Interfaces

interface com::sun::star::ucb::XContentProvider
 provides two types of contents: Stream and Folder. More...
 

Additional Inherited Members

- Public Member Functions inherited from XContentProvider
com::sun::star::ucb::XContent queryContent ([in] com::sun::star::ucb::XContentIdentifier Identifier) raises ( com::sun::star::ucb::IllegalIdentifierException )
 creates a new XContent instance, if the given XContentIdentifier matches a content provided by the implementation of this interface. More...
 
long compareContentIds ([in] com::sun::star::ucb::XContentIdentifier Id1, [in] com::sun::star::ucb::XContentIdentifier Id2)
 compares two XContentIdentifiers. More...
 
- Public Member Functions inherited from XInterface
any queryInterface ([in] type aType)
 queries for a new interface to an existing UNO object. More...
 
void acquire ()
 increases the reference counter by one. More...
 
void release ()
 decreases the reference counter by one. More...
 

Detailed Description

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 also
com::sun::star::ucb::Content

Exported Interfaces

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. A PCP Folder (PackageFolderContent) is a container for other PCP Folders and PCP Streams.

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 )

The documentation for this service was generated from the following file: