LibreOffice
LibreOffice 7.4 SDK API Reference
SearchDescriptor.idl
Go to the documentation of this file.
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 #ifndef __com_sun_star_util_SearchDescriptor_idl__
20 #define __com_sun_star_util_SearchDescriptor_idl__
21 
23 
25 
26 
27 
28 module com { module sun { module star { module util {
29 
30 
33 published service SearchDescriptor
34 {
36 
38 
41  [property] boolean SearchBackwards;
42 
45  [property] boolean SearchCaseSensitive;
46 
49  [property] boolean SearchWords;
50 
56  [property] boolean SearchRegularExpression;
57 
61  [property] boolean SearchStyles;
62 
82  [property] boolean SearchSimilarity;
83 
99  [property] boolean SearchSimilarityRelax;
100 
104  [property] short SearchSimilarityRemove;
105 
109  [property] short SearchSimilarityAdd;
110 
114  [property] short SearchSimilarityExchange;
115 
130  [optional, property] boolean SearchWildcard;
131 
132 };
133 
134 
135 }; }; }; };
136 
137 #endif
138 
139 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:64
specifies a string search operation.
Definition: XSearchDescriptor.idl:32
Definition: Ambiguous.idl:22
describes what and how to search within a container.
Definition: SearchDescriptor.idl:34
boolean SearchCaseSensitive
If TRUE, the case of the letters is important for the match.
Definition: SearchDescriptor.idl:45
boolean SearchStyles
If TRUE, it is searched for positions where the paragraph style with the name of the search pattern i...
Definition: SearchDescriptor.idl:61
boolean SearchBackwards
If TRUE, the search is done backwards in the document.
Definition: SearchDescriptor.idl:37
boolean SearchSimilarity
If TRUE, a "similarity search" is performed.
Definition: SearchDescriptor.idl:82
boolean SearchWildcard
If TRUE, the search string is evaluated as a wildcard pattern.
Definition: SearchDescriptor.idl:130
short SearchSimilarityRemove
This property specifies the number of characters that may be ignored to match the search pattern.
Definition: SearchDescriptor.idl:104
boolean SearchWords
If TRUE, only complete words will be found.
Definition: SearchDescriptor.idl:49
boolean SearchRegularExpression
If TRUE, the search string is evaluated as a regular expression.
Definition: SearchDescriptor.idl:56
short SearchSimilarityAdd
specifies the number of characters that must be added to match the search pattern.
Definition: SearchDescriptor.idl:109
boolean SearchSimilarityRelax
If TRUE, all similarity rules are applied together.
Definition: SearchDescriptor.idl:99
short SearchSimilarityExchange
This property specifies the number of characters that must be replaced to match the search pattern.
Definition: SearchDescriptor.idl:114