LibreOffice LibreOffice 25.8 SDK API Reference

XTextComponent.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21
22 module com { module sun { module star { module awt {
23
24
28published interface XTextComponent: com::sun::star::uno::XInterface
29{
30
33 void addTextListener( [in] com::sun::star::awt::XTextListener l );
34
35
38 void removeTextListener( [in] com::sun::star::awt::XTextListener l );
39
40
43 void setText( [in] string aText );
44
45
48 void insertText( [in] com::sun::star::awt::Selection Sel,
49 [in] string Text );
50
51
54 string getText();
55
56
59 string getSelectedText();
60
61
64 void setSelection( [in] com::sun::star::awt::Selection aSelection );
65
66
69 com::sun::star::awt::Selection getSelection();
70
71
74 boolean isEditable();
75
76
79 void setEditable( [in] boolean bEditable );
80
81
84 void setMaxTextLen( [in] short nLen );
85
86
89 short getMaxTextLen();
90
91};
92
93
94}; }; }; };
95
96/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::awt::XTextComponent
gives access to the text of a component and makes it possible to register event listeners.
Definition: XTextComponent.idl:29
com::sun::star::awt::XTextComponent::setEditable
void setEditable([in] boolean bEditable)
makes the text editable for the user or read-only.
com::sun::star::awt::XTextComponent::addTextListener
void addTextListener([in] com::sun::star::awt::XTextListener l)
registers a text event listener.
com::sun::star::awt::XTextComponent::getMaxTextLen
short getMaxTextLen()
returns the currently set maximum text length.
com::sun::star::awt::XTextComponent::setMaxTextLen
void setMaxTextLen([in] short nLen)
sets the maximum text length.
com::sun::star::awt::XTextComponent::setSelection
void setSelection([in] com::sun::star::awt::Selection aSelection)
sets the user selection.
com::sun::star::awt::XTextComponent::setText
void setText([in] string aText)
sets the text of the component.
com::sun::star::awt::XTextComponent::getText
string getText()
returns the text of the component.
com::sun::star::awt::XTextComponent::getSelectedText
string getSelectedText()
returns the currently selected text.
com::sun::star::awt::XTextComponent::isEditable
boolean isEditable()
returns if the text is editable by the user.
com::sun::star::awt::XTextComponent::removeTextListener
void removeTextListener([in] com::sun::star::awt::XTextListener l)
unregisters a text event listener.
com::sun::star::awt::XTextComponent::getSelection
com::sun::star::awt::Selection getSelection()
returns the current user selection.
com::sun::star::awt::XTextComponent::insertText
void insertText([in] com::sun::star::awt::Selection Sel, [in] string Text)
inserts text at the specified position.
com::sun::star::awt::XTextListener
makes it possible to receive text change events.
Definition: XTextListener.idl:28
com::sun::star::uno::XInterface
base interface of all UNO interfaces
Definition: XInterface.idl:46
com
Definition: Ambiguous.idl:20
com::sun::star::awt::Selection
specifies a numerical range.
Definition: Selection.idl:28