1*cdf0e10cSrcweir/*************************************************************************
2*cdf0e10cSrcweir *
3*cdf0e10cSrcweir * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4*cdf0e10cSrcweir *
5*cdf0e10cSrcweir * Copyright 2000, 2010 Oracle and/or its affiliates.
6*cdf0e10cSrcweir *
7*cdf0e10cSrcweir * OpenOffice.org - a multi-platform office productivity suite
8*cdf0e10cSrcweir *
9*cdf0e10cSrcweir * This file is part of OpenOffice.org.
10*cdf0e10cSrcweir *
11*cdf0e10cSrcweir * OpenOffice.org is free software: you can redistribute it and/or modify
12*cdf0e10cSrcweir * it under the terms of the GNU Lesser General Public License version 3
13*cdf0e10cSrcweir * only, as published by the Free Software Foundation.
14*cdf0e10cSrcweir *
15*cdf0e10cSrcweir * OpenOffice.org is distributed in the hope that it will be useful,
16*cdf0e10cSrcweir * but WITHOUT ANY WARRANTY; without even the implied warranty of
17*cdf0e10cSrcweir * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18*cdf0e10cSrcweir * GNU Lesser General Public License version 3 for more details
19*cdf0e10cSrcweir * (a copy is included in the LICENSE file that accompanied this code).
20*cdf0e10cSrcweir *
21*cdf0e10cSrcweir * You should have received a copy of the GNU Lesser General Public License
22*cdf0e10cSrcweir * version 3 along with OpenOffice.org.  If not, see
23*cdf0e10cSrcweir * <http://www.openoffice.org/license.html>
24*cdf0e10cSrcweir * for a copy of the LGPLv3 License.
25*cdf0e10cSrcweir *
26*cdf0e10cSrcweir ************************************************************************/
27*cdf0e10cSrcweir#ifndef __com_sun_star_text_XDependentTextField_idl__
28*cdf0e10cSrcweir#define __com_sun_star_text_XDependentTextField_idl__
29*cdf0e10cSrcweir
30*cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextField_idl__
31*cdf0e10cSrcweir#include <com/sun/star/text/XTextField.idl>
32*cdf0e10cSrcweir#endif
33*cdf0e10cSrcweir
34*cdf0e10cSrcweir#ifndef __com_sun_star_beans_XPropertySet_idl__
35*cdf0e10cSrcweir#include <com/sun/star/beans/XPropertySet.idl>
36*cdf0e10cSrcweir#endif
37*cdf0e10cSrcweir
38*cdf0e10cSrcweir#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
39*cdf0e10cSrcweir#include <com/sun/star/lang/IllegalArgumentException.idl>
40*cdf0e10cSrcweir#endif
41*cdf0e10cSrcweir
42*cdf0e10cSrcweir
43*cdf0e10cSrcweir//=============================================================================
44*cdf0e10cSrcweir
45*cdf0e10cSrcweir module com {  module sun {  module star {  module text {
46*cdf0e10cSrcweir
47*cdf0e10cSrcweir//=============================================================================
48*cdf0e10cSrcweir
49*cdf0e10cSrcweir/** makes it possible to attach this <type>TextField</type> to a
50*cdf0e10cSrcweir	<type>TextFieldMaster</type>.
51*cdf0e10cSrcweir */
52*cdf0e10cSrcweirpublished interface XDependentTextField: com::sun::star::text::XTextField
53*cdf0e10cSrcweir{
54*cdf0e10cSrcweir	//-------------------------------------------------------------------------
55*cdf0e10cSrcweir
56*cdf0e10cSrcweir	/** method must be called to attach the
57*cdf0e10cSrcweir		<type>TextFieldMaster</type> to this <type>TextField</type>.
58*cdf0e10cSrcweir		<p>A <type>TextFieldMaster</type> can only be assigned once.
59*cdf0e10cSrcweir		</p>
60*cdf0e10cSrcweir
61*cdf0e10cSrcweir		@example Create and insert a user field (with a
62*cdf0e10cSrcweir                <code>UserField</code>):
63*cdf0e10cSrcweir
64*cdf0e10cSrcweir		<listing>
65*cdf0e10cSrcweir                // Create a fieldmaster for our newly created User Text field, and access it's
66*cdf0e10cSrcweir                // XPropertySet interface
67*cdf0e10cSrcweir                XPropertySet xMasterPropSet = (XPropertySet) UnoRuntime.queryInterface(
68*cdf0e10cSrcweir                                XPropertySet.class, mxDocFactory.createInstance(
69*cdf0e10cSrcweir                                                "com.sun.star.text.FieldMaster.User"));
70*cdf0e10cSrcweir                // Set the name and value of the FieldMaster
71*cdf0e10cSrcweir                xMasterPropSet.setPropertyValue ("Name", "UserEmperor");
72*cdf0e10cSrcweir                xMasterPropSet.setPropertyValue ("Value", new Integer(42));
73*cdf0e10cSrcweir                // Attach the field master to the user field
74*cdf0e10cSrcweir                xUserField.attachTextFieldMaster (xMasterPropSet);
75*cdf0e10cSrcweir                // Move the cursor to the end of the document
76*cdf0e10cSrcweir                mxDocCursor.gotoEnd(false);
77*cdf0e10cSrcweir                // insert a paragraph break using the XSimpleText interface
78*cdf0e10cSrcweir                mxDocText.insertControlCharacter(
79*cdf0e10cSrcweir                                mxDocCursor, ControlCharacter.PARAGRAPH_BREAK, false);
80*cdf0e10cSrcweir                // Insert the user field at the end of the document
81*cdf0e10cSrcweir                mxDocText.insertTextContent(mxDocText.getEnd(), xUserField, false);
82*cdf0e10cSrcweir                </listing>
83*cdf0e10cSrcweir	 */
84*cdf0e10cSrcweir	void attachTextFieldMaster( [in] com::sun::star::beans::XPropertySet xFieldMaster )
85*cdf0e10cSrcweir			raises( com::sun::star::lang::IllegalArgumentException );
86*cdf0e10cSrcweir
87*cdf0e10cSrcweir	//-------------------------------------------------------------------------
88*cdf0e10cSrcweir
89*cdf0e10cSrcweir	/** @returns
90*cdf0e10cSrcweir                the previously attached <type>TextFieldMaster</type>
91*cdf0e10cSrcweir	 */
92*cdf0e10cSrcweir	com::sun::star::beans::XPropertySet getTextFieldMaster();
93*cdf0e10cSrcweir
94*cdf0e10cSrcweir};
95*cdf0e10cSrcweir
96*cdf0e10cSrcweir//=============================================================================
97*cdf0e10cSrcweir
98*cdf0e10cSrcweir}; }; }; };
99*cdf0e10cSrcweir
100*cdf0e10cSrcweir
101*cdf0e10cSrcweir#endif
102