/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: RichTextControl.idl,v $
 *
 *  $Revision: 1.4 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 00:44:08 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library 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 for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/

#ifndef __com_sun_star_form_component_RichTextControl_idl__
#define __com_sun_star_form_component_RichTextControl_idl__

#ifndef __com_sun_star_awt_UnoControlEditModel_idl__
#include <com/sun/star/awt/UnoControlEditModel.idl>
#endif

#ifndef __com_sun_star_form_FormControlModel_idl__
#include <com/sun/star/form/FormControlModel.idl>
#endif

#ifndef __com_sun_star_text_TextRange_idl__
#include <com/sun/star/text/TextRange.idl>
#endif

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

 module com {  module sun {  module star {  module form {  module component {

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

/** specifies a component which extends the <type scope="com::sun::star::awt">UnoControlEditModel</type>
    with capabilities to display and input formatted text.
*/
published service RichTextControl
{
    service com::sun::star::awt::UnoControlEditModel;

    service com::sun::star::form::FormControlModel;

    /** specifies capabilities to provide rich text, as opposed to the simple text provided by the
        <type scope="com::sun::star::awt">UnoControlEditModel</type>
    */
    service com::sun::star::text::TextRange;

    /** specifies whether text should be automatically wrapped to fit into the control.

        <p>If set to <TRUE/>, users need to manually press the enter key to insert a line break.
        If set to <FALSE/>, text is automatically wrapped at the control border.</p>
    */
    [property] boolean HardLineBreaks;

    /** specifies whether the control should display the text including all its formatting.

        <p>If this is set to <FALSE/>, the control will act as ordinary
        <type scope="com::sun::star::awt">UnoControlEditModel</type>.</p>

        <p>If the property is set to <TRUE/>, the control will ignore the following properties:
        <ul>
            <li><member scope="com::sun::star::awt">UnoControlEditModel::EchoChar</member></li>
            <li><member scope="com::sun::star::awt">UnoControlEditModel::MaxTextLen</member></li>
            <li><member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member></li>
            <li><member scope="com::sun::star::awt">UnoControlEditModel::Align</member></li>
        </ul>
        </p>
    */
    [property] boolean RichText;
};

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

}; }; }; }; };

#endif
