1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23
24#ifndef __com_sun_star_form_component_RichTextControl_idl__
25#define __com_sun_star_form_component_RichTextControl_idl__
26
27#ifndef __com_sun_star_awt_UnoControlEditModel_idl__
28#include <com/sun/star/awt/UnoControlEditModel.idl>
29#endif
30
31#ifndef __com_sun_star_form_FormControlModel_idl__
32#include <com/sun/star/form/FormControlModel.idl>
33#endif
34
35#ifndef __com_sun_star_text_TextRange_idl__
36#include <com/sun/star/text/TextRange.idl>
37#endif
38
39//=============================================================================
40
41 module com {  module sun {  module star {  module form {  module component {
42
43//=============================================================================
44
45/** specifies a component which extends the <type scope="com::sun::star::awt">UnoControlEditModel</type>
46    with capabilities to display and input formatted text.
47*/
48published service RichTextControl
49{
50	service com::sun::star::awt::UnoControlEditModel;
51
52	service com::sun::star::form::FormControlModel;
53
54    /** specifies capabilities to provide rich text, as opposed to the simple text provided by the
55        <type scope="com::sun::star::awt">UnoControlEditModel</type>
56    */
57    service com::sun::star::text::TextRange;
58
59    /** specifies whether text should be automatically wrapped to fit into the control.
60
61        <p>If set to <TRUE/>, users need to manually press the enter key to insert a line break.
62        If set to <FALSE/>, text is automatically wrapped at the control border.</p>
63    */
64    [property] boolean HardLineBreaks;
65
66    /** specifies whether the control should display the text including all its formatting.
67
68        <p>If this is set to <FALSE/>, the control will act as ordinary
69        <type scope="com::sun::star::awt">UnoControlEditModel</type>.</p>
70
71        <p>If the property is set to <TRUE/>, the control will ignore the following properties:
72        <ul>
73            <li><member scope="com::sun::star::awt">UnoControlEditModel::EchoChar</member></li>
74            <li><member scope="com::sun::star::awt">UnoControlEditModel::MaxTextLen</member></li>
75            <li><member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member></li>
76            <li><member scope="com::sun::star::awt">UnoControlEditModel::Align</member></li>
77        </ul>
78        </p>
79    */
80    [property] boolean RichText;
81};
82
83//=============================================================================
84
85}; }; }; }; };
86
87#endif
88