blob: ab029bd2cb528e2ea8c177cdc0fb3f334821ed96 (
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
|
/* -*- 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 INCLUDED_REGISTRY_SOURCE_REFLREAD_HXX
#define INCLUDED_REGISTRY_SOURCE_REFLREAD_HXX
#include <registry/refltype.hxx>
#include <registry/regtype.h>
#include <rtl/ustring.hxx>
/// Implememetation handle
typedef void* TypeReaderImpl;
/** RegistryTypeReades reads a binary type blob.
This class provides the necessary functions to read type information
for all kinds of types of a type blob.
@deprecated
use typereg::Reader instead
*/
class RegistryTypeReader
{
public:
/** Constructor.
@param buffer points to the binary data block.
@param bufferLen specifies the size of the binary data block.
*/
RegistryTypeReader(const sal_uInt8* buffer,
sal_uInt32 bufferLen);
/// Destructor. The Destructor frees the data block if the copyData flag was TRUE.
~RegistryTypeReader();
/** returns the typeclass of the type represented by this blob.
This function will always return the type class without the internal
RT_TYPE_PUBLISHED flag set.
*/
RTTypeClass getTypeClass() const;
/** returns the full qualified name of the type.
*/
rtl::OUString getTypeName() const;
/** returns the full qualified name of the supertype.
*/
rtl::OUString getSuperTypeName() const;
/** returns the number of fields (attributes/properties, enum values or number
of constants in a module).
*/
sal_uInt32 getFieldCount() const;
/** returns the name of the field specified by index.
*/
rtl::OUString getFieldName( sal_uInt16 index ) const;
/** returns the full qualified name of the field specified by index.
*/
rtl::OUString getFieldType( sal_uInt16 index ) const;
/** returns the access mode of the field specified by index.
*/
RTFieldAccess getFieldAccess( sal_uInt16 index ) const;
/** returns the value of the field specified by index.
This function returns the value of an enum value or of a constant.
*/
RTConstValue getFieldConstValue( sal_uInt16 index ) const;
/** returns the documentation string for the field specified by index.
Each field of a type can have their own documentation.
*/
rtl::OUString getFieldDoku( sal_uInt16 index ) const;
/** returns the IDL filename of the field specified by index.
The IDL filename of a field can differ from the filename of the ype itself
because modules and also constants can be defined in different IDL files.
*/
rtl::OUString getFieldFileName( sal_uInt16 index ) const;
private:
RegistryTypeReader(RegistryTypeReader &) = delete;
void operator =(RegistryTypeReader) = delete;
/// stores the handle of an implementation class
TypeReaderImpl m_hImpl;
};
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
