blob: c54b34de28522703e0b6019a1559a3f9de17091e (
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
|
/* -*- 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_frame_XModuleManager_idl__
#define __com_sun_star_frame_XModuleManager_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/IllegalArgumentException.idl>
#include <com/sun/star/frame/UnknownModuleException.idl>
module com { module sun { module star { module frame {
/** can be used to identify office modules.
@since OOo 2.0
*/
interface XModuleManager : com::sun::star::uno::XInterface
{
/**
@short identifies the given module.
@descr This identifier can then be used at the service <type>ModuleManager</type>
to get more information about this module.
For identification the interface <type scope="com::sun::star::lang">XServiceInfo</type>
is requested on the given module. Because all module service registrations must be unique
this value can be queried and checked against the configuration.
Since OOo 2.3.0 also the optional interface <type>XModule</type> will be used.
If its exists it will be preferred.
@param Module
Possible objects for this parameter can be the following one:
<ul>
<li>
<b><type scope="com::sun::star::frame">XFrame</type></b><br>
A frame contains (against a component window) a controller.
Such controller represent the module (in case no model exists).
</li>
<li>
<b><type scope="com::sun::star::frame">XController</type></b><br>
A controller can be bound to a model. Then the model represent the module.
If no model exists - the controller is used for identification.
</li>
<li>
<b><type scope="com::sun::star::frame">XModel</type></b><br>
A model represent a module everytime and can be used for
identification directly.
</li>
</ul>
@throws <type scope="com::sun::star::lang">IllegalArgumentException</type>
if the parameter Module is:
<ul>
<li>an empty one</li>
<li>or does not provide one of the needed interface
XFrame, XController, XModel</li>
<li>or does not provide the needed interface XServiceInfo.</li>
</ul>
@throws <type>UnknownModuleException</type>
if the given module could not be identified.
Note: If the module represent a XFrame instance with does not contain
a document, this exception is thrown too!
@return An identifier for the given module.
Note: This value varies everytime. Error will be transported
by thrown exceptions!
*/
string identify( [in] ::com::sun::star::uno::XInterface Module )
raises(::com::sun::star::lang::IllegalArgumentException,
UnknownModuleException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
