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