| /************************************************************** |
| * |
| * Licensed to the Apache Software Foundation (ASF) under one |
| * or more contributor license agreements. See the NOTICE file |
| * distributed with this work for additional information |
| * regarding copyright ownership. The ASF licenses this file |
| * to you under the Apache License, Version 2.0 (the |
| * "License"); you may not use this file except in compliance |
| * with the License. You may obtain a copy of the License at |
| * |
| * http://www.apache.org/licenses/LICENSE-2.0 |
| * |
| * Unless required by applicable law or agreed to in writing, |
| * software distributed under the License is distributed on an |
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY |
| * KIND, either express or implied. See the License for the |
| * specific language governing permissions and limitations |
| * under the License. |
| * |
| *************************************************************/ |
| |
| |
| #ifndef __com_sun_star_ucb_PackageFolderContent_idl__ |
| #define __com_sun_star_ucb_PackageFolderContent_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 PCP Folder is a container for other PCP Folders and PCP Streams. |
| |
| @see com::sun::star::ucb::PackageContentProvider |
| @see com::sun::star::ucb::PackageStreamContent |
| */ |
| published service PackageFolderContent |
| { |
| //------------------------------------------------------------------------- |
| /** 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> |
| insert ( makes a newly created folder persistent ) |
| </li> |
| <li> |
| delete |
| </li> |
| <li> |
| open |
| </li> |
| <li> |
| transfer ( only transfers from PCP Folders/PCP Streams to other |
| PCP folders. It does not handle contents with a URL scheme other |
| then the PCP-URL-scheme. ) |
| </li> |
| <li> |
| flush ( a command introduced by the PCP Folder. It takes a |
| void-argument and returns void. This command is used to write unsaved |
| changes to the underlying package file. Note that the current |
| implementation of PCP contents never flushes automatically! Operations |
| which require a flush to get persistent, are: |
| "setPropertyValues( < any_non_read_only_property > ) ", "delete", |
| "insert" ) |
| </li> |
| </ul> |
| |
| <b>Supported Properties</b> |
| <ul> |
| <li> |
| string ContentType ( read-only, always "application/vnd.sun.star.pkg-folder" ) |
| </li> |
| <li> |
| boolean IsDocument ( read-only, always false ) |
| </li> |
| <li> |
| boolean IsFolder ( read-only, always true ) |
| </li> |
| <li> |
| string MediaType |
| </li> |
| <li> |
| string Title |
| </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> |
| |
| A PCP Folder can create other PCP Folders and PCP Streams. To create |
| a new child of a PCP 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.pkg-folder". |
| To create a new PCP Stream, use the type |
| "application/vnd.sun.star.pkg-stream". |
| </li> |
| <li> |
| Set a title at the new folder / stream. ( Let the new child execute |
| the command "setPropertyValues", which sets at least the property |
| "Title" to a non-empty value ). |
| </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> |
| |
| <p> |
| Another, more convenient way for creating streams is simply to assemble |
| the URL for the new content ( last part of the path will become the |
| title of the new stream ) and to obtain a Content object for that URL |
| from the UCB. Then let the content execute the command "insert". The |
| command will fail, if you set the command's parameter |
| <member>InsertCommandArgument::ReplaceExisting"</member> |
| to false and there is already a stream with the title given by the |
| content's URL. |
| |
| </p> |
| */ |
| interface com::sun::star::ucb::XContentCreator; |
| }; |
| |
| //============================================================================= |
| |
| }; }; }; }; |
| |
| #endif |