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