offapi/com/sun/star/text/TextMarkupDescriptor.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_TextMarkupDescriptor_idl__
  29 #define __com_sun_star_text_TextMarkupDescriptor_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
  42 module com {  module sun {  module star {  module text {
  43
  44 //=============================================================================
  45
  46 /** A descriptor for a single text markup.
  47
  48     @since OOo 3.0.1
  49  */
  50
  51 struct TextMarkupDescriptor
  52 {
  53     /// Type of text markup see <type>TextMarkupType</type>
  54     long        nType;
  55
  56     /// A string used to identify the caller
  57     string      aIdentifier;
  58
  59     /// Start of the markup range
  60     long        nOffset;
  61
  62     /// Length of the markup range
  63     long        nLength;
  64
  65     /// contains additional information about the markup
  66     com::sun::star::container::XStringKeyMap xMarkupInfoContainer;
  67 };
  68
  69 }; }; }; };
  70 #endif