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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_text_XTextMarkup_idl__
  21 #define __com_sun_star_text_XTextMarkup_idl__
  22
  23 #include <com/sun/star/container/XStringKeyMap.idl>
  24 #include <com/sun/star/text/TextMarkupType.idl>
  25 #include <com/sun/star/text/XTextRange.idl>
  26
  27
  28 module com {  module sun {  module star {  module text {
  29
  30
  31 /** provides functionality to markup text.
  32
  33     @since OOo 2.3
  34  */
  35
  36 interface XTextMarkup
  37 {
  38     /** obtains a container to store additional user defined text markup
  39         information.
  40
  41         @return
  42                 a container to store additional user defined text markup
  43                 information.
  44      */
  45     com::sun::star::container::XStringKeyMap getMarkupInfoContainer();
  46
  47
  48     /** submits a new markup range.
  49
  50         @param nType
  51                 Type of text markup see TextMarkupType.
  52
  53         @param aIdentifier
  54                 A string used to identify the caller.
  55
  56         @param nStart
  57                 Start of the markup range.
  58
  59         @param nLength
  60                 Length of the markup range.
  61
  62         @param xMarkupInfoContainer
  63                 contains additional information about the markup.
  64      */
  65     void commitStringMarkup( [in] long nType,
  66                            [in] string aIdentifier,
  67                            [in] long nStart,
  68                            [in] long nLength,
  69                            [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
  70
  71     void commitTextRangeMarkup( [in] long nType,
  72                                 [in] string aIdentifier,
  73                                 [in] com::sun::star::text::XTextRange xRange,
  74                                 [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
  75
  76 };
  77
  78 }; }; }; };
  79
  80 #endif
  81
  82 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */