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_PackageFolderContent_idl__ 24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_PackageFolderContent_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 PCP Folder is a container for other PCP Folders and PCP Streams. 72*b1cdbd2cSJim Jagielski 73*b1cdbd2cSJim Jagielski @see com::sun::star::ucb::PackageContentProvider 74*b1cdbd2cSJim Jagielski @see com::sun::star::ucb::PackageStreamContent 75*b1cdbd2cSJim Jagielski*/ 76*b1cdbd2cSJim Jagielskipublished service PackageFolderContent 77*b1cdbd2cSJim Jagielski{ 78*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 79*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 80*b1cdbd2cSJim Jagielski service <type>Content</type>. 81*b1cdbd2cSJim Jagielski */ 82*b1cdbd2cSJim Jagielski interface com::sun::star::lang::XComponent; 83*b1cdbd2cSJim Jagielski 84*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 85*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 86*b1cdbd2cSJim Jagielski service <type>Content</type>. 87*b1cdbd2cSJim Jagielski */ 88*b1cdbd2cSJim Jagielski interface com::sun::star::ucb::XContent; 89*b1cdbd2cSJim Jagielski 90*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 91*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 92*b1cdbd2cSJim Jagielski service <type>Content</type>. 93*b1cdbd2cSJim Jagielski 94*b1cdbd2cSJim Jagielski <p> 95*b1cdbd2cSJim Jagielski 96*b1cdbd2cSJim Jagielski <b>Supported Commands</b> 97*b1cdbd2cSJim Jagielski <ul> 98*b1cdbd2cSJim Jagielski <li> 99*b1cdbd2cSJim Jagielski getCommandInfo 100*b1cdbd2cSJim Jagielski </li> 101*b1cdbd2cSJim Jagielski <li> 102*b1cdbd2cSJim Jagielski getPropertySetInfo 103*b1cdbd2cSJim Jagielski </li> 104*b1cdbd2cSJim Jagielski <li> 105*b1cdbd2cSJim Jagielski getPropertyValues 106*b1cdbd2cSJim Jagielski </li> 107*b1cdbd2cSJim Jagielski <li> 108*b1cdbd2cSJim Jagielski setPropertyValues 109*b1cdbd2cSJim Jagielski </li> 110*b1cdbd2cSJim Jagielski <li> 111*b1cdbd2cSJim Jagielski insert ( makes a newly created folder persistent ) 112*b1cdbd2cSJim Jagielski </li> 113*b1cdbd2cSJim Jagielski <li> 114*b1cdbd2cSJim Jagielski delete 115*b1cdbd2cSJim Jagielski </li> 116*b1cdbd2cSJim Jagielski <li> 117*b1cdbd2cSJim Jagielski open 118*b1cdbd2cSJim Jagielski </li> 119*b1cdbd2cSJim Jagielski <li> 120*b1cdbd2cSJim Jagielski transfer ( only transfers from PCP Folders/PCP Streams to other 121*b1cdbd2cSJim Jagielski PCP folders. It does not handle contents with a URL scheme other 122*b1cdbd2cSJim Jagielski then the PCP-URL-scheme. ) 123*b1cdbd2cSJim Jagielski </li> 124*b1cdbd2cSJim Jagielski <li> 125*b1cdbd2cSJim Jagielski flush ( a command introduced by the PCP Folder. It takes a 126*b1cdbd2cSJim Jagielski void-argument and returns void. This command is used to write unsaved 127*b1cdbd2cSJim Jagielski changes to the underlying package file. Note that the current 128*b1cdbd2cSJim Jagielski implementation of PCP contents never flushes automatically! Operations 129*b1cdbd2cSJim Jagielski which require a flush to get persistent, are: 130*b1cdbd2cSJim Jagielski "setPropertyValues( < any_non_read_only_property > ) ", "delete", 131*b1cdbd2cSJim Jagielski "insert" ) 132*b1cdbd2cSJim Jagielski </li> 133*b1cdbd2cSJim Jagielski </ul> 134*b1cdbd2cSJim Jagielski 135*b1cdbd2cSJim Jagielski <b>Supported Properties</b> 136*b1cdbd2cSJim Jagielski <ul> 137*b1cdbd2cSJim Jagielski <li> 138*b1cdbd2cSJim Jagielski string ContentType ( read-only, always "application/vnd.sun.star.pkg-folder" ) 139*b1cdbd2cSJim Jagielski </li> 140*b1cdbd2cSJim Jagielski <li> 141*b1cdbd2cSJim Jagielski boolean IsDocument ( read-only, always false ) 142*b1cdbd2cSJim Jagielski </li> 143*b1cdbd2cSJim Jagielski <li> 144*b1cdbd2cSJim Jagielski boolean IsFolder ( read-only, always true ) 145*b1cdbd2cSJim Jagielski </li> 146*b1cdbd2cSJim Jagielski <li> 147*b1cdbd2cSJim Jagielski string MediaType 148*b1cdbd2cSJim Jagielski </li> 149*b1cdbd2cSJim Jagielski <li> 150*b1cdbd2cSJim Jagielski string Title 151*b1cdbd2cSJim Jagielski </li> 152*b1cdbd2cSJim Jagielski </ul> 153*b1cdbd2cSJim Jagielski 154*b1cdbd2cSJim Jagielski </p> 155*b1cdbd2cSJim Jagielski */ 156*b1cdbd2cSJim Jagielski interface com::sun::star::ucb::XCommandProcessor; 157*b1cdbd2cSJim Jagielski 158*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 159*b1cdbd2cSJim Jagielski /** is an enhanced version of <type>XCommandProcessor</type> that has an 160*b1cdbd2cSJim Jagielski additional method for releasing command identifiers obtained via 161*b1cdbd2cSJim Jagielski <member>XCommandProcessor::createCommandIdentifier</member> to avoid 162*b1cdbd2cSJim Jagielski resource leaks. For a detailed description of the problem refer to 163*b1cdbd2cSJim Jagielski <member>XCommandProcessor2::releaseCommandIdentifier</member>. 164*b1cdbd2cSJim Jagielski 165*b1cdbd2cSJim Jagielski <p>Where many existing <type>Content</type> implementations do not 166*b1cdbd2cSJim Jagielski (yet), every new implementation should support this interface. 167*b1cdbd2cSJim Jagielski */ 168*b1cdbd2cSJim Jagielski [optional] interface com::sun::star::ucb::XCommandProcessor2; 169*b1cdbd2cSJim Jagielski 170*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 171*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 172*b1cdbd2cSJim Jagielski service <type>Content</type>. 173*b1cdbd2cSJim Jagielski */ 174*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertiesChangeNotifier; 175*b1cdbd2cSJim Jagielski 176*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 177*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 178*b1cdbd2cSJim Jagielski service <type>Content</type>. 179*b1cdbd2cSJim Jagielski */ 180*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertyContainer; 181*b1cdbd2cSJim Jagielski 182*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 183*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 184*b1cdbd2cSJim Jagielski service <type>Content</type>. 185*b1cdbd2cSJim Jagielski */ 186*b1cdbd2cSJim Jagielski interface com::sun::star::beans::XPropertySetInfoChangeNotifier; 187*b1cdbd2cSJim Jagielski 188*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 189*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 190*b1cdbd2cSJim Jagielski service <type>Content</type>. 191*b1cdbd2cSJim Jagielski */ 192*b1cdbd2cSJim Jagielski interface com::sun::star::ucb::XCommandInfoChangeNotifier; 193*b1cdbd2cSJim Jagielski 194*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 195*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 196*b1cdbd2cSJim Jagielski service <type>Content</type>. 197*b1cdbd2cSJim Jagielski */ 198*b1cdbd2cSJim Jagielski interface com::sun::star::container::XChild; 199*b1cdbd2cSJim Jagielski 200*b1cdbd2cSJim Jagielski //------------------------------------------------------------------------- 201*b1cdbd2cSJim Jagielski /** This interface is implemented according to the specification of 202*b1cdbd2cSJim Jagielski service <type>Content</type>. 203*b1cdbd2cSJim Jagielski 204*b1cdbd2cSJim Jagielski <p> 205*b1cdbd2cSJim Jagielski 206*b1cdbd2cSJim Jagielski A PCP Folder can create other PCP Folders and PCP Streams. To create 207*b1cdbd2cSJim Jagielski a new child of a PCP Folder: 208*b1cdbd2cSJim Jagielski 209*b1cdbd2cSJim Jagielski <ol> 210*b1cdbd2cSJim Jagielski <li> 211*b1cdbd2cSJim Jagielski Let the parent folder create a new content by calling 212*b1cdbd2cSJim Jagielski <member>XContentCreator::createNewContent</member> on it. The content 213*b1cdbd2cSJim Jagielski type to use for new folders is "application/vnd.sun.star.pkg-folder". 214*b1cdbd2cSJim Jagielski To create a new PCP Stream, use the type 215*b1cdbd2cSJim Jagielski "application/vnd.sun.star.pkg-stream". 216*b1cdbd2cSJim Jagielski </li> 217*b1cdbd2cSJim Jagielski <li> 218*b1cdbd2cSJim Jagielski Set a title at the new folder / stream. ( Let the new child execute 219*b1cdbd2cSJim Jagielski the command "setPropertyValues", which sets at least the property 220*b1cdbd2cSJim Jagielski "Title" to a non-empty value ). 221*b1cdbd2cSJim Jagielski </li> 222*b1cdbd2cSJim Jagielski <li> 223*b1cdbd2cSJim Jagielski Let the new child ( not the parent! ) execute the command "insert". 224*b1cdbd2cSJim Jagielski This will commit the creation process. For streams, you need to supply 225*b1cdbd2cSJim Jagielski the implementation of an 226*b1cdbd2cSJim Jagielski <type scope="com::sun::star::io">XInputStream</type> with the command's 227*b1cdbd2cSJim Jagielski parameters, that provides access to the stream data. 228*b1cdbd2cSJim Jagielski </li> 229*b1cdbd2cSJim Jagielski </ol> 230*b1cdbd2cSJim Jagielski 231*b1cdbd2cSJim Jagielski </p> 232*b1cdbd2cSJim Jagielski 233*b1cdbd2cSJim Jagielski <p> 234*b1cdbd2cSJim Jagielski Another, more convenient way for creating streams is simply to assemble 235*b1cdbd2cSJim Jagielski the URL for the new content ( last part of the path will become the 236*b1cdbd2cSJim Jagielski title of the new stream ) and to obtain a Content object for that URL 237*b1cdbd2cSJim Jagielski from the UCB. Then let the content execute the command "insert". The 238*b1cdbd2cSJim Jagielski command will fail, if you set the command's parameter 239*b1cdbd2cSJim Jagielski <member>InsertCommandArgument::ReplaceExisting"</member> 240*b1cdbd2cSJim Jagielski to false and there is already a stream with the title given by the 241*b1cdbd2cSJim Jagielski content's URL. 242*b1cdbd2cSJim Jagielski 243*b1cdbd2cSJim Jagielski </p> 244*b1cdbd2cSJim Jagielski */ 245*b1cdbd2cSJim Jagielski interface com::sun::star::ucb::XContentCreator; 246*b1cdbd2cSJim Jagielski}; 247*b1cdbd2cSJim Jagielski 248*b1cdbd2cSJim Jagielski//============================================================================= 249*b1cdbd2cSJim Jagielski 250*b1cdbd2cSJim Jagielski}; }; }; }; 251*b1cdbd2cSJim Jagielski 252*b1cdbd2cSJim Jagielski#endif 253