xref: /aoo41x/main/offapi/com/sun/star/text/textfield/ConditionalText.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_textfield_ConditionalText_idl__
#define __com_sun_star_text_textfield_ConditionalText_idl_

#include <com/sun/star/text/TextField.idl>

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

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

//=============================================================================
/** specifies service of a conditional text field.
	@see com::sun::star::text::TextField
*/
published service ConditionalText
{
	service  com::sun::star::text::TextField;

    /** contains the text that is displayed if the condition evaluates to <TRUE/>.
	 */
	[property] string TrueContent;
    /** contains the text that is displayed if the condition evaluates to <FALSE/>.
	 */
	[property] string FalseContent;
	/** contains the condition.
	 */
	[property] string Condition;
    /** contains the result of the last evaluation of the condition.
     <p>This property has to be read/written in file export/import to save and
     restore the result without initiation of a new evaluation.</p>
	 */
    [property] boolean IsConditionTrue;
    /** contains the current content of the text field.
                <p> This property is escpecially usefull for import/export purposes. </p>
         */
    [optional, property]string CurrentPresentation;
};

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

}; }; }; }; };

#endif