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#ifndef __com_sun_star_awt_XTextComponent_idl__
28#define __com_sun_star_awt_XTextComponent_idl__
29
30#ifndef __com_sun_star_uno_XInterface_idl__
31#include <com/sun/star/uno/XInterface.idl>
32#endif
33
34#ifndef __com_sun_star_awt_XTextListener_idl__
35#include <com/sun/star/awt/XTextListener.idl>
36#endif
37
38#ifndef __com_sun_star_awt_Selection_idl__
39#include <com/sun/star/awt/Selection.idl>
40#endif
41
42
43//=============================================================================
44
45 module com {  module sun {  module star {  module awt {
46
47//=============================================================================
48
49/** gives access to the text of a component and makes it possible
50	to register event listeners.
51 */
52published interface XTextComponent: com::sun::star::uno::XInterface
53{
54	//-------------------------------------------------------------------------
55
56	/** registers a text event listener.
57	 */
58	[oneway] void addTextListener( [in] com::sun::star::awt::XTextListener l );
59
60	//-------------------------------------------------------------------------
61
62	/** unregisters a text event listener.
63	 */
64	[oneway] void removeTextListener( [in] com::sun::star::awt::XTextListener l );
65
66	//-------------------------------------------------------------------------
67
68	/** sets the text of the component.
69	 */
70	[oneway] void setText( [in] string aText );
71
72	//-------------------------------------------------------------------------
73
74	/** inserts text at the specified position.
75	 */
76	[oneway] void insertText( [in] com::sun::star::awt::Selection Sel,
77			 [in] string Text );
78
79	//-------------------------------------------------------------------------
80
81	/** returns the text of the component.
82	 */
83	string getText();
84
85	//-------------------------------------------------------------------------
86
87	/** returns	the currently selected text.
88	 */
89	string getSelectedText();
90
91	//-------------------------------------------------------------------------
92
93	/** sets the user selection.
94	 */
95	[oneway] void setSelection( [in] com::sun::star::awt::Selection aSelection );
96
97	//-------------------------------------------------------------------------
98
99	/** returns the current user selection.
100	 */
101	com::sun::star::awt::Selection getSelection();
102
103	//-------------------------------------------------------------------------
104
105	/** returns if the text is editable by the user.
106	 */
107	boolean isEditable();
108
109	//-------------------------------------------------------------------------
110
111	/** makes the text editable for the user or read-only.
112	 */
113	[oneway] void setEditable( [in] boolean bEditable );
114
115	//-------------------------------------------------------------------------
116
117	/** sets the maximum text length.
118	 */
119	[oneway] void setMaxTextLen( [in] short nLen );
120
121	//-------------------------------------------------------------------------
122
123	/** returns the currently set maximum text length.
124	 */
125	short getMaxTextLen();
126
127};
128
129//=============================================================================
130
131}; }; }; };
132
133#endif
134