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
  21 module com {  module sun {  module star {  module text {
  22
  23
  24 /** provides functionality to markup text.
  25
  26     @since OOo 2.3
  27  */
  28
  29 interface XTextMarkup
  30 {
  31     /** obtains a container to store additional user defined text markup
  32         information.
  33
  34         @return
  35                 a container to store additional user defined text markup
  36                 information.
  37      */
  38     com::sun::star::container::XStringKeyMap getMarkupInfoContainer();
  39
  40
  41     /** submits a new markup range.
  42
  43         @param nType
  44                 Type of text markup see TextMarkupType.
  45
  46         @param aIdentifier
  47                 A string used to identify the caller.
  48
  49         @param nStart
  50                 Start of the markup range.
  51
  52         @param nLength
  53                 Length of the markup range.
  54
  55         @param xMarkupInfoContainer
  56                 contains additional information about the markup.
  57      */
  58     void commitStringMarkup( [in] long nType,
  59                            [in] string aIdentifier,
  60                            [in] long nStart,
  61                            [in] long nLength,
  62                            [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
  63
  64     void commitTextRangeMarkup( [in] long nType,
  65                                 [in] string aIdentifier,
  66                                 [in] com::sun::star::text::XTextRange xRange,
  67                                 [in] com::sun::star::container::XStringKeyMap xMarkupInfoContainer );
  68
  69 };
  70
  71 }; }; }; };
  72
  73 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */