summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/util/SearchFlags.idl
blob: 77d0da38b405600ad5f7289e38b3e2ef10c5c49e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
/* -*- 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_SearchFlags_idl__
#define __com_sun_star_util_SearchFlags_idl__



module com { module sun { module star { module util {


/// Flags for search methods
published constants SearchFlags
{
    /**
        @deprecated The constant ALL_IGNORE_CASE is never supported - use
                    com::sun::star::i18n::TransliterationModules::IGNORE_CASE
                    with
                    SearchOptions::transliterateFlags()
                    instead.

        @see com::sun::star::i18n::TransliterationModules
    */
    const long  ALL_IGNORE_CASE     = 0x00000001;

    /** Flag for normal (Boyer-Moore) search / Search for word only. */
    const long  NORM_WORD_ONLY      = 0x00000010;

    /** Flag for "regular expression" search / Interpret as extended
        regular expression.

        @deprecated The flag is currently not supported by OOo.
    */
    const long  REG_EXTENDED        = 0x00000100;

    /** Flag for "regular expression" search / No register information
        or backreferences, i.e., avoid sub expressions. Return only
        true/false if matched or not.

        @deprecated The flag is currently not supported by OOo.
    */
    const long  REG_NOSUB           = 0x00000200;

    /** Flag for "regular expression" search / Special new line
        treatment.

        @deprecated The flag is currently not supported by OOo.

        <p> A NEWLINE character in string will not be matched by a
        period outside bracket expression or by any form of a non
        matching list. </p>

        <p> A circumflex (^) in pattern when used to specify expression
        anchoring will match the zero length string immediately after a
        newline in string, regardless of the setting of
        REG_NOT_BEGINOFLINE. </p>

        <p> A dollar-sign ($) in pattern when used to specify expression
        anchoring, will match zero-length string immediately before a
        new line in string, regardless of the setting of
        REG_NOT_ENDOFLINE. </p>
    */
    const long  REG_NEWLINE         = 0x00000400;

    /** The first character in the string is not the beginning of the
        line therefore ^ will not match with first character of the
        string.
    */
    const long  REG_NOT_BEGINOFLINE = 0x00000800;

    /** The last character in the string is not the end of the line
        therefore $ will not match with last character of the string.
    */
    const long  REG_NOT_ENDOFLINE   = 0x00001000;

    /** Flag for "Weighted Levenshtein Distance" search / Relaxed
        checking of limit, split weigh pools.

        <p> If not specified (<b>strict</b>), the search is successful if
        the WLD is within a calculated limit where each insertion,
        deletion and replacement adds a weight to a common pool of
        weights. This is the mathematically correct WLD. </p>

        <p> From a user's point of view the strict WLD is an
        exclusive-OR of the arguments given, for example if allowed
        insertions=2 and allowed replacements=2, the search fails if 2
        characters had been inserted and an additional operation would
        be needed to match. Depending on the weights it may also fail if
        1 character was inserted and 1 character replaced and an
        additional operation would be needed to match. The strict
        algorithm may match less than expected from a first glance of
        the specified arguments, but does not return false positives. </p>

        <p> If specified (<b>relaxed</b>), the search is also successful
        if the combined pool for insertions and deletions is below a
        doubled calculated limit and replacements are treated
        differently. Additionally, swapped characters are counted as one
        replacement. </p>

        <p> From a user's point of view the relaxed WLD is an
        inclusive-OR of the arguments given, for example if allowed
        insertions=2 and allowed replacements=2, the search succeeds if
        2 characters had been inserted and an additional replacement is
        needed to match. The relaxed algorithm may return false
        positives, but meets user expectation better. </p>
    */
    const long  LEV_RELAXED     = 0x00010000;

    /** Flag for wildcards search if entire selection must match the
        pattern.

        <p> If com::sun::star::util::SearchOptions2::AlgorithmType2 is
        com::sun::star::util::SearchAlgorithms2::WILDCARD specifies
        whether a wildcard pattern must match the entire selected range
        of the string from start position to end position or a substring
        match is allowed. </p>

        <p> If set, the entire selection must match. If not set, a
        substring match is allowed. </p>

        @since LibreOffice 5.2
     */
    const long  WILD_MATCH_SELECTION = 0x00100000;
};

}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */