offapi/com/sun/star/packages/PackageFolder.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: PackageFolder.idl,v $
  10  * $Revision: 1.5 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_packages_PackageFolder_idl__
  31 #define __com_sun_star_packages_PackageFolder_idl__
  32
  33 #ifndef __com_sun_star_container_XNamed_idl__
  34 #include <com/sun/star/container/XNamed.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_container_XChild_idl__
  38 #include <com/sun/star/container/XChild.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_container_XNameContainer_idl__
  42 #include <com/sun/star/container/XNameContainer.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_beans_XPropertySet_idl__
  46 #include <com/sun/star/beans/XPropertySet.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_container_XEnumerationAccess_udl__
  50 #include <com/sun/star/container/XEnumerationAccess.idl>
  51 #endif
  52 //=============================================================================
  53
  54 module com {  module sun {  module star {   module packages {
  55
  56 //=============================================================================
  57 /**
  58     The PackageFolder service represents a single folder or directory within
  59     a Package. Instances of this service can only be constructed by an
  60     implementation of the Package service and not via the service manager.
  61 */
  62 published service PackageFolder
  63 {
  64     /**
  65     This interface is used to get or set the name of the folder.
  66     */
  67     interface com::sun::star::container::XNamed;
  68     /**
  69     The getParent method of XChild will return the PackageFolder that
  70     contains this PackageFolder or nothing if this PackageFolder is
  71     the root PackageFolder.
  72
  73     setParent will move the PackageFolder.
  74     */
  75     interface com::sun::star::container::XChild;
  76     /**
  77     This interface describes all of the PackageFolders and PackageStreams
  78     which are contained within this instance of the PackageFolder service.
  79
  80     XElementAccess::getElementType returns service PackageStream
  81     XNameAccess::getByName returns either a PackageFolder or a PackageStream
  82         as a css::uno::Any
  83     XNameAccess::getElementNames returns an uno::Sequence of strings containing
  84         the names of all children stored in the PackageFolder
  85     */
  86     interface com::sun::star::container::XNameContainer;
  87     /**
  88     This interface will return an implementation of service
  89     PackageFolderEnumeration, which represents an iterator over the children
  90     of the PackageFolder, or the PackageStreams and PackageFolders contained
  91     within this instance of the PackageFolder service.
  92
  93     This provides a "snapshot" of the contents of the
  94     PackageFolder at the time of construction. It is the responsibility of the
  95     caller to ensure that any given member of the enumeration refers to a valid
  96     PackageStream or PackageFolder.
  97
  98     */
  99     interface com::sun::star::container::XEnumerationAccess;
 100
 101     /**
 102     This interface provides access to the properties of the package entry.
 103     Currently, this only supports one entry which is a string called
 104     MediaType. This contains the MIME type of the stream (eg. "text/html").
 105     For PackageFolders, this is always an empty string.
 106     */
 107     interface com::sun::star::beans::XPropertySet;
 108 };
 109 }; }; }; };
 110
 111 #endif