1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_text_TextFieldMaster_idl__
28#define __com_sun_star_text_TextFieldMaster_idl__
29
30#ifndef __com_sun_star_beans_XPropertySet_idl__
31#include <com/sun/star/beans/XPropertySet.idl>
32#endif
33#ifndef __com_sun_star_text_XDependentTextField_idl__
34#include <com/sun/star/text/XDependentTextField.idl>
35#endif
36
37//=============================================================================
38
39 module com {  module sun {  module star {  module text {
40
41//=============================================================================
42
43/** A <type>TextFieldMaster</type> specifies important data for its
44	<type>DependentTextField</type>s.
45 */
46published service TextFieldMaster
47{
48	/** This optional interface makes it possible to access properties of
49				this field master, if any.
50	 */
51	[optional] interface com::sun::star::beans::XPropertySet;
52    //------------------------------------------------------------------------
53    /** determins the name of the field master. The name is void as long as the
54     instance is not member of the document structure. When the value is being set
55     the instance is inserted into the document and the name cannot be changed afterwards.
56     That does not apply to the Database text field master.
57	 */
58    [optional, property]  string Name;
59        //------------------------------------------------------------------------
60    /** contains a sequence of all fields that depend on this master.
61	 */
62    [readonly, property]  sequence< XDependentTextField> DependentTextFields;
63    //------------------------------------------------------------------------
64    /** contains the instance name as it is used in the <type scope="::com::sun::star::text">
65        XTextFieldsSupplier</type>.
66	 */
67    [readonly, property]  string InstanceName;
68};
69
70//=============================================================================
71
72}; }; }; };
73
74#endif
75