blob: 4bb8b09bc8ad61404bd7c6d82b7dfffc3fcb0526 (
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
|
/*************************************************************************
*
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* Copyright 2000, 2010 Oracle and/or its affiliates.
*
* OpenOffice.org - a multi-platform office productivity suite
*
* This file is part of OpenOffice.org.
*
* OpenOffice.org is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License version 3
* only, as published by the Free Software Foundation.
*
* OpenOffice.org is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License version 3 for more details
* (a copy is included in the LICENSE file that accompanied this code).
*
* You should have received a copy of the GNU Lesser General Public License
* version 3 along with OpenOffice.org. If not, see
* <http://www.openoffice.org/license.html>
* for a copy of the LGPLv3 License.
*
************************************************************************/
#ifndef __com_sun_star_drawing_framework_XResourceFactory_idl__
#define __com_sun_star_drawing_framework_XResourceFactory_idl__
#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif
#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif
#ifndef __com_sun_star_lang_WrappedTargetException_idl__
#include <com/sun/star/lang/WrappedTargetException.idl>
#endif
module com { module sun { module star { module drawing { module framework {
interface XResource;
interface XResourceId;
/** Factory and possibly cache for creating and releasing resources.
<p>A resource factory is created and used by the
<type>XConfigurationController</type> object.</p>
<p>A factory may want to implement a cache to reuse previously released
resources.</p>
*/
interface XResourceFactory
{
/** Create a resource for the given <type>XResourceId</type> object.
@param xResourceId
The resourc URL of this id specifies the type of resource to
create. The anchor can be used to obtain the associated object
from the configuration controller. For example, when a view is
created, then the new object can be initialized with the pane
that is its anchor.
<p>Valid values are those for which the factory has previously been
registered at the <type>XConfigurationController</type></p>.
@return
Returns a resource object that has been just created or was
taken from a cache. When the requested resource can not be
created then an empty reference is returned. A later call may
be successfull. This, for example, can be the case with SFX
based side panes. They are not available right after the
creation of a new application frame.
@throws InvalidArgumentException
when the given URL is not supported by the factory.
*/
XResource createResource (
[in] XResourceId xResourceId)
raises ( ::com::sun::star::lang::IllegalArgumentException,
::com::sun::star::lang::WrappedTargetException
);
/** Call this method to tell a factory that the given resource is no
longer in use. The factory can decide whether to destroy the
resource or to keep it in a cache in order to reuse it later.
@param xResource
The given resource has to be one created by the same factory.
@throws InvalidArgumentException
when the given pane was not created by the same factory.
*/
void releaseResource ([in] XResource xResource);
};
}; }; }; }; }; // ::com::sun::star::drawing::framework
#endif
|
