diff options
author | Michael Hönnig <mi@openoffice.org> | 2000-11-06 08:23:00 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2000-11-06 08:23:00 +0000 |
commit | 88c437c597b604524d50f450506285a594bd03a5 (patch) | |
tree | 3c12c7a1422fc0fc7d6e9b6433b55b91aa3a80a8 /offapi/com/sun/star/util/XSearchable.idl | |
parent | 09ec45ba551bfaa33e4538dc5eb8bbfe6b114fed (diff) |
moved from api
Diffstat (limited to 'offapi/com/sun/star/util/XSearchable.idl')
-rw-r--r-- | offapi/com/sun/star/util/XSearchable.idl | 179 |
1 files changed, 179 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XSearchable.idl b/offapi/com/sun/star/util/XSearchable.idl new file mode 100644 index 000000000000..016669b1968d --- /dev/null +++ b/offapi/com/sun/star/util/XSearchable.idl @@ -0,0 +1,179 @@ +/************************************************************************* + * + * $RCSfile: XSearchable.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_XSearchable_idl__ +#define __com_sun_star_util_XSearchable_idl__ + +#ifndef __com_sun_star_uno_XInterface_idl__ +#include <com/sun/star/uno/XInterface.idl> +#endif + +#ifndef __com_sun_star_util_XSearchDescriptor_idl__ +#include <com/sun/star/util/XSearchDescriptor.idl> +#endif + +#ifndef __com_sun_star_container_XIndexAccess_idl__ +#include <com/sun/star/container/XIndexAccess.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module util { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::util::XSearchable +/** enables the object to look for specified contents + of the object (in particular, for a text range which contains a specific + string pattern). + + + + + + + + + + @example in a <type scope="com::sun::star::text">TextDocument</type>: + set all "search for" to bold using findFirst()/findNext(): + + <listing> + xSearchDescr = xDocument.createSearchDescriptor() + xSearchDescr.SearchString = "to look for" + xSearchDescr.SearchCaseSensitive = <true></true> + xSearchDescr.SearchWholeWords = <true></true> + xFound = xDocument.findFirst( xSearchDescr ) + do while xFound + xFound.CharWeight = CharWeight_BOLD + xFound = xDocument.findNext( xFound.End, xSearchDescr ) + loop + </listing> + + replace all bold "search for" by "look for" using findAll(): + <listing> + xSearchDescr = xDocument.createSearchDescriptor() + xSearchDescr.SearchString = "to look for" + xSearchDescr.SearchCaseSensitive = <true></true> + xSearchDescr.SearchWholeWords = <true></true> + xStyles = createPropertySet( xSearchDescr.SearchStyles ) + xStyles.CharWeight = CharWeight_BOLD + xSearchDescr.SearchStyles = xStyles.PropertyValues + xAllFound = xDocument.findAll( xSearchDescr ) + for n% = lbound(xAllFound) to ubound(xAllFound) + xAllFound(n%).String = "look for" + loop + </listing> + */ +[ uik(E2280412-33D6-11D1-AABE00A0-249D5590), ident( "XSearchable", 1.0 ) ] +interface XSearchable: com::sun::star::uno::XInterface +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::util::XSearchable::createSearchDescriptor + /** creates a <type>SearchDescriptor</type> which contains properties that + specify a search in this container.@see service SearchDescriptor + */ + com::sun::star::util::XSearchDescriptor createSearchDescriptor(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::util::XSearchable::findAll + /** searches the contained texts for all occurrences of whatever is specified.@see service SearchDescriptor + */ + com::sun::star::container::XIndexAccess findAll( [in] com::sun::star::util::XSearchDescriptor xDesc ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::util::XSearchable::findFirst + /** searches the contained texts for the next occurrence of whatever is specified.@see service SearchDescriptor + */ + com::sun::star::uno::XInterface findFirst( [in] com::sun::star::util::XSearchDescriptor xDesc ); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::util::XSearchable::findNext + /** searches the contained texts for the next occurrence of whatever is specified.@see service SearchDescriptor + */ + com::sun::star::uno::XInterface findNext( [in] com::sun::star::uno::XInterface xStartAt, + [in] com::sun::star::util::XSearchDescriptor xDesc ); + +}; + +//============================================================================= + +}; }; }; }; + +/*============================================================================= + + $Log: not supported by cvs2svn $ + Revision 1.1.1.1 2000/09/18 23:36:21 hjs + initial import + + Revision 1.3 2000/09/11 11:53:06 mi + documentation merged from XML + + Revision 1.1.1.1 1999/11/11 09:48:46 jsc + new + + +=============================================================================*/ +#endif |