blob: b43bab79f212bbf22b179e7f5ef4977856670611 (
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
116
117
118
119
120
121
122
123
124
125
126
127
128
|
/* -*- 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_document_XDocumentInfo_idl__
#define __com_sun_star_document_XDocumentInfo_idl__
#include <com/sun/star/uno/XInterface.idl>
#include <com/sun/star/lang/ArrayIndexOutOfBoundsException.idl>
module com { module sun { module star { module document {
/** provides access to the user fields for the information regarding the
document
<p>
These fields are special one of the set of available document properties.
Other ones are accessed as properties (by using the interface
<type scope="com::sun::star::beans">XPropertySet</type>) of service
<type>DocumentInfo</type>.
</p>
@deprecated Use <type>XDocumentProperties</type> instead.
@see DocumentInfo
@see StandaloneDocumentInfo
@see com::sun::star::beans::XPropertySet
*/
published interface XDocumentInfo: com::sun::star::uno::XInterface
{
/** provides information about count of available fields
<p>
This count marks the top range of possible requests for get/set
any of these fields. Range = [0..count-1]
</p>
@returns
current count
*/
short getUserFieldCount();
/** returns the name of an user field
@param Index
specifies the position of requested field
Range = [0..count-1]
@returns
the name of the requested field
@throws com::sun::star::lang::ArrayIndexOutOfBoundsException
if <var>Index</var> don't fit range of [0..count-1]
*/
string getUserFieldName( [in] short Index )
raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
/** returns the value of an user field
@param Index
specifies the position of requested field
Range = [0..count-1]
@returns
the value of the requested field
@throws com::sun::star::lang::ArrayIndexOutOfBoundsException
if <var>Index</var> don't fit range of [0..count-1]
*/
string getUserFieldValue( [in] short Index )
raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
/** changes the name of one of the user fields
@param Index
specifies the position of requested field
Range = [0..count-1]
@param Name
the new name for this field to be set
@throws com::sun::star::lang::ArrayIndexOutOfBoundsException
if <var>Index</var> don't fit range of [0..count-1]
*/
void setUserFieldName(
[in] short Index ,
[in] string Name )
raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
/** changes the value of one of the user fields
@param Index
specifies the position of requested field
Range = [0..count-1]
@param Value
the new value for this field to be set
@throws com::sun::star::lang::ArrayIndexOutOfBoundsException
if <var>Index</var> don't fit range of [0..count-1]
*/
void setUserFieldValue(
[in] short Index ,
[in] string Value )
raises( com::sun::star::lang::ArrayIndexOutOfBoundsException );
};
}; }; }; };
#endif
/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
|
