1/************************************************************************* 2 * 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * Copyright 2000, 2010 Oracle and/or its affiliates. 6 * 7 * OpenOffice.org - a multi-platform office productivity suite 8 * 9 * This file is part of OpenOffice.org. 10 * 11 * OpenOffice.org is free software: you can redistribute it and/or modify 12 * it under the terms of the GNU Lesser General Public License version 3 13 * only, as published by the Free Software Foundation. 14 * 15 * OpenOffice.org is distributed in the hope that it will be useful, 16 * but WITHOUT ANY WARRANTY; without even the implied warranty of 17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 18 * GNU Lesser General Public License version 3 for more details 19 * (a copy is included in the LICENSE file that accompanied this code). 20 * 21 * You should have received a copy of the GNU Lesser General Public License 22 * version 3 along with OpenOffice.org. If not, see 23 * <http://www.openoffice.org/license.html> 24 * for a copy of the LGPLv3 License. 25 * 26 ************************************************************************/ 27#ifndef __com_sun_star_ucb_HierarchyFolderContent_idl__ 28#define __com_sun_star_ucb_HierarchyFolderContent_idl__ 29 30#ifndef __com_sun_star_lang_XComponent_idl__ 31#include <com/sun/star/lang/XComponent.idl> 32#endif 33 34#ifndef __com_sun_star_ucb_XContent_idl__ 35#include <com/sun/star/ucb/XContent.idl> 36#endif 37 38#ifndef __com_sun_star_ucb_XCommandProcessor_idl__ 39#include <com/sun/star/ucb/XCommandProcessor.idl> 40#endif 41 42#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__ 43#include <com/sun/star/ucb/XCommandProcessor2.idl> 44#endif 45 46#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__ 47#include <com/sun/star/beans/XPropertiesChangeNotifier.idl> 48#endif 49 50#ifndef __com_sun_star_beans_XPropertyContainer_idl__ 51#include <com/sun/star/beans/XPropertyContainer.idl> 52#endif 53 54#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__ 55#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl> 56#endif 57 58#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__ 59#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl> 60#endif 61 62#ifndef __com_sun_star_container_XChild_idl__ 63#include <com/sun/star/container/XChild.idl> 64#endif 65 66#ifndef __com_sun_star_ucb_XContentCreator_idl__ 67#include <com/sun/star/ucb/XContentCreator.idl> 68#endif 69 70//============================================================================= 71 72module com { module sun { module star { module ucb { 73 74//============================================================================= 75/** A HCP Folder is a container for other HCP Folders and HCP Links. 76 77 @see com::sun::star::ucb::HierarchyContentProvider 78 @see com::sun::star::ucb::HierarchyRootFolderContent 79 @see com::sun::star::ucb::HierarchyLinkContent 80*/ 81published service HierarchyFolderContent 82{ 83 //------------------------------------------------------------------------- 84 /** This interface is implemented according to the specification of 85 service <type>Content</type>. 86 */ 87 interface com::sun::star::lang::XComponent; 88 89 //------------------------------------------------------------------------- 90 /** This interface is implemented according to the specification of 91 service <type>Content</type>. 92 */ 93 interface com::sun::star::ucb::XContent; 94 95 //------------------------------------------------------------------------- 96 /** This interface is implemented according to the specification of 97 service <type>Content</type>. 98 99 <p> 100 101 <b>Supported Commands</b> 102 <ul> 103 <li> 104 getCommandInfo 105 </li> 106 <li> 107 getPropertySetInfo 108 </li> 109 <li> 110 getPropertyValues 111 </li> 112 <li> 113 setPropertyValues 114 </li> 115 <li> 116 insert ( makes a newly created folder persistent ) 117 </li> 118 <li> 119 delete 120 </li> 121 <li> 122 open 123 </li> 124 <li> 125 transfer ( only transfers from one hierarchy folder to another supported ) 126 </li> 127 </ul> 128 129 <b>Supported Properties</b> 130 <ul> 131 <li> 132 string ContentType ( read-only, always "application/vnd.sun.star.hier-folder" ) 133 </li> 134 <li> 135 boolean IsDocument ( read-only, always false ) 136 </li> 137 <li> 138 boolean IsFolder ( read-only, always true ) 139 </li> 140 <li> 141 string Title 142 </li> 143 </ul> 144 145 </p> 146 */ 147 interface com::sun::star::ucb::XCommandProcessor; 148 149 //------------------------------------------------------------------------- 150 /** is an enhanced version of <type>XCommandProcessor</type> that has an 151 additional method for releasing command identifiers obtained via 152 <member>XCommandProcessor::createCommandIdentifier</member> to avoid 153 resource leaks. For a detailed description of the problem refer to 154 <member>XCommandProcessor2::releaseCommandIdentifier</member>. 155 156 <p>Where many existing <type>Content</type> implementations do not 157 (yet), every new implementation should support this interface. 158 */ 159 [optional] interface com::sun::star::ucb::XCommandProcessor2; 160 161 //------------------------------------------------------------------------- 162 /** This interface is implemented according to the specification of 163 service <type>Content</type>. 164 */ 165 interface com::sun::star::beans::XPropertiesChangeNotifier; 166 167 //------------------------------------------------------------------------- 168 /** This interface is implemented according to the specification of 169 service <type>Content</type>. 170 */ 171 interface com::sun::star::beans::XPropertyContainer; 172 173 //------------------------------------------------------------------------- 174 /** This interface is implemented according to the specification of 175 service <type>Content</type>. 176 */ 177 interface com::sun::star::beans::XPropertySetInfoChangeNotifier; 178 179 //------------------------------------------------------------------------- 180 /** This interface is implemented according to the specification of 181 service <type>Content</type>. 182 */ 183 interface com::sun::star::ucb::XCommandInfoChangeNotifier; 184 185 //------------------------------------------------------------------------- 186 /** This interface is implemented according to the specification of 187 service <type>Content</type>. 188 */ 189 interface com::sun::star::container::XChild; 190 191 //------------------------------------------------------------------------- 192 /** This interface is implemented according to the specification of 193 service <type>Content</type>. 194 195 <p> 196 197 A HCP Folder can create other HCP Folders and HCP Links. To create 198 a new child of a HCP Folder: 199 200 <ol> 201 <li> 202 Let the parent folder create a new content by calling 203 <member>XContentCreator::createNewContent</member> on it. The content 204 type to use for new folders is "application/vnd.sun.star.hier-folder". 205 To create a new link, use the type "application/vnd.sun.star.hier-link". 206 </li> 207 <li> 208 Set a title at the new folder / link. ( Let the new child execute 209 the command "setPropertyValues", which sets at least the property 210 "Title" to a non-empty value ). For a link, you need to set the 211 property "TargetURL" as well to a non-empty value. 212 </li> 213 <li> 214 Let the new child ( not the parent! ) execute the command "insert". 215 This will commit the creation process. 216 </li> 217 </ol> 218 219 </p> 220 */ 221 interface com::sun::star::ucb::XContentCreator; 222}; 223 224//============================================================================= 225 226}; }; }; }; 227 228#endif 229