offapi/com/sun/star/text/BaseIndexMark.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: BaseIndexMark.idl,v $
  10  * $Revision: 1.5 $
  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 #ifndef __com_sun_star_text_BaseIndexMark_idl__
  31 #define __com_sun_star_text_BaseIndexMark_idl__
  32
  33 #ifndef __com_sun_star_text_TextContent_idl__
  34 #include <com/sun/star/text/TextContent.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 /** is a <type>TextRange</type> which is explicitly marked
  45     as an index entry. This is the base service of index marks for <type>DocumentIndex</type>,
  46      <type>ContentIndex</type>, and <type>UserIndex</type>.
  47  */
  48 published service BaseIndexMark
  49 {
  50     service com::sun::star::text::TextContent;
  51     //-------------------------------------------------------------------------
  52
  53     /** the string that will be inserted into the corresponding index. If AlternativeText is empty then
  54         the string that is marked by the TextRange is inserted into the index.
  55      */
  56     [property] string AlternativeText;
  57 };
  58
  59 //=============================================================================
  60
  61 }; }; }; };
  62 #endif
  63
  64