summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/util/XReplaceable.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/util/XReplaceable.idl')
-rw-r--r--offapi/com/sun/star/util/XReplaceable.idl63
1 files changed, 63 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 000000000..4a3d00841
--- /dev/null
+++ b/offapi/com/sun/star/util/XReplaceable.idl
@@ -0,0 +1,63 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (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.apache.org/licenses/LICENSE-2.0 .
+ */
+#ifndef __com_sun_star_util_XReplaceable_idl__
+#define __com_sun_star_util_XReplaceable_idl__
+
+#include <com/sun/star/util/XSearchable.idl>
+
+#include <com/sun/star/util/XReplaceDescriptor.idl>
+
+#include <com/sun/star/util/XSearchDescriptor.idl>
+
+
+
+module com { module sun { module star { module util {
+
+
+/** makes it possible to replace strings in a text described by a
+ SearchDescriptor.
+
+ Example: replace all bold words "search for" by "look for"
+
+ @code{.py}
+ xReplaceDescr = xDocument.createReplaceDescriptor()
+ xReplaceDescr.SearchString = "search for"
+ xReplaceDescr.ReplaceString = "look for"
+ xFound = xDocument.replaceAll( xReplaceDescr )
+ @endcode
+ */
+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
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */