diff options
author | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
---|---|---|
committer | Michael Hönnig <mi@openoffice.org> | 2002-10-03 12:11:20 +0000 |
commit | cb23f6a62077022736a40d6315ee92a218f489e0 (patch) | |
tree | 713895d0de4930fd1a37b2fb7bb6ded971a2acdf /offapi/com/sun/star/util/XSearchable.idl | |
parent | 625aff4ec7a47d618a9da160e962fc6fb5c834c5 (diff) |
#94968# IDL reviews merged
Diffstat (limited to 'offapi/com/sun/star/util/XSearchable.idl')
-rw-r--r-- | offapi/com/sun/star/util/XSearchable.idl | 65 |
1 files changed, 21 insertions, 44 deletions
diff --git a/offapi/com/sun/star/util/XSearchable.idl b/offapi/com/sun/star/util/XSearchable.idl index 587581956fb7..ee772e688e9c 100644 --- a/offapi/com/sun/star/util/XSearchable.idl +++ b/offapi/com/sun/star/util/XSearchable.idl @@ -2,9 +2,9 @@ * * $RCSfile: XSearchable.idl,v $ * - * $Revision: 1.7 $ + * $Revision: 1.8 $ * - * last change: $Author: mi $ $Date: 2001-11-15 17:18:28 $ + * last change: $Author: mi $ $Date: 2002-10-03 13:10:59 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -76,18 +76,16 @@ //============================================================================= - module com { module sun { module star { module util { +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). +/** 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(): + @example + in a <type scope="com::sun::star::text">TextDocument</type>: + set all "search for" to bold using findFirst()/findNext(): <listing> xSearchDescr = xDocument.createSearchDescriptor() @@ -119,31 +117,36 @@ 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 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 SearchDescriptor */ com::sun::star::container::XIndexAccess findAll( [in] com::sun::star::util::XSearchDescriptor xDesc ); //------------------------------------------------------------------------- + /** searches the contained texts for the next occurrence of whatever is specified. + + @returns + the position within the component, e.g. a <type scope="com::sun::star::text>XTextRange</type> + which determines the found elements. - // DocMerge from xml: method com::sun::star::util::XSearchable::findFirst - /** searches the contained texts for the next occurrence of whatever is specified.@see SearchDescriptor + @see SearchDescriptor */ com::sun::star::uno::XInterface findFirst( [in] com::sun::star::util::XSearchDescriptor xDesc ); //------------------------------------------------------------------------- + /** searches the contained texts for the next occurrence of whatever is specified. - // DocMerge from xml: method com::sun::star::util::XSearchable::findNext - /** searches the contained texts for the next occurrence of whatever is specified.@see SearchDescriptor + @param xStartAt + represents a position within the component at which the search continues. + This position is returned by <method>XSearchable::findFirst</method> or + the previous <method>XSearchable::findNext</method>. + + @see SearchDescriptor */ com::sun::star::uno::XInterface findNext( [in] com::sun::star::uno::XInterface xStartAt, [in] com::sun::star::util::XSearchDescriptor xDesc ); @@ -154,30 +157,4 @@ interface XSearchable: com::sun::star::uno::XInterface }; }; }; }; -/*============================================================================= - - $Log: not supported by cvs2svn $ - Revision 1.6 2001/03/16 16:41:51 jsc - remove interfaceheader with uik and remove [const] in method definitions - - Revision 1.5 2000/12/21 08:35:27 mi - @see interface/service/... ident -> @see ident - for new docu generator - - Revision 1.4 2000/12/14 12:53:46 mi - <true></true> -> <TRUE/> and same with FALSE - - Revision 1.3 2000/11/08 12:45:17 mi - moved from api - - 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 |