offapi/com/sun/star/ucb/HierarchyLinkContent.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: HierarchyLinkContent.idl,v $
  10  * $Revision: 1.10 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30 #ifndef __com_sun_star_ucb_HierarchyLinkContent_idl__
  31 #define __com_sun_star_ucb_HierarchyLinkContent_idl__
  32
  33 #ifndef __com_sun_star_lang_XComponent_idl__
  34 #include <com/sun/star/lang/XComponent.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_ucb_XContent_idl__
  38 #include <com/sun/star/ucb/XContent.idl>
  39 #endif
  40
  41 #ifndef __com_sun_star_ucb_XCommandProcessor_idl__
  42 #include <com/sun/star/ucb/XCommandProcessor.idl>
  43 #endif
  44
  45 #ifndef __com_sun_star_ucb_XCommandProcessor2_idl__
  46 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  47 #endif
  48
  49 #ifndef __com_sun_star_beans_XPropertiesChangeNotifier_idl__
  50 #include <com/sun/star/beans/XPropertiesChangeNotifier.idl>
  51 #endif
  52
  53 #ifndef __com_sun_star_beans_XPropertyContainer_idl__
  54 #include <com/sun/star/beans/XPropertyContainer.idl>
  55 #endif
  56
  57 #ifndef __com_sun_star_beans_XPropertySetInfoChangeNotifier_idl__
  58 #include <com/sun/star/beans/XPropertySetInfoChangeNotifier.idl>
  59 #endif
  60
  61 #ifndef __com_sun_star_ucb_XCommandInfoChangeNotifier_idl__
  62 #include <com/sun/star/ucb/XCommandInfoChangeNotifier.idl>
  63 #endif
  64
  65 #ifndef __com_sun_star_container_XChild_idl__
  66 #include <com/sun/star/container/XChild.idl>
  67 #endif
  68
  69 //=============================================================================
  70
  71 module com { module sun { module star { module ucb {
  72
  73 //=============================================================================
  74 /** A HCP Link is a content which points to another location.
  75
  76     <p>It is always contained in HCP Folder. A HCP Link has no children.
  77
  78     @see com::sun::star::ucb::HierarchyContentProvider
  79     @see com::sun::star::ucb::HierarchyRootFolderContent
  80     @see com::sun::star::ucb::HierarchyFolderContent
  81 */
  82 published service HierarchyLinkContent
  83 {
  84     //-------------------------------------------------------------------------
  85     /** This interface is implemented according to the specification of
  86         service <type>Content</type>.
  87      */
  88     interface com::sun::star::lang::XComponent;
  89
  90     //-------------------------------------------------------------------------
  91     /** This interface is implemented according to the specification of
  92         service <type>Content</type>.
  93      */
  94     interface com::sun::star::ucb::XContent;
  95
  96     //-------------------------------------------------------------------------
  97     /** This interface is implemented according to the specification of
  98         service <type>Content</type>.
  99
 100         <p>
 101
 102         <b>Supported Commands</b>
 103         <ul>
 104         <li>
 105         getCommandInfo
 106         </li>
 107         <li>
 108         getPropertySetInfo
 109         </li>
 110         <li>
 111         getPropertyValues
 112         </li>
 113         <li>
 114         setPropertyValues
 115         </li>
 116         <li>
 117         insert ( makes a newly created link persistent )
 118         </li>
 119         <li>
 120         delete
 121         </li>
 122         </ul>
 123
 124         <b>Supported Properties</b>
 125         <ul>
 126         <li>
 127         string ContentType ( read-only, always "application/vnd.sun.star.hier-link" )
 128         </li>
 129         <li>
 130         boolean IsDocument ( read-only, always true )
 131         </li>
 132         <li>
 133         boolean IsFolder ( read-only, always false )
 134         </li>
 135         <li>
 136         string Title
 137         </li>
 138         <li>
 139         string TargetURL ( the URL of the link target )
 140         </li>
 141         </ul>
 142
 143         </p>
 144      */
 145     interface com::sun::star::ucb::XCommandProcessor;
 146
 147     //-------------------------------------------------------------------------
 148     /** is an enhanced version of <type>XCommandProcessor</type> that has an
 149         additional method for releasing command identifiers obtained via
 150         <member>XCommandProcessor::createCommandIdentifier</member> to avoid
 151         resource leaks. For a detailed description of the problem refer to
 152         <member>XCommandProcessor2::releaseCommandIdentifier</member>.
 153
 154         <p>Where many existing <type>Content</type> implementations do not
 155         (yet), every new implementation should support this interface.
 156      */
 157     [optional] interface com::sun::star::ucb::XCommandProcessor2;
 158
 159     //-------------------------------------------------------------------------
 160     /** This interface is implemented according to the specification of
 161         service <type>Content</type>.
 162      */
 163     interface com::sun::star::beans::XPropertiesChangeNotifier;
 164
 165     //-------------------------------------------------------------------------
 166     /** This interface is implemented according to the specification of
 167         service <type>Content</type>.
 168      */
 169     interface com::sun::star::beans::XPropertyContainer;
 170
 171     //-------------------------------------------------------------------------
 172     /** This interface is implemented according to the specification of
 173         service <type>Content</type>.
 174      */
 175     interface com::sun::star::beans::XPropertySetInfoChangeNotifier;
 176
 177     //-------------------------------------------------------------------------
 178     /** This interface is implemented according to the specification of
 179         service <type>Content</type>.
 180      */
 181     interface com::sun::star::ucb::XCommandInfoChangeNotifier;
 182
 183     //-------------------------------------------------------------------------
 184     /** This interface is implemented according to the specification of
 185         service <type>Content</type>.
 186      */
 187     interface com::sun::star::container::XChild;
 188 };
 189
 190 //=============================================================================
 191
 192 }; }; }; };
 193
 194 #endif