1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __ooo_vba_XDocumentProperty_idl__
25#define __ooo_vba_XDocumentProperty_idl__
26
27#ifndef __com_sun_star_script_BasicErrorException_idl__
28#include <com/sun/star/script/BasicErrorException.idl>
29#endif
30#ifndef __com_sun_star_script_XDefaultProperty_idl__
31#include <com/sun/star/script/XDefaultProperty.idl>
32#endif
33#ifndef __ooo_vba_XHelperInterface_idl__
34#include <ooo/vba/XHelperInterface.idl>
35#endif
36
37module ooo { module vba {
38
39/**
40 * Specific built-in document property. Use CustomDocumentProperties(index),
41 * where index is the name or index number of the custom document property,
42 * to return a DocumentProperty object that represents a specific custom document property.
43 */
44interface XDocumentProperty
45{
46
47    interface com::sun::star::script::XDefaultProperty;
48    interface ooo::vba::XHelperInterface;
49
50    void Delete()
51        raises (com::sun::star::script::BasicErrorException);
52
53    /** Required String. The name of the property.
54     */
55    string getName()
56        raises (com::sun::star::script::BasicErrorException);
57
58    void setName([in] string Name)
59        raises (com::sun::star::script::BasicErrorException);
60
61    /** The data type of the property.
62     * Can be one of the following MsoDocProperties constants:
63     * msoPropertyTypeBoolean, msoPropertyTypeDate, msoPropertyTypeFloat,
64     * msoPropertyTypeNumber, or msoPropertyTypeString.
65     */
66    byte getType()
67        raises (com::sun::star::script::BasicErrorException);
68
69    void setType([in] byte Type)
70        raises (com::sun::star::script::BasicErrorException);
71
72    /** If true, then LinkSource has a valid value. */
73    boolean getLinkToContent()
74        raises (com::sun::star::script::BasicErrorException);
75
76    void setLinkToContent([in] boolean LinkToContent)
77        raises (com::sun::star::script::BasicErrorException);
78
79    /** If LinkToContent is false, then this contains the value of the property
80     * The data type of the value will match the Type property.
81     */
82    any getValue()
83        raises (com::sun::star::script::BasicErrorException);
84
85    void setValue([in] any Value)
86        raises (com::sun::star::script::BasicErrorException);
87
88    /** If LinkToContent is false, then this contains the value of the property */
89    string getLinkSource()
90        raises (com::sun::star::script::BasicErrorException);
91
92    void setLinkSource([in] string LinkSource)
93        raises (com::sun::star::script::BasicErrorException);
94};
95
96}; };
97
98#endif
99
100