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