offapi/com/sun/star/util/SearchDescriptor.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: SearchDescriptor.idl,v $
  10  * $Revision: 1.9 $
  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_util_SearchDescriptor_idl__
  31 #define __com_sun_star_util_SearchDescriptor_idl__
  32
  33 #ifndef __com_sun_star_util_XSearchDescriptor_idl__
  34 #include <com/sun/star/util/XSearchDescriptor.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_beans_XPropertySet_idl__
  38 #include <com/sun/star/beans/XPropertySet.idl>
  39 #endif
  40
  41
  42 //=============================================================================
  43
  44 module com {  module sun {  module star {  module util {
  45
  46 //=============================================================================
  47
  48 /** describes what and how to search within a container.
  49  */
  50 published service SearchDescriptor
  51 {
  52     interface com::sun::star::util::XSearchDescriptor;
  53
  54     interface com::sun::star::beans::XPropertySet;
  55
  56     //-------------------------------------------------------------------------
  57     /** If <TRUE/>, the search is done backwards in the document.
  58      */
  59     [property] boolean SearchBackwards;
  60
  61     //-------------------------------------------------------------------------
  62     /** If <TRUE/>, the case of the letters is important for the match.
  63      */
  64     [property] boolean SearchCaseSensitive;
  65
  66     //-------------------------------------------------------------------------
  67     /** If <TRUE/>, only complete words will be found.
  68      */
  69     [property] boolean SearchWords;
  70
  71     //-------------------------------------------------------------------------
  72     /** If <TRUE/>, the search string is evaluated as a regular expression.
  73      */
  74     [property] boolean SearchRegularExpression;
  75
  76     //-------------------------------------------------------------------------
  77     /** If <TRUE/>, it is searched for positions where the paragraph style with
  78         the name of the search pattern is applied.
  79      */
  80     [property] boolean SearchStyles;
  81
  82     //-------------------------------------------------------------------------
  83     /** If <TRUE/>, a "similarity search" is performed.
  84
  85         <p>In the case of a similarity search, the following properties
  86         specify the kind of similarity:
  87         </p>
  88         <ul>
  89         <li>SearchSimilarityRelax
  90         </li>
  91         <li>SearchSimilarityRemove
  92         </li>
  93         <li>SearchSimilarityAdd
  94         </li>
  95         <li>SearchSimilarityExchange
  96         </li>
  97         </ul>
  98      */
  99     [property] boolean SearchSimilarity;
 100
 101     //-------------------------------------------------------------------------
 102     /** If <TRUE/>, all similarity rules are applied together.
 103
 104         <p>In the case of a relaxed similarity search, the following
 105         properties are applied together:
 106
 107         </p>
 108         <ul>
 109         <li>SearchSimilarityRemove
 110         </li>
 111         <li>SearchSimilarityAdd
 112         </li>
 113         <li>SearchSimilarityExchange
 114         </li>
 115         </ul>
 116      */
 117     [property] boolean SearchSimilarityRelax;
 118
 119     //-------------------------------------------------------------------------
 120     /** This property specifies the number of characters that may be
 121         ignored to match the search pattern.
 122      */
 123     [property] short SearchSimilarityRemove;
 124
 125     //-------------------------------------------------------------------------
 126     /** specifies the number of characters that must be
 127         added to match the search pattern.
 128      */
 129     [property] short SearchSimilarityAdd;
 130
 131     //-------------------------------------------------------------------------
 132     /** This property specifies the number of characters that must
 133         be replaced to match the search pattern.
 134      */
 135     [property] short SearchSimilarityExchange;
 136
 137 };
 138
 139 //=============================================================================
 140
 141 }; }; }; };
 142
 143 #endif