summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/form/component/RichTextControl.idl
blob: 0566f658a197c40810180eb29d79499663d6ae7e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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