offapi/com/sun/star/ucb/HierarchyContentProvider.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: HierarchyContentProvider.idl,v $
  10  * $Revision: 1.7 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_HierarchyContentProvider_idl__
  31 #define __com_sun_star_ucb_HierarchyContentProvider_idl__
  32
  33 #ifndef __com_sun_star_ucb_XContentProvider_idl__
  34 #include <com/sun/star/ucb/XContentProvider.idl>
  35 #endif
  36
  37 //=============================================================================
  38
  39 module com { module sun { module star { module ucb {
  40
  41 //=============================================================================
  42 /** The Hierarchy Content Provider (HCP) implements a
  43     <type>ContentProvider</type> for the <type>UniversalContentBroker</type>
  44     (UCB).
  45
  46     <p>It provides access to a persistent, customizable hierarchy of contents
  47     (folders and links).
  48
  49     @see com::sun::star::ucb::Content
  50 */
  51 published service HierarchyContentProvider
  52 {
  53     //-------------------------------------------------------------------------
  54     /** provides three types of contents: Link, Folder and Root Folder.
  55
  56         <p>
  57
  58         <b>HCP Contents</b>
  59         <ol>
  60         <li>
  61         A HCP Link (<type>HierarchyLinkContent</type>) is a content which
  62         points to another (UCB) content. It is always contained in HCP Folder.
  63         A HCP Link has no children.
  64         </li>
  65         <li>
  66         A HCP Folder (<type>HierarchyFolderContent</type>) is a container for
  67         other HCP Folders and HCP Links.
  68         </li>
  69         <li>
  70         There is at most one instance of a HCP Root Folder
  71         ( <type>HierarchyRootFolderContent</type> ) at a time.
  72         All other HCP contents are children of this folder. The HCP Root
  73         Folder can contain HCP Folders and HCP Links. It has the URL
  74         "vnd.sun.star.hier:/".
  75         </li>
  76         </ol>
  77
  78         <p><b>URL Scheme for HCP Contents</b>
  79
  80         <p>Each HCP content has an identifier corresponding to the following
  81         scheme:
  82
  83         <ul>
  84         <li>
  85             vnd.sun.star.hier:/&lt;path&gt;, where &lt;path&gt; is a
  86             hierarchical path of the form &lt;name&gt;/.../&lt;name&gt; and
  87             where &lt;name&gt; is a string encoded according to the URL
  88             conventions.
  89         </li>
  90         </ul>
  91
  92         <p>Examples:
  93
  94         <ul>
  95         <li>
  96         vnd.sun.star.hier:/ (The URL of the HCP Root Folder)
  97         </li>
  98         <li>
  99         vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page
 100         </li>
 101         <li>
 102         vnd.sun.star.hier:/Workplace/Printers
 103         </li>
 104         </ul>
 105
 106         </p>
 107      */
 108     interface com::sun::star::ucb::XContentProvider;
 109 };
 110
 111 //=============================================================================
 112
 113 }; }; }; };
 114
 115 #endif