offapi/com/sun/star/text/XDocumentIndexMark.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: XDocumentIndexMark.idl,v $
  10  * $Revision: 1.12 $
  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_XDocumentIndexMark_idl__
  31 #define __com_sun_star_text_XDocumentIndexMark_idl__
  32
  33 #ifndef __com_sun_star_text_XTextContent_idl__
  34 #include <com/sun/star/text/XTextContent.idl>
  35 #endif
  36
  37
  38 //=============================================================================
  39
  40  module com {  module sun {  module star {  module text {
  41
  42 //=============================================================================
  43
  44 // DocMerge from xml: interface com::sun::star::text::XDocumentIndexMark
  45 /** gives access to the mark of a document index entry.@see DocumentIndexMark
  46  */
  47 published interface XDocumentIndexMark: com::sun::star::text::XTextContent
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     // DocMerge from idl: method com::sun::star::text::XDocumentIndexMark::getMarkEntry
  52     /** @returns
  53                 the explicitly set string for the index mark.
  54
  55          @see setMarkEntry
  56      */
  57     string getMarkEntry();
  58
  59     //-------------------------------------------------------------------------
  60
  61     // DocMerge from xml: method com::sun::star::text::XDocumentIndexMark::setMarkEntry
  62     /** sets an explicit string for this index mark to use
  63         in the index.
  64
  65
  66
  67         <p>If empty, the string of the <type>TextRange</type> to which
  68         the <type>TextContent</type> refers is used in the index.</p>
  69      */
  70     void setMarkEntry( [in] string aIndexEntry );
  71
  72 };
  73
  74 //=============================================================================
  75
  76 }; }; }; };
  77
  78
  79 #endif