offapi/com/sun/star/text/DocumentIndexMark.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: DocumentIndexMark.idl,v $
  10  * $Revision: 1.7 $
  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_DocumentIndexMark_idl__
  31 #define __com_sun_star_text_DocumentIndexMark_idl__
  32
  33 #ifndef __com_sun_star_text_TextContent_idl__
  34 #include <com/sun/star/text/TextContent.idl>
  35 #endif
  36 #ifndef __com_sun_star_text_BaseIndexMark_idl__
  37 #include <com/sun/star/text/BaseIndexMark.idl>
  38 #endif
  39
  40
  41 //=============================================================================
  42
  43  module com {  module sun {  module star {  module text {
  44
  45 //=============================================================================
  46
  47 /** is a <type>TextRange</type> which is explicitly marked
  48     as an index entry for a <type>DocumentIndex</type>.
  49  */
  50 published service DocumentIndexMark
  51 {
  52     service com::sun::star::text::TextContent;
  53
  54     service com::sun::star::text::BaseIndexMark;
  55
  56     //-------------------------------------------------------------------------
  57     /** contains the primary key of the index entry.
  58          It is used to build a hierarchical document index.
  59      */
  60     [property] string PrimaryKey;
  61     //-------------------------------------------------------------------------
  62     /** contains the secondary key of the index entry.
  63          It is used to build a hierarchical document index.
  64      */
  65     [property] string SecondaryKey;
  66     //-------------------------------------------------------------------------
  67     /** determins if this entry is a main entry. In a document index this entry will
  68         be emphasized by assigning a character style to it.
  69      */
  70     [property] boolean IsMainEntry;
  71 };
  72
  73 //=============================================================================
  74
  75 }; }; }; };
  76 #endif