/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   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 .
 */

#ifndef __com_sun_star_form_component_RichTextControl_idl__
#define __com_sun_star_form_component_RichTextControl_idl__

#include <com/sun/star/awt/UnoControlEditModel.idl>
#include <com/sun/star/form/FormControlModel.idl>
#include <com/sun/star/text/TextRange.idl>


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


/** specifies a component which extends the com::sun::star::awt::UnoControlEditModel
    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
        com::sun::star::awt::UnoControlEditModel
    */
    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
        com::sun::star::awt::UnoControlEditModel.</p>

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


}; }; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */