LibreOffice
LibreOffice 5.0 SDK API Reference
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
Exported Interfaces | List of all members
HierarchyContentProvider Service Referencepublished

The Hierarchy Content Provider (HCP) implements a ContentProvider for the UniversalContentBroker (UCB). More...

import "HierarchyContentProvider.idl";

Inheritance diagram for HierarchyContentProvider:
XContentProvider XInterface

Exported Interfaces

interface com::sun::star::ucb::XContentProvider
 provides three types of contents: Link, Folder and Root 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...
 

Detailed Description

The Hierarchy Content Provider (HCP) implements a ContentProvider for the UniversalContentBroker (UCB).

It provides access to a persistent, customizable hierarchy of contents (folders and links).

See Also
com::sun::star::ucb::Content

Exported Interfaces

provides three types of contents: Link, Folder and Root Folder.

HCP Contents

  1. A HCP Link (HierarchyLinkContent) is a content which points to another (UCB) content. It is always contained in HCP Folder. A HCP Link has no children.
  2. A HCP Folder (HierarchyFolderContent) is a container for other HCP Folders and HCP Links.
  3. There is at most one instance of a HCP Root Folder ( HierarchyRootFolderContent ) at a time. All other HCP contents are children of this folder. The HCP Root Folder can contain HCP Folders and HCP Links. It has the URL "vnd.sun.star.hier:/".

URL Scheme for HCP Contents

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

  • vnd.sun.star.hier:/<path>, where <path> is a hierarchical path of the form <name>/.../<name> and where <name> is a string encoded according to the URL conventions.

Examples:

  • vnd.sun.star.hier:/ (The URL of the HCP Root Folder)
  • vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page
  • vnd.sun.star.hier:/Workplace/Printers

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