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