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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_packages_PackageFolder_idl__
  20 #define __com_sun_star_packages_PackageFolder_idl__
  21
  22 #include <com/sun/star/container/XNamed.idl>
  23 #include <com/sun/star/container/XChild.idl>
  24 #include <com/sun/star/container/XNameContainer.idl>
  25 #include <com/sun/star/beans/XPropertySet.idl>
  26 #include <com/sun/star/container/XEnumerationAccess.idl>
  27
  28 module com {  module sun {  module star {   module packages {
  29
  30 /**
  31     The PackageFolder service represents a single folder or directory within
  32     a Package. Instances of this service can only be constructed by an
  33     implementation of the Package service and not via the service manager.
  34 */
  35 published service PackageFolder
  36 {
  37     /**
  38     This interface is used to get or set the name of the folder.
  39     */
  40     interface com::sun::star::container::XNamed;
  41     /**
  42     The getParent method of XChild will return the PackageFolder that
  43     contains this PackageFolder or nothing if this PackageFolder is
  44     the root PackageFolder.
  45
  46     setParent will move the PackageFolder.
  47     */
  48     interface com::sun::star::container::XChild;
  49     /**
  50     This interface describes all of the PackageFolders and PackageStreams
  51     which are contained within this instance of the PackageFolder service.
  52
  53     XElementAccess::getElementType returns service PackageStream
  54     XNameAccess::getByName returns either a PackageFolder or a PackageStream
  55         as a css::uno::Any
  56     XNameAccess::getElementNames returns an uno::Sequence of strings containing
  57         the names of all children stored in the PackageFolder
  58     */
  59     interface com::sun::star::container::XNameContainer;
  60     /**
  61     This interface will return an implementation of service
  62     PackageFolderEnumeration, which represents an iterator over the children
  63     of the PackageFolder, or the PackageStreams and PackageFolders contained
  64     within this instance of the PackageFolder service.
  65
  66     This provides a "snapshot" of the contents of the
  67     PackageFolder at the time of construction. It is the responsibility of the
  68     caller to ensure that any given member of the enumeration refers to a valid
  69     PackageStream or PackageFolder.
  70
  71     */
  72     interface com::sun::star::container::XEnumerationAccess;
  73
  74     /**
  75     This interface provides access to the properties of the package entry.
  76     Currently, this only supports one entry which is a string called
  77     MediaType. This contains the MIME type of the stream (e.g. "text/html").
  78     For PackageFolders, this is always an empty string.
  79     */
  80     interface com::sun::star::beans::XPropertySet;
  81 };
  82 }; }; }; };
  83
  84 #endif
  85
  86 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */