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

   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
  28 #ifndef __com_sun_star_text_XTextMarkup_idl__
  29 #define __com_sun_star_text_XTextMarkup_idl__
  30
  31 #ifndef __com_sun_star_container_XStringKeyMap_idl__
  32 #include <com/sun/star/container/XStringKeyMap.idl>
  33 #endif
  34
  35 #ifndef __com_sun_star_text_TextMarkupType_idl__
  36 #include <com/sun/star/text/TextMarkupType.idl>
  37 #endif
  38
  39 //=============================================================================
  40
  41 module com {  module sun {  module star {  module text {
  42
  43 //=============================================================================
  44
  45 /** provides functionality to markup text.
  46
  47     @since OOo 2.3.0
  48  */
  49
  50 interface XTextMarkup
  51 {
  52     //-------------------------------------------------------------------------
  53     /** obtains a container to store additional user defined text markup
  54         information.
  55
  56         @return
  57                 a container to store additional user defined text markup
  58                 information.
  59      */
  60     com::sun::star::container::XStringKeyMap getMarkupInfoContainer();
  61
  62
  63     //-------------------------------------------------------------------------
  64     /** submits a new markup range.
  65
  66         @param nType
  67                 Type of text markup see <type>TextMarkupType</type>.
  68
  69         @param aIdentifier
  70                 A string used to identify the caller.
  71
  72         @param nStart
  73                 Start of the markup range.
  74
  75         @param nLength
  76                 Length of the markup range.
  77
  78         @param xMarkupInfoContainer
  79                 contains additional information about the markup.
  80      */
  81     void commitTextMarkup( [in] long nType,
  82                            [in] string aIdentifier,
  83                            [in] long nStart,
  84                            [in] long nLength,
  85                            [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
  86 };
  87
  88 }; }; }; };
  89
  90 #endif