offapi/com/sun/star/ucb/XUniversalContentBroker.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_XUniversalContentBroker_idl__
  20 #define __com_sun_star_ucb_XUniversalContentBroker_idl__
  21
  22 #include <com/sun/star/lang/XComponent.idl>
  23 #include <com/sun/star/ucb/XCommandProcessor.idl>
  24 #include <com/sun/star/ucb/XCommandProcessor2.idl>
  25 #include <com/sun/star/ucb/XContentProviderManager.idl>
  26 #include <com/sun/star/ucb/XContentProvider.idl>
  27 #include <com/sun/star/ucb/XContentIdentifierFactory.idl>
  28
  29 module com { module sun { module star { module ucb {
  30
  31 /**
  32
  33   @since LibreOffice 4.0
  34 */
  35 published interface XUniversalContentBroker
  36 {
  37     /** must be implemented to make it possible to resolve cyclic object
  38         references.
  39
  40         <p>Those references i.e. may occur if content provider  implementations
  41         hold references to the Broker. The Broker itself always holds its
  42         providers. If the Broker shall be released,
  43         com::sun::star::lang::XComponent::dispose()
  44         must be called at the Broker. The implementation of this method must
  45         call
  46         com::sun::star::lang::XEventListener::disposing()
  47         on the registered listeners (the providers holding the Broker must be
  48         those listeners) and release the appropriate object references. At
  49         the other hand, the implementation of XEventListener::disposing must
  50         release its appropriate references.
  51
  52         <p>This interface is required.
  53      */
  54     interface com::sun::star::lang::XComponent;
  55
  56     /** provides access to all kind of contents provided by the registered
  57         content providers.
  58
  59         <p>This interface is required.
  60      */
  61     interface com::sun::star::ucb::XContentProvider;
  62
  63     /** provides access to a set of content providers registered with the UCB.
  64
  65         <p>This interface is required.
  66      */
  67     interface com::sun::star::ucb::XContentProviderManager;
  68
  69     /** creates XContentIdentifier implementation objects for
  70         all kind of contents provided by the UCB.
  71
  72         <p>This interface is required.
  73       */
  74     interface com::sun::star::ucb::XContentIdentifierFactory;
  75
  76     /** Enables the caller to execute commands at the broker.
  77
  78         Is an enhanced version of XCommandProcessor that has an
  79         additional method for releasing command identifiers obtained via
  80         XCommandProcessor::createCommandIdentifier() to avoid
  81         resource leaks. For a detailed description of the problem refer to
  82         XCommandProcessor2::releaseCommandIdentifier().
  83
  84
  85         <p>This interface is required.
  86
  87         <p><pre>
  88         =======================================================================
  89         Commands:
  90         =======================================================================
  91
  92         [return type]
  93             [command name]
  94                 [parameter type and name]
  95
  96         -----------------------------------------------------------------------
  97         Required commands:
  98         -----------------------------------------------------------------------
  99
 100         // This command obtains an interface which allows to query
 101         // information on commands supported by the Content Broker.
 102
 103         XCommandInfo
 104             getCommandInfo
 105                 void
 106
 107         // This command transfers Contents from one location to another.
 108         // Additionally, it can be used to create a link to a Content.
 109         // The implementation must be able to handle Contents provided
 110         // by any Content Provider. This is different from the command
 111         // "transfer" that can be supported by a Content. That command
 112         // typically can only handle Contents provided by one
 113         // ContentProvider.
 114
 115         void
 116             globalTransfer
 117                 GlobalTransferCommandArgument
 118         </pre>
 119
 120      */
 121     interface com::sun::star::ucb::XCommandProcessor2;
 122
 123 };
 124
 125
 126 }; }; }; };
 127
 128 #endif
 129
 130
 131 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */