diff options
Diffstat (limited to 'offapi/com/sun/star/ucb/HierarchyContentProvider.idl')
| -rw-r--r-- | offapi/com/sun/star/ucb/HierarchyContentProvider.idl | 112 |
1 files changed, 112 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/HierarchyContentProvider.idl b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl new file mode 100644 index 000000000000..f5a975ed58b6 --- /dev/null +++ b/offapi/com/sun/star/ucb/HierarchyContentProvider.idl @@ -0,0 +1,112 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_ucb_HierarchyContentProvider_idl__ +#define __com_sun_star_ucb_HierarchyContentProvider_idl__ + +#ifndef __com_sun_star_ucb_XContentProvider_idl__ +#include <com/sun/star/ucb/XContentProvider.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ucb { + +//============================================================================= +/** The Hierarchy Content Provider (HCP) implements a + <type>ContentProvider</type> for the <type>UniversalContentBroker</type> + (UCB). + + <p>It provides access to a persistent, customizable hierarchy of contents + (folders and links). + + @see com::sun::star::ucb::Content +*/ +published service HierarchyContentProvider +{ + //------------------------------------------------------------------------- + /** provides three types of contents: Link, Folder and Root Folder. + + <p> + + <b>HCP Contents</b> + <ol> + <li> + A HCP Link (<type>HierarchyLinkContent</type>) is a content which + points to another (UCB) content. It is always contained in HCP Folder. + A HCP Link has no children. + </li> + <li> + A HCP Folder (<type>HierarchyFolderContent</type>) is a container for + other HCP Folders and HCP Links. + </li> + <li> + There is at most one instance of a HCP Root Folder + ( <type>HierarchyRootFolderContent</type> ) 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:/". + </li> + </ol> + + <p><b>URL Scheme for HCP Contents</b> + + <p>Each HCP content has an identifier corresponding to the following + scheme: + + <ul> + <li> + 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. + </li> + </ul> + + <p>Examples: + + <ul> + <li> + vnd.sun.star.hier:/ (The URL of the HCP Root Folder) + </li> + <li> + vnd.sun.star.hier:/Bookmarks/Sun%20Microsystems%20Home%20Page + </li> + <li> + vnd.sun.star.hier:/Workplace/Printers + </li> + </ul> + + </p> + */ + interface com::sun::star::ucb::XContentProvider; +}; + +//============================================================================= + +}; }; }; }; + +#endif |