offapi/com/sun/star/text/XTextMarkup.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2008 by Sun Microsystems, Inc.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * $RCSfile: XTextMarkup.idl,v $
  10  * $Revision: 1.3 $
  11  *
  12  * This file is part of OpenOffice.org.
  13  *
  14  * OpenOffice.org is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU Lesser General Public License version 3
  16  * only, as published by the Free Software Foundation.
  17  *
  18  * OpenOffice.org is distributed in the hope that it will be useful,
  19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21  * GNU Lesser General Public License version 3 for more details
  22  * (a copy is included in the LICENSE file that accompanied this code).
  23  *
  24  * You should have received a copy of the GNU Lesser General Public License
  25  * version 3 along with OpenOffice.org.  If not, see
  26  * <http://www.openoffice.org/license.html>
  27  * for a copy of the LGPLv3 License.
  28  *
  29  ************************************************************************/
  30
  31 #ifndef __com_sun_star_text_XTextMarkup_idl__
  32 #define __com_sun_star_text_XTextMarkup_idl__
  33
  34 #ifndef __com_sun_star_container_XStringKeyMap_idl__
  35 #include <com/sun/star/container/XStringKeyMap.idl>
  36 #endif
  37
  38 #ifndef __com_sun_star_text_TextMarkupType_idl__
  39 #include <com/sun/star/text/TextMarkupType.idl>
  40 #endif
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module text {
  45
  46 //=============================================================================
  47
  48 /** provides functionality to markup text.
  49
  50     @since OOo 2.3.0
  51  */
  52
  53 interface XTextMarkup
  54 {
  55     //-------------------------------------------------------------------------
  56     /** obtains a container to store additional user defined text markup
  57         information.
  58
  59         @return
  60                 a container to store additional user defined text markup
  61                 information.
  62      */
  63     com::sun::star::container::XStringKeyMap getMarkupInfoContainer();
  64
  65
  66     //-------------------------------------------------------------------------
  67     /** submits a new markup range.
  68
  69         @param nType
  70                 Type of text markup see <type>TextMarkupType</type>.
  71
  72         @param aIdentifier
  73                 A string used to identify the caller.
  74
  75         @param nStart
  76                 Start of the markup range.
  77
  78         @param nLength
  79                 Length of the markup range.
  80
  81         @param xMarkupInfoContainer
  82                 contains additional information about the markup.
  83      */
  84     void commitTextMarkup( [in] long nType,
  85                            [in] string aIdentifier,
  86                            [in] long nStart,
  87                            [in] long nLength,
  88                            [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
  89 };
  90
  91 }; }; }; };
  92
  93 #endif