1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27
28#ifndef __com_sun_star_form_component_RichTextControl_idl__
29#define __com_sun_star_form_component_RichTextControl_idl__
30
31#ifndef __com_sun_star_awt_UnoControlEditModel_idl__
32#include <com/sun/star/awt/UnoControlEditModel.idl>
33#endif
34
35#ifndef __com_sun_star_form_FormControlModel_idl__
36#include <com/sun/star/form/FormControlModel.idl>
37#endif
38
39#ifndef __com_sun_star_text_TextRange_idl__
40#include <com/sun/star/text/TextRange.idl>
41#endif
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module form {  module component {
46
47//=============================================================================
48
49/** specifies a component which extends the <type scope="com::sun::star::awt">UnoControlEditModel</type>
50    with capabilities to display and input formatted text.
51*/
52published service RichTextControl
53{
54	service com::sun::star::awt::UnoControlEditModel;
55
56	service com::sun::star::form::FormControlModel;
57
58    /** specifies capabilities to provide rich text, as opposed to the simple text provided by the
59        <type scope="com::sun::star::awt">UnoControlEditModel</type>
60    */
61    service com::sun::star::text::TextRange;
62
63    /** specifies whether text should be automatically wrapped to fit into the control.
64
65        <p>If set to <TRUE/>, users need to manually press the enter key to insert a line break.
66        If set to <FALSE/>, text is automatically wrapped at the control border.</p>
67    */
68    [property] boolean HardLineBreaks;
69
70    /** specifies whether the control should display the text including all its formatting.
71
72        <p>If this is set to <FALSE/>, the control will act as ordinary
73        <type scope="com::sun::star::awt">UnoControlEditModel</type>.</p>
74
75        <p>If the property is set to <TRUE/>, the control will ignore the following properties:
76        <ul>
77            <li><member scope="com::sun::star::awt">UnoControlEditModel::EchoChar</member></li>
78            <li><member scope="com::sun::star::awt">UnoControlEditModel::MaxTextLen</member></li>
79            <li><member scope="com::sun::star::awt">UnoControlEditModel::MultiLine</member></li>
80            <li><member scope="com::sun::star::awt">UnoControlEditModel::Align</member></li>
81        </ul>
82        </p>
83    */
84    [property] boolean RichText;
85};
86
87//=============================================================================
88
89}; }; }; }; };
90
91#endif
92