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

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