diff options
Diffstat (limited to 'offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl')
| -rw-r--r-- | offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl | 240 |
1 files changed, 240 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl new file mode 100644 index 000000000000..a2233e4c5f40 --- /dev/null +++ b/offapi/com/sun/star/ucb/TransientDocumentsFolderContent.idl @@ -0,0 +1,240 @@ +/************************************************************************* + * + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. + * + * Copyright 2000, 2010 Oracle and/or its affiliates. + * + * OpenOffice.org - a multi-platform office productivity suite + * + * This file is part of OpenOffice.org. + * + * OpenOffice.org is free software: you can redistribute it and/or modify + * it under the terms of the GNU Lesser General Public License version 3 + * only, as published by the Free Software Foundation. + * + * OpenOffice.org is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU Lesser General Public License version 3 for more details + * (a copy is included in the LICENSE file that accompanied this code). + * + * You should have received a copy of the GNU Lesser General Public License + * version 3 along with OpenOffice.org. If not, see + * <http://www.openoffice.org/license.html> + * for a copy of the LGPLv3 License. + * + ************************************************************************/ +#ifndef __com_sun_star_ucb_TransientDocumentsFolderContent_idl__ +#define __com_sun_star_ucb_TransientDocumentsFolderContent_idl__ + +#ifndef __com_sun_star_lang_XComponent_idl__ +#include <com/sun/star/lang/XComponent.idl> +#endif + +#ifndef __com_sun_star_ucb_XContent_idl__ +#include <com/sun/star/ucb/XContent.idl> +#endif + +#ifndef __com_sun_star_ucb_XCommandProcessor_idl__ +#include <com/sun/star/ucb/XCommandProcessor.idl> +#endif + +#ifndef __com_sun_star_ucb_XCommandProcessor2_idl__ +#include <com/sun/star/ucb/XCommandProcessor2.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__ +#include <com/sun/star/beans/XPropertiesChangeNotifier.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertyContainer_idl__ +#include <com/sun/star/beans/XPropertyContainer.idl> +#endif + +#ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__ +#include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl> +#endif + +#ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__ +#include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl> +#endif + +#ifndef __com_sun_star_container_XChild_idl__ +#include <com/sun/star/container/XChild.idl> +#endif + +#ifndef __com_sun_star_ucb_XContentCreator_idl__ +#include <com/sun/star/ucb/XContentCreator.idl> +#endif + +//============================================================================= + +module com { module sun { module star { module ucb { + +//============================================================================= +/** A TDCP Folder is a container for other TDCP Folders and TDCP Streams. + + <p>It may be contained in another TDCP Folder or in a TDCP Document. + + @see TransientDocumentsContentProvider + @see TransientDocumentsRootContent + @see TransientDocumentsDocumentContent + @see TransientDocumentsStreamContent + + @since OOo 2.0.0 +*/ +service TransientDocumentsFolderContent +{ + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::lang::XComponent; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::ucb::XContent; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + + <p> + + <b>Supported Commands</b> + <ul> + <li> + getCommandInfo + </li> + <li> + getPropertySetInfo + </li> + <li> + getPropertyValues + </li> + <li> + setPropertyValues + </li> + <li> + open + </li> + <li> + insert + </li> + <li> + delete + </li> + <li> + transfer (only transfers TDCP documents, TDCP folders and TDCP streams. + It does not handle contents with a URL scheme other than the TDOC URL + scheme) + </li> + </ul> + + <b>Supported Properties</b> + <ul> + <li> + string ContentType ( read-only, always "application/vnd.sun.star.tdoc-folder" ) + </li> + <li> + boolean IsDocument ( read-only, always false ) + </li> + <li> + boolean IsFolder ( read-only, always true ) + </li> + <li> + string Title + </li> + <li> + <type scope="com::sun::star::embed">XStorage</type> Storage ( read-only, + always a reference to a storage opened in read-only mode. No write + operations are possible. TDCP contents must be used for writing.) + </li> + </ul> + + </p> + */ + interface com::sun::star::ucb::XCommandProcessor; + + //------------------------------------------------------------------------- + /** is an enhanced version of <type>XCommandProcessor</type> that has an + additional method for releasing command identifiers obtained via + <member>XCommandProcessor::createCommandIdentifier</member> to avoid + resource leaks. For a detailed description of the problem refer to + <member>XCommandProcessor2::releaseCommandIdentifier</member>. + + <p>Where many existing <type>Content</type> implementations do not + (yet), every new implementation should support this interface. + */ + [optional] interface com::sun::star::ucb::XCommandProcessor2; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::beans::XPropertiesChangeNotifier; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::beans::XPropertyContainer; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::beans::XPropertySetInfoChangeNotifier; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::ucb::XCommandInfoChangeNotifier; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + */ + interface com::sun::star::container::XChild; + + //------------------------------------------------------------------------- + /** This interface is implemented according to the specification of + service <type>Content</type>. + + <p>To create a new child of a TDCP Folder: + + <ol> + <li> + Let the parent folder create a new content by calling + <member>XContentCreator::createNewContent</member> on it. The content + type to use for new folders is "application/vnd.sun.star.tdoc-folder". + To create a new stream, use the type string + "application/vnd.sun.star.tdoc-stream". + </li> + <li> + Set a title for the new folder/stream. (Let the new child execute the + command "setPropertyValues"; pass a non-empty value for the property + "Title"). + </li> + <li> + Let the new child ( not the parent! ) execute the command "insert". + This will commit the creation process. For streams, you need to supply + the implementation of an + <type scope="com::sun::star::io">XInputStream</type> with the command's + parameters, that provides access to the stream data. + </li> + </ol> + + </p> + */ + interface com::sun::star::ucb::XContentCreator; +}; + +//============================================================================= + +}; }; }; }; + +#endif |