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