blob: 7058999082df5285213b333e7db930914ff3c3f6 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
* This file is part of the LibreOffice project.
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/.
*
* This file incorporates work covered by the following license notice:
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed
* with this work for additional information regarding copyright
* ownership. The ASF licenses this file to you under the Apache
* License, Version 2.0 (the "License"); you may not use this file
* except in compliance with the License. You may obtain a copy of
* the License at http://www.apache.org/licenses/LICENSE-2.0 .
*/
#ifndef __com_sun_star_ucb_XUniversalContentBroker_idl__
#define __com_sun_star_ucb_XUniversalContentBroker_idl__
#include <com/sun/star/lang/XComponent.idl>
#include <com/sun/star/ucb/XCommandProcessor.idl>
#include <com/sun/star/ucb/XCommandProcessor2.idl>
#include <com/sun/star/ucb/XContentProviderManager.idl>
#include <com/sun/star/ucb/XContentProvider.idl>
#include <com/sun/star/ucb/XContentIdentifierFactory.idl>
module com { module sun { module star { module ucb {
/**
@since LibreOffice 3.7
*/
published interface XUniversalContentBroker
{
/** must be implemented to make it possible to resolve cyclic object
references.
<p>Those references i.e. may occur if content provider implementations
hold references to the Broker. The Broker itself always holds its
providers. If the Broker shall be released,
<member scope="com::sun::star::lang">XComponent::dispose</member>
must be called at the Broker. The implementation of this method must
call
<member scope="com::sun::star::lang">XEventListener::disposing</member>
on the registered listeners (the providers holding the Broker must be
those listeners) and release the appropriate object references. At
the other hand, the implementation of XEventListener::disposing must
release its appropriate references.
<p>This interface is required.
*/
interface com::sun::star::lang::XComponent;
/** provides access to all kind of contents provided by the registered
content providers.
<p>This interface is required.
*/
interface com::sun::star::ucb::XContentProvider;
/** provides access to a set of content providers registered with the UCB.
<p>This interface is required.
*/
interface com::sun::star::ucb::XContentProviderManager;
/** creates <type>XContentIdentifier</type> implementation objects for
all kind of contents provided by the UCB.
<p>This interface is required.
*/
interface com::sun::star::ucb::XContentIdentifierFactory;
/** Enables the caller to execute commands at the broker.
Is an enhanced version of <type>XCommandProcessor</type> that has an
additional method for releasing command identifiers obtained via
<member>XCommandProcessor::createCommandIdentifier</member> to avoid
resource leaks. For a detailed description of the problem refer to
<member>XCommandProcessor2::releaseCommandIdentifier</member>.
<p>This interface is required.
<p><pre>
=======================================================================
Commands:
=======================================================================
[return type]
[command name]
[parameter type and name]
-----------------------------------------------------------------------
Required commands:
-----------------------------------------------------------------------
// This command obtains an interface which allows to query
// information on commands supported by the Content Broker.
<type>XCommandInfo</type>
getCommandInfo
void
// This command transfers Contents from one location to another.
// Additionally, it can be used to create a link to a Content.
// The implementation must be able to handle Contents provided
// by any Content Provider. This is different from the command
// "transfer" that can be supported by a Content. That command
// typically can only handle <type>Content</type>s provided by one
// <type>ContentProvider</type>.
void
globalTransfer
<type>GlobalTransferCommandArgument</type>
</pre>
*/
interface com::sun::star::ucb::XCommandProcessor2;
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
