summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/packages/PackageFolder.idl
diff options
context:
space:
mode:
authorMichael Hönnig <mi@openoffice.org>2001-03-09 14:49:17 +0000
committerMichael Hönnig <mi@openoffice.org>2001-03-09 14:49:17 +0000
commit4030d48f9625f26161217456c258c718c8f6669a (patch)
tree49b721c51524a2c73924dbfc8ad3df8fe6ab4eb9 /offapi/com/sun/star/packages/PackageFolder.idl
parentdc814e7937205eedb80446b7eecc1822d9717ec5 (diff)
package is a reserved word in Java => renaming to packages
Diffstat (limited to 'offapi/com/sun/star/packages/PackageFolder.idl')
-rw-r--r--offapi/com/sun/star/packages/PackageFolder.idl142
1 files changed, 142 insertions, 0 deletions
diff --git a/offapi/com/sun/star/packages/PackageFolder.idl b/offapi/com/sun/star/packages/PackageFolder.idl
new file mode 100644
index 000000000000..f429581fecc0
--- /dev/null
+++ b/offapi/com/sun/star/packages/PackageFolder.idl
@@ -0,0 +1,142 @@
+/*************************************************************************
+ *
+ * $RCSfile: PackageFolder.idl,v $
+ *
+ * $Revision: 1.1 $
+ *
+ * last change: $Author: mi $ $Date: 2001-03-09 15:49:17 $
+ *
+ * The Contents of this file are made available subject to the terms of
+ * either of the following licenses
+ *
+ * - GNU Lesser General Public License Version 2.1
+ * - Sun Industry Standards Source License Version 1.1
+ *
+ * Sun Microsystems Inc., October, 2000
+ *
+ * GNU Lesser General Public License Version 2.1
+ * =============================================
+ * Copyright 2000 by Sun Microsystems, Inc.
+ * 901 San Antonio Road, Palo Alto, CA 94303, USA
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License version 2.1, as published by the Free Software Foundation.
+ *
+ * This library 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 for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston,
+ * MA 02111-1307 USA
+ *
+ *
+ * Sun Industry Standards Source License Version 1.1
+ * =================================================
+ * The contents of this file are subject to the Sun Industry Standards
+ * Source License Version 1.1 (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.openoffice.org/license.html.
+ *
+ * Software provided under this License is provided on an "AS IS" basis,
+ * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
+ * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
+ * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
+ * See the License for the specific provisions governing your rights and
+ * obligations concerning the Software.
+ *
+ * The Initial Developer of the Original Code is: Sun Microsystems, Inc.
+ *
+ * Copyright: 2000 by Sun Microsystems, Inc.
+ *
+ * All Rights Reserved.
+ *
+ * Contributor(s): _______________________________________
+ *
+ *
+ ************************************************************************/
+#ifndef __com_sun_star_packages_PackageFolder_idl__
+#define __com_sun_star_packages_PackageFolder_idl__
+
+#ifndef __com_sun_star_container_XNamed_idl__
+#include <com/sun/star/container/XNamed.idl>
+#endif
+
+#ifndef __com_sun_star_container_XChild_idl__
+#include <com/sun/star/container/XChild.idl>
+#endif
+
+#ifndef __com_sun_star_container_XNameContainer_idl__
+#include <com/sun/star/container/XNameContainer.idl>
+#endif
+
+#ifndef __com_sun_star_beans_XPropertySet_idl__
+#include <com/sun/star/beans/XPropertySet.idl>
+#endif
+
+#ifndef __com_sun_star_container_XEnumerationAccess_udl__
+#include <com/sun/star/container/XEnumerationAccess.idl>
+#endif
+//=============================================================================
+
+module com { module sun { module star { module packages {
+
+//=============================================================================
+/**
+ The PackageFolder service represents a single folder or directory within
+ a Package. Instances of this service can only be constructed by an
+ implementation of the Package service and not via the service manager.
+*/
+service PackageFolder
+{
+ /**
+ This interface is used to get or set the name of the folder
+ */
+ interface com::sun::star::container::XNamed;
+ /**
+ The getParent method of XChild will return the PackageFolder that
+ contains this PackageFolder or nothing if this PackageFolder is
+ the root PackageFolder
+
+ setParent will move the PackageFolder
+ */
+ interface com::sun::star::container::XChild;
+ /**
+ This interface describes all of the PackageFolders and PackageStreams
+ which are contained within this instance of the PackageFolder service.
+
+ XElementAccess::getElementType returns service PackageStream
+ XNameAccess::getByName returns either a PackageFolder or a PackageStream
+ as a css::uno::Any
+ XNameAccess::getElementNames returns a uno::Sequence of strings containing
+ the names of all children stored in the PackageFolder
+ */
+ interface com::sun::star::container::XNameContainer;
+ /**
+ This interface will return an implementation of service
+ PackageFolderEnumeration, which represents an iterator over the children
+ of the PackageFolder, or the PackageStreams and PackageFolders contained
+ within this instance of the PackageFolder service.
+
+ This provides a "snapshot" of the contents of the
+ PackageFolder at the time of construction. It is the responsibility of the
+ caller to ensure that any given member of the enumeration refers to a valid
+ PackageStream or PackageFolder.
+
+ */
+ interface com::sun::star::container::XEnumerationAccess;
+
+ /**
+ This interface provides access to the properties of the package entry.
+ Currently, this only supports one entry which is a string called
+ MediaType. This contains the MIME type of the stream (eg. "text/html").
+ For PackageFolders, this is always an empty string.
+ */
+ interface com::sun::star::beans::XPropertySet;
+};
+}; }; }; };
+
+#endif