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