xref: /aoo42x/main/offapi/com/sun/star/util/XReplaceable.idl (revision cdf0e10c)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 License.
 *
 ************************************************************************/
#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 {

//=============================================================================

/** 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>
 */
published interface XReplaceable: com::sun::star::util::XSearchable
{
	//-------------------------------------------------------------------------
	/** creates a descriptor which contains properties that
		specify a search in this container.@see SearchDescriptor
	 */
	com::sun::star::util::XReplaceDescriptor createReplaceDescriptor();

	//-------------------------------------------------------------------------
	/** searches for all occurrences of whatever is specified.@see SearchDescriptor
	 */
	long replaceAll( [in] com::sun::star::util::XSearchDescriptor xDesc );

};

//=============================================================================

}; }; }; };

#endif