offapi/com/sun/star/ucb/HierarchyContentProvider.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_HierarchyContentProvider_idl__
  20 #define __com_sun_star_ucb_HierarchyContentProvider_idl__
  21
  22 #include <com/sun/star/ucb/XContentProvider.idl>
  23
  24
  25 module com { module sun { module star { module ucb {
  26
  27 /** The Hierarchy Content Provider (HCP) implements a
  28     ContentProvider for the UniversalContentBroker
  29     (UCB).
  30
  31     <p>It provides access to a persistent, customizable hierarchy of contents
  32     (folders and links).
  33
  34     @see com::sun::star::ucb::Content
  35 */
  36 published service HierarchyContentProvider
  37 {
  38     /** provides three types of contents: Link, Folder and Root Folder.
  39
  40         <p>
  41
  42         <b>HCP Contents</b>
  43         <ol>
  44         <li>
  45         A HCP Link (HierarchyLinkContent) is a content which
  46         points to another (UCB) content. It is always contained in HCP Folder.
  47         A HCP Link has no children.
  48         </li>
  49         <li>
  50         A HCP Folder (HierarchyFolderContent) is a container for
  51         other HCP Folders and HCP Links.
  52         </li>
  53         <li>
  54         There is at most one instance of a HCP Root Folder
  55         ( HierarchyRootFolderContent ) at a time.
  56         All other HCP contents are children of this folder. The HCP Root
  57         Folder can contain HCP Folders and HCP Links. It has the URL
  58         "vnd.sun.star.hier:/".
  59         </li>
  60         </ol>
  61
  62         <p><b>URL Scheme for HCP Contents</b>
  63
  64         <p>Each HCP content has an identifier corresponding to the following
  65         scheme:
  66
  67         <ul>
  68         <li>
  69             vnd.sun.star.hier:/&lt;path&gt;, where &lt;path&gt; is a
  70             hierarchical path of the form &lt;name&gt;/.../&lt;name&gt; and
  71             where &lt;name&gt; is a string encoded according to the URL
  72             conventions.
  73         </li>
  74         </ul>
  75
  76         <p>Examples:
  77
  78         <ul>
  79         <li>
  80         vnd.sun.star.hier:/ (The URL of the HCP Root Folder)
  81         </li>
  82         <li>
  83         vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page
  84         </li>
  85         <li>
  86         vnd.sun.star.hier:/Workplace/Printers
  87         </li>
  88         </ul>
  89
  90         </p>
  91      */
  92     interface com::sun::star::ucb::XContentProvider;
  93 };
  94
  95
  96 }; }; }; };
  97
  98 #endif
  99
 100 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */