/*************************************************************************
 *
 *  $RCSfile: SearchDescriptor.idl,v $
 *
 *  $Revision: 1.6 $
 *
 *  last change: $Author: mi $ $Date: 2002/10/03 13:10:51 $
 *
 *  The Contents of this file are made available subject to the terms of
 *  either of the following licenses
 *
 *         - GNU Lesser General Public License Version 2.1
 *         - Sun Industry Standards Source License Version 1.1
 *
 *  Sun Microsystems Inc., October, 2000
 *
 *  GNU Lesser General Public License Version 2.1
 *  =============================================
 *  Copyright 2000 by Sun Microsystems, Inc.
 *  901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License version 2.1, as published by the Free Software Foundation.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *  MA  02111-1307  USA
 *
 *
 *  Sun Industry Standards Source License Version 1.1
 *  =================================================
 *  The contents of this file are subject to the Sun Industry Standards
 *  Source License Version 1.1 (the "License"); You may not use this file
 *  except in compliance with the License. You may obtain a copy of the
 *  License at http://www.openoffice.org/license.html.
 *
 *  Software provided under this License is provided on an "AS IS" basis,
 *  WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING,
 *  WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS,
 *  MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING.
 *  See the License for the specific provisions governing your rights and
 *  obligations concerning the Software.
 *
 *  The Initial Developer of the Original Code is: Sun Microsystems, Inc.
 *
 *  Copyright: 2000 by Sun Microsystems, Inc.
 *
 *  All Rights Reserved.
 *
 *  Contributor(s): _______________________________________
 *
 *
 ************************************************************************/
#ifndef __com_sun_star_util_SearchDescriptor_idl__ 
#define __com_sun_star_util_SearchDescriptor_idl__ 
 
#ifndef __com_sun_star_util_XSearchDescriptor_idl__ 
#include <com/sun/star/util/XSearchDescriptor.idl> 
#endif 
 
#ifndef __com_sun_star_beans_XPropertySet_idl__ 
#include <com/sun/star/beans/XPropertySet.idl> 
#endif 
 
 
//============================================================================= 
 
module com {  module sun {  module star {  module util {  
 
//============================================================================= 
 
/** describes what and how to search within a container.
 */
service SearchDescriptor
{ 
	interface com::sun::star::util::XSearchDescriptor; 
	
	interface com::sun::star::beans::XPropertySet; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, the search is done backwards in the document.
	 */
	[property] boolean SearchBackwards; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, the case of the letters is important for the match.
	 */
	[property] boolean SearchCaseSensitive; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, only complete words will be found.
	 */
	[property] boolean SearchWords; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, the search string is evaluated as a regular expression.
	 */
	[property] boolean SearchRegularExpression; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, it is searched for positions where the paragraph style with 
		the name of the search pattern is applied.
	 */
	[property] boolean SearchStyles; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, a "similarity search" is performed.
		
		<p>In the case of a similarity search, the following properties
		specify the kind of similarity:
		</p>
		<ul>
		<li>SearchSimilarityRelax
		</li>
		<li>SearchSimilarityRemove
		</li>
		<li>SearchSimilarityAdd
		</li>
		<li>SearchSimilarityExchange
		</li>
		</ul>
	 */
	[property] boolean SearchSimilarity; 
 
	//------------------------------------------------------------------------- 
	/** If <TRUE/>, all similarity rules are applied together.
		
		<p>In the case of a relaxed similarity search, the following
		properties are applied together:
		
		</p>
		<ul>
		<li>SearchSimilarityRemove
		</li>
		<li>SearchSimilarityAdd
		</li>
		<li>SearchSimilarityExchange
		</li>
		</ul>
	 */
	[property] boolean SearchSimilarityRelax; 
 
	//------------------------------------------------------------------------- 
	/** This property specifies the number of characters that may be 
		ignored to match the search pattern.
	 */
	[property] short SearchSimilarityRemove; 
 
	//------------------------------------------------------------------------- 
	/** specifies the number of characters that must be 
		added to match the search pattern.
	 */
	[property] short SearchSimilarityAdd; 
 
	//------------------------------------------------------------------------- 
	/** This property specifies the number of characters that must 
		be replaced to match the search pattern.
	 */
	[property] short SearchSimilarityExchange; 
 
}; 
 
//============================================================================= 
 
}; }; }; };  
 
#endif 
