1*d1766043SAndrew Rist/************************************************************** 2cdf0e10cSrcweir * 3*d1766043SAndrew Rist * Licensed to the Apache Software Foundation (ASF) under one 4*d1766043SAndrew Rist * or more contributor license agreements. See the NOTICE file 5*d1766043SAndrew Rist * distributed with this work for additional information 6*d1766043SAndrew Rist * regarding copyright ownership. The ASF licenses this file 7*d1766043SAndrew Rist * to you under the Apache License, Version 2.0 (the 8*d1766043SAndrew Rist * "License"); you may not use this file except in compliance 9*d1766043SAndrew Rist * with the License. You may obtain a copy of the License at 10*d1766043SAndrew Rist * 11*d1766043SAndrew Rist * http://www.apache.org/licenses/LICENSE-2.0 12*d1766043SAndrew Rist * 13*d1766043SAndrew Rist * Unless required by applicable law or agreed to in writing, 14*d1766043SAndrew Rist * software distributed under the License is distributed on an 15*d1766043SAndrew Rist * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16*d1766043SAndrew Rist * KIND, either express or implied. See the License for the 17*d1766043SAndrew Rist * specific language governing permissions and limitations 18*d1766043SAndrew Rist * under the License. 19*d1766043SAndrew Rist * 20*d1766043SAndrew Rist *************************************************************/ 21*d1766043SAndrew Rist 22*d1766043SAndrew Rist 23cdf0e10cSrcweir#ifndef __com_sun_star_util_XSearchable_idl__ 24cdf0e10cSrcweir#define __com_sun_star_util_XSearchable_idl__ 25cdf0e10cSrcweir 26cdf0e10cSrcweir#ifndef __com_sun_star_uno_XInterface_idl__ 27cdf0e10cSrcweir#include <com/sun/star/uno/XInterface.idl> 28cdf0e10cSrcweir#endif 29cdf0e10cSrcweir 30cdf0e10cSrcweir#ifndef __com_sun_star_util_XSearchDescriptor_idl__ 31cdf0e10cSrcweir#include <com/sun/star/util/XSearchDescriptor.idl> 32cdf0e10cSrcweir#endif 33cdf0e10cSrcweir 34cdf0e10cSrcweir#ifndef __com_sun_star_container_XIndexAccess_idl__ 35cdf0e10cSrcweir#include <com/sun/star/container/XIndexAccess.idl> 36cdf0e10cSrcweir#endif 37cdf0e10cSrcweir 38cdf0e10cSrcweir 39cdf0e10cSrcweir//============================================================================= 40cdf0e10cSrcweir 41cdf0e10cSrcweirmodule com { module sun { module star { module util { 42cdf0e10cSrcweir 43cdf0e10cSrcweir//============================================================================= 44cdf0e10cSrcweir 45cdf0e10cSrcweir/** enables the object to look for specified contents of the object 46cdf0e10cSrcweir (in particular, for a text range which contains a specific string pattern). 47cdf0e10cSrcweir 48cdf0e10cSrcweir @example 49cdf0e10cSrcweir in a <type scope="com::sun::star::text">TextDocument</type>: 50cdf0e10cSrcweir set all "search for" to bold using findFirst()/findNext(): 51cdf0e10cSrcweir 52cdf0e10cSrcweir <listing> 53cdf0e10cSrcweir xSearchDescr = xDocument.createSearchDescriptor() 54cdf0e10cSrcweir xSearchDescr.SearchString = "search for" 55cdf0e10cSrcweir xSearchDescr.SearchCaseSensitive = <TRUE/> 56cdf0e10cSrcweir xSearchDescr.SearchWords = <TRUE/> 57cdf0e10cSrcweir xFound = xDocument.findFirst( xSearchDescr ) 58cdf0e10cSrcweir do while not IsNull(xFound) 59cdf0e10cSrcweir xFound.CharWeight = com.sun.star.awt.FontWeight.BOLD 60cdf0e10cSrcweir xFound = xDocument.findNext( xFound.End, xSearchDescr ) 61cdf0e10cSrcweir loop 62cdf0e10cSrcweir </listing> 63cdf0e10cSrcweir 64cdf0e10cSrcweir */ 65cdf0e10cSrcweirpublished interface XSearchable: com::sun::star::uno::XInterface 66cdf0e10cSrcweir{ 67cdf0e10cSrcweir //------------------------------------------------------------------------- 68cdf0e10cSrcweir /** creates a <type>SearchDescriptor</type> which contains properties that 69cdf0e10cSrcweir specify a search in this container.@see SearchDescriptor 70cdf0e10cSrcweir */ 71cdf0e10cSrcweir com::sun::star::util::XSearchDescriptor createSearchDescriptor(); 72cdf0e10cSrcweir 73cdf0e10cSrcweir //------------------------------------------------------------------------- 74cdf0e10cSrcweir /** searches the contained texts for all occurrences of whatever is specified.@see SearchDescriptor 75cdf0e10cSrcweir */ 76cdf0e10cSrcweir com::sun::star::container::XIndexAccess findAll( [in] com::sun::star::util::XSearchDescriptor xDesc ); 77cdf0e10cSrcweir 78cdf0e10cSrcweir //------------------------------------------------------------------------- 79cdf0e10cSrcweir /** searches the contained texts for the next occurrence of whatever is specified. 80cdf0e10cSrcweir 81cdf0e10cSrcweir @returns 82cdf0e10cSrcweir the position within the component, e.g. a <type scope="com::sun::star::text">XTextRange</type> 83cdf0e10cSrcweir which determines the found elements. 84cdf0e10cSrcweir 85cdf0e10cSrcweir @see SearchDescriptor 86cdf0e10cSrcweir */ 87cdf0e10cSrcweir com::sun::star::uno::XInterface findFirst( [in] com::sun::star::util::XSearchDescriptor xDesc ); 88cdf0e10cSrcweir 89cdf0e10cSrcweir //------------------------------------------------------------------------- 90cdf0e10cSrcweir /** searches the contained texts for the next occurrence of whatever is specified. 91cdf0e10cSrcweir 92cdf0e10cSrcweir @param xStartAt 93cdf0e10cSrcweir represents a position within the component at which the search continues. 94cdf0e10cSrcweir This position is returned by <method>XSearchable::findFirst</method> or 95cdf0e10cSrcweir the previous <method>XSearchable::findNext</method>. 96cdf0e10cSrcweir 97cdf0e10cSrcweir @see SearchDescriptor 98cdf0e10cSrcweir */ 99cdf0e10cSrcweir com::sun::star::uno::XInterface findNext( [in] com::sun::star::uno::XInterface xStartAt, 100cdf0e10cSrcweir [in] com::sun::star::util::XSearchDescriptor xDesc ); 101cdf0e10cSrcweir 102cdf0e10cSrcweir}; 103cdf0e10cSrcweir 104cdf0e10cSrcweir//============================================================================= 105cdf0e10cSrcweir 106cdf0e10cSrcweir}; }; }; }; 107cdf0e10cSrcweir 108cdf0e10cSrcweir#endif 109