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