offapi/com/sun/star/util/SearchResult.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19
  20 #ifndef __com_sun_star_util_SearchResult_idl__
  21 #define __com_sun_star_util_SearchResult_idl__
  22
  23
  24
  25 module com { module sun { module star { module util {
  26
  27
  28 published  struct SearchResult  {
  29
  30     /** Number of subexpressions.
  31
  32     If it is 0, then no match found; this value is 1 for ABSOLUTE
  33     and APPROXIMATE match.
  34     The start and endOffset are always dependent on the search direction.
  35
  36     For example, if you search "X" in the text "-X-" the offsets are:
  37
  38         for forward:    start = 1, end = 2
  39
  40         for backward:   start = 2, end = 1
  41
  42     Forward, the startOffset is inclusive, the endOffset exclusive.
  43     Backward, the startOffset is exclusive, the endOffset inclusive.
  44
  45     For regular expressions it can be greater than 1.
  46     If the value is 1, startoffset[0] and endoffset[0] points to the matching sub string
  47     if value is > 1, still startoffset[0] and endoffset[0] points to the matching substring for whole regular expression
  48     startoffset[i] and endoffset[i] points to the matching substring of i th matching substring.
  49     */
  50     long subRegExpressions;
  51     sequence<long> startOffset;
  52     sequence<long> endOffset;
  53 };
  54
  55 }; }; }; };
  56
  57 #endif
  58
  59 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */