offapi/com/sun/star/ucb/HierarchyFolderContent.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
  21 module com { module sun { module star { module ucb {
  22
  23 /** A HCP Folder is a container for other HCP Folders and HCP Links.
  24
  25     @see com::sun::star::ucb::HierarchyContentProvider
  26     @see com::sun::star::ucb::HierarchyRootFolderContent
  27     @see com::sun::star::ucb::HierarchyLinkContent
  28 */
  29 published service HierarchyFolderContent
  30 {
  31     /** This interface is implemented according to the specification of
  32         service Content.
  33      */
  34     interface com::sun::star::lang::XComponent;
  35
  36     /** This interface is implemented according to the specification of
  37         service Content.
  38      */
  39     interface com::sun::star::ucb::XContent;
  40
  41     /** This interface is implemented according to the specification of
  42         service Content.
  43
  44         <p>
  45
  46         <b>Supported Commands</b>
  47         <ul>
  48         <li>
  49         getCommandInfo
  50         </li>
  51         <li>
  52         getPropertySetInfo
  53         </li>
  54         <li>
  55         getPropertyValues
  56         </li>
  57         <li>
  58         setPropertyValues
  59         </li>
  60         <li>
  61         insert ( makes a newly created folder persistent )
  62         </li>
  63         <li>
  64         delete
  65         </li>
  66         <li>
  67         open
  68         </li>
  69         <li>
  70         transfer ( only transfers from one hierarchy folder to another supported )
  71         </li>
  72         </ul>
  73
  74         <b>Supported Properties</b>
  75         <ul>
  76         <li>
  77         string ContentType ( read-only, always "application/vnd.sun.star.hier-folder" )
  78         </li>
  79         <li>
  80         boolean IsDocument ( read-only, always false )
  81         </li>
  82         <li>
  83         boolean IsFolder ( read-only, always true )
  84         </li>
  85         <li>
  86         string Title
  87         </li>
  88         </ul>
  89
  90         </p>
  91      */
  92     interface com::sun::star::ucb::XCommandProcessor;
  93
  94     /** is an enhanced version of XCommandProcessor that has an
  95         additional method for releasing command identifiers obtained via
  96         XCommandProcessor::createCommandIdentifier() to avoid
  97         resource leaks. For a detailed description of the problem refer to
  98         XCommandProcessor2::releaseCommandIdentifier().
  99
 100         <p>Where many existing Content implementations do not
 101         (yet), every new implementation should support this interface.
 102      */
 103     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 104
 105     /** This interface is implemented according to the specification of
 106         service Content.
 107      */
 108     interface com::sun::star::beans::XPropertiesChangeNotifier;
 109
 110     /** This interface is implemented according to the specification of
 111         service Content.
 112      */
 113     interface com::sun::star::beans::XPropertyContainer;
 114
 115     /** This interface is implemented according to the specification of
 116         service Content.
 117      */
 118     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 119
 120     /** This interface is implemented according to the specification of
 121         service Content.
 122      */
 123     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 124
 125     /** This interface is implemented according to the specification of
 126         service Content.
 127      */
 128     interface com::sun::star::container::XChild;
 129
 130     /** This interface is implemented according to the specification of
 131         service Content.
 132
 133         <p>
 134
 135         A HCP Folder can create other HCP Folders and HCP Links. To create
 136         a new child of a HCP Folder:
 137
 138         <ol>
 139         <li>
 140         Let the parent folder create a new content by calling
 141         XContentCreator::createNewContent() on it. The content
 142         type to use for new folders is "application/vnd.sun.star.hier-folder".
 143         To create a new link, use the type "application/vnd.sun.star.hier-link".
 144         </li>
 145         <li>
 146         Set a title at the new folder / link. ( Let the new child execute
 147         the command "setPropertyValues", which sets at least the property
 148         "Title" to a non-empty value ). For a link, you need to set the
 149         property "TargetURL" as well to a non-empty value.
 150         </li>
 151         <li>
 152         Let the new child ( not the parent! ) execute the command "insert".
 153         This will commit the creation process.
 154         </li>
 155         </ol>
 156
 157         </p>
 158      */
 159     interface com::sun::star::ucb::XContentCreator;
 160 };
 161
 162
 163 }; }; }; };
 164
 165 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */