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