diff options
Diffstat (limited to 'offapi/com/sun/star/util/XReplaceable.idl')
| -rw-r--r-- | offapi/com/sun/star/util/XReplaceable.idl | 141 |
1 files changed, 141 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/XReplaceable.idl b/offapi/com/sun/star/util/XReplaceable.idl new file mode 100644 index 000000000000..6da70154300e --- /dev/null +++ b/offapi/com/sun/star/util/XReplaceable.idl @@ -0,0 +1,141 @@ +/************************************************************************* + * + * $RCSfile: XReplaceable.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_XReplaceable_idl__ +#define __com_sun_star_util_XReplaceable_idl__ + +#ifndef __com_sun_star_util_XSearchable_idl__ +#include <com/sun/star/util/XSearchable.idl> +#endif + +#ifndef __com_sun_star_util_XReplaceDescriptor_idl__ +#include <com/sun/star/util/XReplaceDescriptor.idl> +#endif + +#ifndef __com_sun_star_util_XSearchDescriptor_idl__ +#include <com/sun/star/util/XSearchDescriptor.idl> +#endif + + +//============================================================================= + + module com { module sun { module star { module util { + +//============================================================================= + +// DocMerge from xml: interface com::sun::star::util::XReplaceable +/** makes it possible to replace strings in a text described by a + <type>SearchDescriptor</type>. + + + + + + + + + + @example <listing> + 'replace all bold words "search for" by "look for" + xReplaceDescr = xDocument.createReplaceDescriptor() + xReplaceDescr.SearchString = "search for" + xReplaceDescr.ReplaceString = "look for" + xFound = xDocument.replaceAll( xReplaceDescr ) + </listing> + */ +[ uik(E2280414-33D6-11D1-AABE00A0-249D5590), ident( "XReplaceable", 1.0 ) ] +interface XReplaceable: com::sun::star::util::XSearchable +{ + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::util::XReplaceable::createReplaceDescriptor + /** creates a descriptor which contains properties that + specify a search in this container.@see service SearchDescriptor + */ + com::sun::star::util::XReplaceDescriptor createReplaceDescriptor(); + + //------------------------------------------------------------------------- + + // DocMerge from xml: method com::sun::star::util::XReplaceable::replaceAll + /** searches for all occurrences of whatever is specified.@see service SearchDescriptor + */ + long replaceAll( [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 |