xref: /aoo4110/main/offapi/com/sun/star/form/component/RichTextControl.idl (revision b1cdbd2c)

/**************************************************************
 *
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/



#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