diff options
Diffstat (limited to 'offapi/com/sun/star/util/SearchDescriptor.idl')
| -rw-r--r-- | offapi/com/sun/star/util/SearchDescriptor.idl | 215 |
1 files changed, 215 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/SearchDescriptor.idl b/offapi/com/sun/star/util/SearchDescriptor.idl new file mode 100644 index 000000000000..443889f3cd63 --- /dev/null +++ b/offapi/com/sun/star/util/SearchDescriptor.idl @@ -0,0 +1,215 @@ +/************************************************************************* + * + * $RCSfile: SearchDescriptor.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:55 $ + * + * 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 { + +//============================================================================= + +// DocMerge from xml: service com::sun::star::util::SearchDescriptor +/** describes what and how to search within a container. + */ +service SearchDescriptor +{ + // DocMerge: empty anyway + interface com::sun::star::util::XSearchDescriptor; + + // DocMerge: empty anyway + interface com::sun::star::beans::XPropertySet; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchBackwards + /** If <true></true>, the search is done backward in the document. + */ + [property] boolean SearchBackwards; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchCaseSensitive + /** If <true></true>, the case of the letters is important for the match. + */ + [property] boolean SearchCaseSensitive; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchWords + /** If <true></true>, only complete words will be found. + */ + [property] boolean SearchWords; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchRegularExpression + /** If <true></true>, the search string is evaluated as a regular expression. + */ + [property] boolean SearchRegularExpression; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchStyles + /** If <true></true>, it is searched for positions where the paragraph style with + the name of the search pattern is applied. + */ + [property] boolean SearchStyles; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarity + /** If <true></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; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityRelax + /** If <true></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; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityRemove + /** This property specifies the number of characters that may be + ignored to match the search pattern. + */ + [property] short SearchSimilarityRemove; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityAdd + /** specifies the number of characters that must be + added to match the search pattern. + */ + [property] short SearchSimilarityAdd; + + //------------------------------------------------------------------------- + + // DocMerge from xml: property com::sun::star::util::SearchDescriptor::SearchSimilarityExchange + /** This property specifies the number of characters that must + be replaced to match the search pattern. + */ + [property] short SearchSimilarityExchange; + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:36:19 hjs + initial import + + Revision 1.3 2000/09/11 11:53:05 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:46 jsc + new + + +=============================================================================*/ +#endif |