summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/util/SearchResult.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/util/SearchResult.idl')
-rw-r--r--offapi/com/sun/star/util/SearchResult.idl59
1 files changed, 59 insertions, 0 deletions
diff --git a/offapi/com/sun/star/util/SearchResult.idl b/offapi/com/sun/star/util/SearchResult.idl
new file mode 100644
index 000000000..8f14de88b
--- /dev/null
+++ b/offapi/com/sun/star/util/SearchResult.idl
@@ -0,0 +1,59 @@
+/* -*- 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_SearchResult_idl__
+#define __com_sun_star_util_SearchResult_idl__
+
+
+
+module com { module sun { module star { module util {
+
+
+published struct SearchResult {
+
+ /** Number of subexpressions.
+
+ If it is 0, then no match found; this value is 1 for ABSOLUTE
+ and APPROXIMATE match.
+ The start and endOffset are always dependent on the search direction.
+
+ For example, if you search "X" in the text "-X-" the offsets are:
+
+ for forward: start = 1, end = 2
+
+ for backward: start = 2, end = 1
+
+ Forward, the startOffset is inclusive, the endOffset exclusive.
+ Backward, the startOffset is exclusive, the endOffset inclusive.
+
+ For regular expressions it can be greater than 1.
+ If the value is 1, startoffset[0] and endoffset[0] points to the matching sub string
+ if value is > 1, still startoffset[0] and endoffset[0] points to the matching substring for whole regular expression
+ startoffset[i] and endoffset[i] points to the matching substring of i th matching substring.
+ */
+ long subRegExpressions;
+ sequence<long> startOffset;
+ sequence<long> endOffset;
+};
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */