xref: /trunk/main/offapi/com/sun/star/text/TextCursor.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_text_TextCursor_idl__
28#define __com_sun_star_text_TextCursor_idl__
29
30#ifndef __com_sun_star_text_TextRange_idl__
31#include <com/sun/star/text/TextRange.idl>
32#endif
33
34#ifndef __com_sun_star_text_XTextCursor_idl__
35#include <com/sun/star/text/XTextCursor.idl>
36#endif
37
38#ifndef __com_sun_star_text_XWordCursor_idl__
39#include <com/sun/star/text/XWordCursor.idl>
40#endif
41
42#ifndef __com_sun_star_text_XSentenceCursor_idl__
43#include <com/sun/star/text/XSentenceCursor.idl>
44#endif
45
46#ifndef __com_sun_star_text_XParagraphCursor_idl__
47#include <com/sun/star/text/XParagraphCursor.idl>
48#endif
49
50#ifndef __com_sun_star_beans_XPropertySet_idl__
51#include <com/sun/star/beans/XPropertySet.idl>
52#endif
53
54#ifndef __com_sun_star_beans_XPropertyState_idl__
55#include <com/sun/star/beans/XPropertyState.idl>
56#endif
57
58#ifndef __com_sun_star_beans_XMultiPropertyStates_idl__
59#include <com/sun/star/beans/XMultiPropertyStates.idl>
60#endif
61
62#ifndef __com_sun_star_document_XDocumentInsertable_idl__
63#include <com/sun/star/document/XDocumentInsertable.idl>
64#endif
65
66#ifndef __com_sun_star_util_XSortable_idl__
67#include <com/sun/star/util/XSortable.idl>
68#endif
69
70
71//=============================================================================
72
73 module com {  module sun {  module star {  module text {
74
75//=============================================================================
76
77// DocMerge from xml: service com::sun::star::text::TextCursor
78/** A <type>TextCursor</type> is a <type>TextRange</type> which can be moved
79    within a <type>Text</type> object.
80    @see TextRange
81 */
82published service TextCursor
83{
84    // DocMerge: empty anyway
85    service com::sun::star::text::TextRange;
86
87    interface com::sun::star::text::XTextCursor;
88
89    // DocMerge: empty anyway
90    [optional] interface com::sun::star::text::XWordCursor;
91
92    // DocMerge: empty anyway
93    [optional] interface com::sun::star::text::XSentenceCursor;
94
95    // DocMerge: empty anyway
96    [optional] interface com::sun::star::text::XParagraphCursor;
97
98
99    // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::beans::XPropertySet
100    /** This interface gives access to the properties of the range that is
101                selected by the cursor.
102     */
103    interface com::sun::star::beans::XPropertySet;
104
105
106    // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::beans::XPropertyState
107    /** This interface gives access to the state of the properties of the
108                range that is selected by the cursor.
109     */
110    interface com::sun::star::beans::XPropertyState;
111    interface com::sun::star::beans::XMultiPropertyStates;
112
113
114    // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::document::XDocumentInsertable
115    /** This optional interface makes it possible to insert a document
116                from an external source at the cursor position.
117     */
118    [optional] interface com::sun::star::document::XDocumentInsertable;
119
120
121    // DocMerge from xml: service com::sun::star::text::TextCursor: interface com::sun::star::util::XSortable
122    /** This optional interface makes it possible to sort the contents at
123                the cursor position.
124     */
125    [optional] interface com::sun::star::util::XSortable;
126
127};
128
129//=============================================================================
130
131}; }; }; };
132
133/*=============================================================================
134
135=============================================================================*/
136#endif
137