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
  20 module com {  module sun {  module star {   module packages {
  21
  22 /**
  23     The PackageFolder service represents a single folder or directory within
  24     a Package. Instances of this service can only be constructed by an
  25     implementation of the Package service and not via the service manager.
  26 */
  27 published service PackageFolder
  28 {
  29     /**
  30     This interface is used to get or set the name of the folder.
  31     */
  32     interface com::sun::star::container::XNamed;
  33     /**
  34     The getParent method of XChild will return the PackageFolder that
  35     contains this PackageFolder or nothing if this PackageFolder is
  36     the root PackageFolder.
  37
  38     setParent will move the PackageFolder.
  39     */
  40     interface com::sun::star::container::XChild;
  41     /**
  42     This interface describes all of the PackageFolders and PackageStreams
  43     which are contained within this instance of the PackageFolder service.
  44
  45     XElementAccess::getElementType returns service PackageStream
  46     XNameAccess::getByName returns either a PackageFolder or a PackageStream
  47         as a css::uno::Any
  48     XNameAccess::getElementNames returns a uno::Sequence of strings containing
  49         the names of all children stored in the PackageFolder
  50     */
  51     interface com::sun::star::container::XNameContainer;
  52     /**
  53     This interface will return an implementation of service
  54     PackageFolderEnumeration, which represents an iterator over the children
  55     of the PackageFolder, or the PackageStreams and PackageFolders contained
  56     within this instance of the PackageFolder service.
  57
  58     This provides a "snapshot" of the contents of the
  59     PackageFolder at the time of construction. It is the responsibility of the
  60     caller to ensure that any given member of the enumeration refers to a valid
  61     PackageStream or PackageFolder.
  62
  63     */
  64     interface com::sun::star::container::XEnumerationAccess;
  65
  66     /**
  67     This interface provides access to the properties of the package entry.
  68     Currently, this only supports one entry which is a string called
  69     MediaType. This contains the MIME type of the stream (e.g. "text/html").
  70     For PackageFolders, this is always an empty string.
  71     */
  72     interface com::sun::star::beans::XPropertySet;
  73 };
  74 }; }; }; };
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */