summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/ucb/PackageStreamContent.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/ucb/PackageStreamContent.idl')
-rw-r--r--offapi/com/sun/star/ucb/PackageStreamContent.idl206
1 files changed, 206 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/PackageStreamContent.idl b/offapi/com/sun/star/ucb/PackageStreamContent.idl
new file mode 100644
index 000000000000..7da23332c959
--- /dev/null
+++ b/offapi/com/sun/star/ucb/PackageStreamContent.idl
@@ -0,0 +1,206 @@
+/*************************************************************************
+ *
+ * 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_PackageStreamContent_idl__
+#define __com_sun_star_ucb_PackageStreamContent_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
+
+//=============================================================================
+
+module com { module sun { module star { module ucb {
+
+//=============================================================================
+/** A PCP Stream is a content which represents a file inside a package.
+
+ <p>It is always contained in a PCP Folder. A PCP Stream has no children.
+
+ @see com::sun::star::ucb::PackageContentProvider
+ @see com::sun::star::ucb::PackageFolderContent
+*/
+published service PackageStreamContent
+{
+ //-------------------------------------------------------------------------
+ /** 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 stream persistent )
+ </li>
+ <li>
+ delete
+ </li>
+ <li>
+ open
+ </li>
+ </ul>
+
+ <b>Supported Properties</b>
+ <ul>
+ <li>
+ string ContentType ( read-only, always "application/vnd.sun.star.pkg-stream" )
+ </li>
+ <li>
+ boolean IsDocument ( read-only, always true )
+ </li>
+ <li>
+ boolean IsFolder ( read-only, always false )
+ </li>
+ <li>
+ string MediaType
+ </li>
+ <li>
+ string Size ( read-only )
+ </li>
+ <li>
+ string Title
+ </li>
+ <li>
+ boolean Compressed ( allows you to explecitly state whether you want a
+ stream to be compressed or not. The default value of this property
+ will be determined according to the value of the property 'MediaType'.
+ If it is empty or prefixed by "text/", the value of 'Compressed' is set
+ to true. Otherwise the value will be false. )
+ </li>
+ <li>
+ boolean Encrypted ( are the stream data encrypted or not ).
+ </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;
+};
+
+//=============================================================================
+
+}; }; }; };
+
+#endif