xref: /trunk/main/offapi/com/sun/star/text/XDependentTextField.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#ifndef __com_sun_star_text_XDependentTextField_idl__
#define __com_sun_star_text_XDependentTextField_idl__

#ifndef __com_sun_star_text_XTextField_idl__
#include <com/sun/star/text/XTextField.idl>
#endif

#ifndef __com_sun_star_beans_XPropertySet_idl__
#include <com/sun/star/beans/XPropertySet.idl>
#endif

#ifndef __com_sun_star_lang_IllegalArgumentException_idl__
#include <com/sun/star/lang/IllegalArgumentException.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module text {

//=============================================================================

/** makes it possible to attach this <type>TextField</type> to a
	<type>TextFieldMaster</type>.
 */
published interface XDependentTextField: com::sun::star::text::XTextField
{
	//-------------------------------------------------------------------------

	/** method must be called to attach the
		<type>TextFieldMaster</type> to this <type>TextField</type>.
		<p>A <type>TextFieldMaster</type> can only be assigned once.
		</p>

		@example Create and insert a user field (with a
                <code>UserField</code>):

		<listing>
                // Create a fieldmaster for our newly created User Text field, and access it's
                // XPropertySet interface
                XPropertySet xMasterPropSet = (XPropertySet) UnoRuntime.queryInterface(
                                XPropertySet.class, mxDocFactory.createInstance(
                                                "com.sun.star.text.FieldMaster.User"));
                // Set the name and value of the FieldMaster
                xMasterPropSet.setPropertyValue ("Name", "UserEmperor");
                xMasterPropSet.setPropertyValue ("Value", new Integer(42));
                // Attach the field master to the user field
                xUserField.attachTextFieldMaster (xMasterPropSet);
                // Move the cursor to the end of the document
                mxDocCursor.gotoEnd(false);
                // insert a paragraph break using the XSimpleText interface
                mxDocText.insertControlCharacter(
                                mxDocCursor, ControlCharacter.PARAGRAPH_BREAK, false);
                // Insert the user field at the end of the document
                mxDocText.insertTextContent(mxDocText.getEnd(), xUserField, false);
                </listing>
	 */
	void attachTextFieldMaster( [in] com::sun::star::beans::XPropertySet xFieldMaster )
			raises( com::sun::star::lang::IllegalArgumentException );

	//-------------------------------------------------------------------------

	/** @returns
                the previously attached <type>TextFieldMaster</type>
	 */
	com::sun::star::beans::XPropertySet getTextFieldMaster();

};

//=============================================================================

}; }; }; };


#endif