LibreOffice
LibreOffice 24.2 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 
20 
21 
22 module com { module sun { module star { module util {
23 
24 
27 published service SearchDescriptor
28 {
30 
32 
35  [property] boolean SearchBackwards;
36 
39  [property] boolean SearchCaseSensitive;
40 
43  [property] boolean SearchWords;
44 
50  [property] boolean SearchRegularExpression;
51 
55  [property] boolean SearchStyles;
56 
76  [property] boolean SearchSimilarity;
77 
93  [property] boolean SearchSimilarityRelax;
94 
98  [property] short SearchSimilarityRemove;
99 
103  [property] short SearchSimilarityAdd;
104 
108  [property] short SearchSimilarityExchange;
109 
124  [optional, property] boolean SearchWildcard;
125 
130  [optional, property] long WildcardEscapeCharacter;
131 
132 };
133 
134 
135 }; }; }; };
136 
137 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
boolean SearchCaseSensitive
If TRUE, the case of the letters is important for the match.
Definition: SearchDescriptor.idl:39
boolean SearchSimilarityRelax
If TRUE, all similarity rules are applied together.
Definition: SearchDescriptor.idl:93
boolean SearchStyles
If TRUE, it is searched for positions where the paragraph style with the name of the search pattern i...
Definition: SearchDescriptor.idl:55
Definition: Ambiguous.idl:20
specifies a string search operation.
Definition: XSearchDescriptor.idl:27
boolean SearchRegularExpression
If TRUE, the search string is evaluated as a regular expression.
Definition: SearchDescriptor.idl:50
boolean SearchWildcard
If TRUE, the search string is evaluated as a wildcard pattern.
Definition: SearchDescriptor.idl:124
short SearchSimilarityAdd
specifies the number of characters that must be added to match the search pattern.
Definition: SearchDescriptor.idl:103
boolean SearchSimilarity
If TRUE, a "similarity search" is performed.
Definition: SearchDescriptor.idl:76
describes what and how to search within a container.
Definition: SearchDescriptor.idl:27
short SearchSimilarityExchange
This property specifies the number of characters that must be replaced to match the search pattern...
Definition: SearchDescriptor.idl:108
boolean SearchBackwards
If TRUE, the search is done backwards in the document.
Definition: SearchDescriptor.idl:31
provides information about and access to the properties from an implementation.
Definition: XPropertySet.idl:45
long WildcardEscapeCharacter
Specifies the character used to escape special characters in wildcards.
Definition: SearchDescriptor.idl:130
boolean SearchWords
If TRUE, only complete words will be found.
Definition: SearchDescriptor.idl:43
short SearchSimilarityRemove
This property specifies the number of characters that may be ignored to match the search pattern...
Definition: SearchDescriptor.idl:98