/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: SearchDescriptor.idl,v $
 *
 *  $Revision: 1.8 $
 *
 *  last change: $Author: rt $ $Date: 2005-09-08 08:53:32 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 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
 *
 ************************************************************************/
#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.
 */
published 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
