summaryrefslogtreecommitdiff
path: root/offapi/com/sun/star/awt/XTextComponent.idl
blob: 963884cbe1bd246adc640036d6356d48e008f601 (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
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2008 by Sun Microsystems, Inc.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * $RCSfile: XTextComponent.idl,v $
 * $Revision: 1.9 $
 *
 * 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_awt_XTextComponent_idl__
#define __com_sun_star_awt_XTextComponent_idl__

#ifndef __com_sun_star_uno_XInterface_idl__
#include <com/sun/star/uno/XInterface.idl>
#endif

#ifndef __com_sun_star_awt_XTextListener_idl__
#include <com/sun/star/awt/XTextListener.idl>
#endif

#ifndef __com_sun_star_awt_Selection_idl__
#include <com/sun/star/awt/Selection.idl>
#endif


//=============================================================================

 module com {  module sun {  module star {  module awt {

//=============================================================================

/** gives access to the text of a component and makes it possible
    to register event listeners.
 */
published interface XTextComponent: com::sun::star::uno::XInterface
{
    //-------------------------------------------------------------------------

    /** registers a text event listener.
     */
    [oneway] void addTextListener( [in] com::sun::star::awt::XTextListener l );

    //-------------------------------------------------------------------------

    /** unregisters a text event listener.
     */
    [oneway] void removeTextListener( [in] com::sun::star::awt::XTextListener l );

    //-------------------------------------------------------------------------

    /** sets the text of the component.
     */
    [oneway] void setText( [in] string aText );

    //-------------------------------------------------------------------------

    /** inserts text at the specified position.
     */
    [oneway] void insertText( [in] com::sun::star::awt::Selection Sel,
             [in] string Text );

    //-------------------------------------------------------------------------

    /** returns the text of the component.
     */
    string getText();

    //-------------------------------------------------------------------------

    /** returns the currently selected text.
     */
    string getSelectedText();

    //-------------------------------------------------------------------------

    /** sets the user selection.
     */
    [oneway] void setSelection( [in] com::sun::star::awt::Selection aSelection );

    //-------------------------------------------------------------------------

    /** returns the current user selection.
     */
    com::sun::star::awt::Selection getSelection();

    //-------------------------------------------------------------------------

    /** returns if the text is editable by the user.
     */
    boolean isEditable();

    //-------------------------------------------------------------------------

    /** makes the text editable for the user or read-only.
     */
    [oneway] void setEditable( [in] boolean bEditable );

    //-------------------------------------------------------------------------

    /** sets the maximum text length.
     */
    [oneway] void setMaxTextLen( [in] short nLen );

    //-------------------------------------------------------------------------

    /** returns the currently set maximum text length.
     */
    short getMaxTextLen();

};

//=============================================================================

}; }; }; };

#endif