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