1d1766043SAndrew Rist/**************************************************************
2cdf0e10cSrcweir *
3d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one
4d1766043SAndrew Rist * or more contributor license agreements.  See the NOTICE file
5d1766043SAndrew Rist * distributed with this work for additional information
6d1766043SAndrew Rist * regarding copyright ownership.  The ASF licenses this file
7d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the
8d1766043SAndrew Rist * "License"); you may not use this file except in compliance
9d1766043SAndrew Rist * with the License.  You may obtain a copy of the License at
10d1766043SAndrew Rist *
11d1766043SAndrew Rist *   http://www.apache.org/licenses/LICENSE-2.0
12d1766043SAndrew Rist *
13d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing,
14d1766043SAndrew Rist * software distributed under the License is distributed on an
15d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16d1766043SAndrew Rist * KIND, either express or implied.  See the License for the
17d1766043SAndrew Rist * specific language governing permissions and limitations
18d1766043SAndrew Rist * under the License.
19d1766043SAndrew Rist *
20d1766043SAndrew Rist *************************************************************/
21d1766043SAndrew Rist
22d1766043SAndrew Rist
23cdf0e10cSrcweir
24cdf0e10cSrcweir#ifndef __com_sun_star_text_XTextMarkup_idl__
25cdf0e10cSrcweir#define __com_sun_star_text_XTextMarkup_idl__
26cdf0e10cSrcweir
27cdf0e10cSrcweir#ifndef __com_sun_star_container_XStringKeyMap_idl__
28cdf0e10cSrcweir#include <com/sun/star/container/XStringKeyMap.idl>
29cdf0e10cSrcweir#endif
30cdf0e10cSrcweir
31cdf0e10cSrcweir#ifndef __com_sun_star_text_TextMarkupType_idl__
32cdf0e10cSrcweir#include <com/sun/star/text/TextMarkupType.idl>
33cdf0e10cSrcweir#endif
34cdf0e10cSrcweir
351ced0919SJürgen Schmidt#ifndef __com_sun_star_text_XTextRange_idl__
361ced0919SJürgen Schmidt#include <com/sun/star/text/XTextRange.idl>
371ced0919SJürgen Schmidt#endif
381ced0919SJürgen Schmidt
391ced0919SJürgen Schmidt
40cdf0e10cSrcweir//=============================================================================
41cdf0e10cSrcweir
42cdf0e10cSrcweirmodule com {  module sun {  module star {  module text {
43cdf0e10cSrcweir
44cdf0e10cSrcweir//=============================================================================
45cdf0e10cSrcweir
46cdf0e10cSrcweir/** provides functionality to markup text.
47cdf0e10cSrcweir
48*2a413f17SJürgen Schmidt    @since OpenOffice 2.3
49cdf0e10cSrcweir */
50cdf0e10cSrcweir
51cdf0e10cSrcweirinterface XTextMarkup
52cdf0e10cSrcweir{
53cdf0e10cSrcweir    //-------------------------------------------------------------------------
54cdf0e10cSrcweir    /** obtains a container to store additional user defined text markup
55cdf0e10cSrcweir        information.
56cdf0e10cSrcweir
57cdf0e10cSrcweir        @return
58cdf0e10cSrcweir                a container to store additional user defined text markup
59cdf0e10cSrcweir                information.
60cdf0e10cSrcweir     */
61cdf0e10cSrcweir    com::sun::star::container::XStringKeyMap getMarkupInfoContainer();
62cdf0e10cSrcweir
63cdf0e10cSrcweir
64cdf0e10cSrcweir    //-------------------------------------------------------------------------
65cdf0e10cSrcweir    /** submits a new markup range.
66cdf0e10cSrcweir
67cdf0e10cSrcweir        @param nType
68cdf0e10cSrcweir                Type of text markup see <type>TextMarkupType</type>.
69cdf0e10cSrcweir
70cdf0e10cSrcweir        @param aIdentifier
71cdf0e10cSrcweir                A string used to identify the caller.
72cdf0e10cSrcweir
73cdf0e10cSrcweir        @param nStart
74cdf0e10cSrcweir                Start of the markup range.
75cdf0e10cSrcweir
76cdf0e10cSrcweir        @param nLength
77cdf0e10cSrcweir                Length of the markup range.
78cdf0e10cSrcweir
79cdf0e10cSrcweir        @param xMarkupInfoContainer
80cdf0e10cSrcweir                contains additional information about the markup.
81cdf0e10cSrcweir     */
821ced0919SJürgen Schmidt    void commitStringMarkup( [in] long nType,
83cdf0e10cSrcweir                           [in] string aIdentifier,
84cdf0e10cSrcweir                           [in] long nStart,
85cdf0e10cSrcweir                           [in] long nLength,
86cdf0e10cSrcweir                           [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
871ced0919SJürgen Schmidt
881ced0919SJürgen Schmidt    void commitTextRangeMarkup( [in] long nType,
891ced0919SJürgen Schmidt                                [in] string aIdentifier,
901ced0919SJürgen Schmidt                                [in] com::sun::star::text::XTextRange xRange,
911ced0919SJürgen Schmidt                                [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
921ced0919SJürgen Schmidt
93cdf0e10cSrcweir};
94cdf0e10cSrcweir
95cdf0e10cSrcweir}; }; }; };
96cdf0e10cSrcweir
97cdf0e10cSrcweir#endif
98