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
|
/* -*- 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_reflection_XPublished_idl__
#define __com_sun_star_reflection_XPublished_idl__
#include <com/sun/star/uno/XInterface.idl>
module com { module sun { module star { module reflection {
/**
Reflects the “published” status of a UNOIDL entity.
<p>This interface is intended to be supported by objects that also support
com::sun::star::reflection::XTypeDescription.
(This interface could have been made an optional sub-interface of
com::sun::star::reflection::XTypeDescription, but is
instead kept independent for reasons of backwards compatibility.)</p>
<p>For the various kinds of UNOIDL entities that are represented by objects
supporting com::sun::star::reflection::XTypeDescription
and its subtypes, this optional interface should be supported as follows:</p>
<ul>
<li>Enum types
(com::sun::star::reflection::XEnumTypeDescription),
plain struct types
(com::sun::star::reflection::XStructTypeDescription),
polymorphic struct type templates
(com::sun::star::reflection::XStructTypeDescription),
exception types (com::sun::star::reflection::XCompoundTypeDescription),
interface types (com::sun::star::reflection::XInterfaceTypeDescription2),
typedefs (com::sun::star::reflection::XIndirectTypeDescription),
individual constants
(com::sun::star::reflection::XConstantTypeDescription),
constant groups (com::sun::star::reflection::XConstantsTypeDescription),
single-interface–based services
(com::sun::star::reflection::XServiceTypeDescription2),
accumulation-based services
(com::sun::star::reflection::XServiceTypeDescription2),
interface-based singletons
(com::sun::star::reflection::XSingletonTypeDescription2),
and service-based singletons
(com::sun::star::reflection::XSingletonTypeDescription2)
support the notion of being published. Therefore, for an object that
represents any such entity,
com::sun::star::reflection::XPublished should be
supported.</li>
<li>Sequence types
(com::sun::star::reflection::XIndirectTypeDescription),
type parameters of polymorphic struct type templates
(com::sun::star::reflection::XTypeDescription),
instantiated polymorphic struct types
(com::sun::star::reflection::XStructTypeDescription),
attributes of interface types
(com::sun::star::reflection::XInterfaceAttributeTypeDescription2),
methods of interface types
(com::sun::star::reflection::XInterfaceMethodTypeDescription),
properties of accumulation-based services
(com::sun::star::reflection::XPropertyTypeDescription),
deprecated
com::sun::star::reflection::XArrayTypeDescriptions,
and deprecated
com::sun::star::reflection::XUnionTypeDescriptions do
not support the notion of being published.
Therefore, for an object that represents any such entity,
com::sun::star::reflection::XPublished should not be
supported.</li>
</ul>
@since OOo 2.0
*/
interface XPublished {
/**
Returns the “published” status of a UNOIDL entity.
@return `TRUE` if the UNOIDL entity represented by this object is
published
*/
boolean isPublished();
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|