summaryrefslogtreecommitdiff
path: root/udkapi/com/sun/star/lang/XTypeProvider.idl
blob: d429ba08f9fab266d05413135ee303c2a58b9f63 (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
/* -*- 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_lang_XTypeProvider_idl__
#define __com_sun_star_lang_XTypeProvider_idl__

#include <com/sun/star/uno/XInterface.idl>

#include <com/sun/star/reflection/XIdlClass.idl>


module com {  module sun {  module star {  module lang {


/** interface to get information about the types
    (usually interface types) supported by an object.
 */
published interface XTypeProvider: com::sun::star::uno::XInterface
{

    /** returns
        a sequence of all types (usually interface types) provided by the object.
        Important: If the object aggregates other objects the sequence also has
        to contain all types supported by the aggregated objects.
     */
    sequence<type> getTypes();


    /** returns
        a sequence of bytes with length > 0 that is used as an Id to distinguish
        unambiguously between two sets of types, e.g. to realise hashing
        functionality when the object is introspected. Two objects that return
        the same UUID also have to return the same set of types in getTypes().

        If a unique implementation Id cannot be provided this method has to return
        an empty sequence.

        Important: If the object aggregates other objects the UUID has to be unique
        for the whole combination of objects.
     */
    sequence<byte> getImplementationId();
};


}; }; }; };

#endif


/* vim:set shiftwidth=4 softtabstop=4 expandtab: */