1*b1cdbd2cSJim Jagielski/************************************************************** 2*b1cdbd2cSJim Jagielski * 3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one 4*b1cdbd2cSJim Jagielski * or more contributor license agreements. See the NOTICE file 5*b1cdbd2cSJim Jagielski * distributed with this work for additional information 6*b1cdbd2cSJim Jagielski * regarding copyright ownership. The ASF licenses this file 7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the 8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance 9*b1cdbd2cSJim Jagielski * with the License. You may obtain a copy of the License at 10*b1cdbd2cSJim Jagielski * 11*b1cdbd2cSJim Jagielski * http://www.apache.org/licenses/LICENSE-2.0 12*b1cdbd2cSJim Jagielski * 13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing, 14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an 15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*b1cdbd2cSJim Jagielski * KIND, either express or implied. See the License for the 17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations 18*b1cdbd2cSJim Jagielski * under the License. 19*b1cdbd2cSJim Jagielski * 20*b1cdbd2cSJim Jagielski *************************************************************/ 21*b1cdbd2cSJim Jagielski 22*b1cdbd2cSJim Jagielski 23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_HierarchyContentProvider_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_HierarchyContentProvider_idl__ 25*b1cdbd2cSJim Jagielski 26*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_XContentProvider_idl__ 27*b1cdbd2cSJim Jagielski#include <com/sun/star/ucb/XContentProvider.idl> 28*b1cdbd2cSJim Jagielski#endif 29*b1cdbd2cSJim Jagielski 30*b1cdbd2cSJim Jagielski//============================================================================= 31*b1cdbd2cSJim Jagielski 32*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb { 33*b1cdbd2cSJim Jagielski 34*b1cdbd2cSJim Jagielski//============================================================================= 35*b1cdbd2cSJim Jagielski/** The Hierarchy Content Provider (HCP) implements a 36*b1cdbd2cSJim Jagielski <type>ContentProvider</type> for the <type>UniversalContentBroker</type> 37*b1cdbd2cSJim Jagielski (UCB). 38*b1cdbd2cSJim Jagielski 39*b1cdbd2cSJim Jagielski <p>It provides access to a persistent, customizable hierarchy of contents 40*b1cdbd2cSJim Jagielski (folders and links). 41*b1cdbd2cSJim Jagielski 42*b1cdbd2cSJim Jagielski @see com::sun::star::ucb::Content 43*b1cdbd2cSJim Jagielski*/ 44*b1cdbd2cSJim Jagielskipublished service HierarchyContentProvider 45*b1cdbd2cSJim Jagielski{ 46*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 47*b1cdbd2cSJim Jagielski /** provides three types of contents: Link, Folder and Root Folder. 48*b1cdbd2cSJim Jagielski 49*b1cdbd2cSJim Jagielski <p> 50*b1cdbd2cSJim Jagielski 51*b1cdbd2cSJim Jagielski <b>HCP Contents</b> 52*b1cdbd2cSJim Jagielski <ol> 53*b1cdbd2cSJim Jagielski <li> 54*b1cdbd2cSJim Jagielski A HCP Link (<type>HierarchyLinkContent</type>) is a content which 55*b1cdbd2cSJim Jagielski points to another (UCB) content. It is always contained in HCP Folder. 56*b1cdbd2cSJim Jagielski A HCP Link has no children. 57*b1cdbd2cSJim Jagielski </li> 58*b1cdbd2cSJim Jagielski <li> 59*b1cdbd2cSJim Jagielski A HCP Folder (<type>HierarchyFolderContent</type>) is a container for 60*b1cdbd2cSJim Jagielski other HCP Folders and HCP Links. 61*b1cdbd2cSJim Jagielski </li> 62*b1cdbd2cSJim Jagielski <li> 63*b1cdbd2cSJim Jagielski There is at most one instance of a HCP Root Folder 64*b1cdbd2cSJim Jagielski ( <type>HierarchyRootFolderContent</type> ) at a time. 65*b1cdbd2cSJim Jagielski All other HCP contents are children of this folder. The HCP Root 66*b1cdbd2cSJim Jagielski Folder can contain HCP Folders and HCP Links. It has the URL 67*b1cdbd2cSJim Jagielski "vnd.sun.star.hier:/". 68*b1cdbd2cSJim Jagielski </li> 69*b1cdbd2cSJim Jagielski </ol> 70*b1cdbd2cSJim Jagielski 71*b1cdbd2cSJim Jagielski <p><b>URL Scheme for HCP Contents</b> 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski <p>Each HCP content has an identifier corresponding to the following 74*b1cdbd2cSJim Jagielski scheme: 75*b1cdbd2cSJim Jagielski 76*b1cdbd2cSJim Jagielski <ul> 77*b1cdbd2cSJim Jagielski <li> 78*b1cdbd2cSJim Jagielski vnd.sun.star.hier:/<path>, where <path> is a 79*b1cdbd2cSJim Jagielski hierarchical path of the form <name>/.../<name> and 80*b1cdbd2cSJim Jagielski where <name> is a string encoded according to the URL 81*b1cdbd2cSJim Jagielski conventions. 82*b1cdbd2cSJim Jagielski </li> 83*b1cdbd2cSJim Jagielski </ul> 84*b1cdbd2cSJim Jagielski 85*b1cdbd2cSJim Jagielski <p>Examples: 86*b1cdbd2cSJim Jagielski 87*b1cdbd2cSJim Jagielski <ul> 88*b1cdbd2cSJim Jagielski <li> 89*b1cdbd2cSJim Jagielski vnd.sun.star.hier:/ (The URL of the HCP Root Folder) 90*b1cdbd2cSJim Jagielski </li> 91*b1cdbd2cSJim Jagielski <li> 92*b1cdbd2cSJim Jagielski vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page 93*b1cdbd2cSJim Jagielski </li> 94*b1cdbd2cSJim Jagielski <li> 95*b1cdbd2cSJim Jagielski vnd.sun.star.hier:/Workplace/Printers 96*b1cdbd2cSJim Jagielski </li> 97*b1cdbd2cSJim Jagielski </ul> 98*b1cdbd2cSJim Jagielski 99*b1cdbd2cSJim Jagielski </p> 100*b1cdbd2cSJim Jagielski */ 101*b1cdbd2cSJim Jagielski interface com::sun::star::ucb::XContentProvider; 102*b1cdbd2cSJim Jagielski}; 103*b1cdbd2cSJim Jagielski 104*b1cdbd2cSJim Jagielski//============================================================================= 105*b1cdbd2cSJim Jagielski 106*b1cdbd2cSJim Jagielski}; }; }; }; 107*b1cdbd2cSJim Jagielski 108*b1cdbd2cSJim Jagielski#endif 109