LibreOffice
LibreOffice 7.2 SDK API Reference
Public Attributes | List of all members
SearchOptions2 Struct Reference

This augments com::sun::star::util::SearchOptions to be able to specify additional search algorithms for use with com::sun::star::util::XTextSearch2. More...

import"SearchOptions2.idl";

Inheritance diagram for SearchOptions2:
SearchOptions

Public Attributes

short AlgorithmType2
 Search type, one of com::sun::star::util::SearchAlgorithms2 constants. More...
 
long WildcardEscapeCharacter
 The escape character to be used with a com::sun::star::util::SearchAlgorithms2::WILDCARD search. More...
 
- Public Attributes inherited from SearchOptions
SearchAlgorithms algorithmType
 search type More...
 
long searchFlag
 some flags - can be mixed More...
 
string searchString
 The text or pattern to be searched. More...
 
string replaceString
 The replacement text (is for optional replacing - SearchOption is only the data container for it) More...
 
::com::sun::star::lang::Locale Locale
 The locale for case insensitive search. More...
 
long changedChars
 This many characters can be different (as a replacement) between the found word and the search pattern in a "Weighted Levenshtein Distance" search. More...
 
long deletedChars
 This many characters can be missing in the found word in a "Weighted Levenshtein Distance" search. More...
 
long insertedChars
 This many characters can be additional in the found word in a "Weighted Levenshtein Distance" search. More...
 
long transliterateFlags
 Flags for the transliteration. More...
 

Detailed Description

This augments com::sun::star::util::SearchOptions to be able to specify additional search algorithms for use with com::sun::star::util::XTextSearch2.

Since
LibreOffice 5.2

Member Data Documentation

◆ AlgorithmType2

short AlgorithmType2

Search type, one of com::sun::star::util::SearchAlgorithms2 constants.

This is preferred over the content of the SearchAlgorithms SearchOptions::algorithmType enum field.

◆ WildcardEscapeCharacter

long WildcardEscapeCharacter

The escape character to be used with a com::sun::star::util::SearchAlgorithms2::WILDCARD search.

A Unicode character, if not 0 escapes the special meaning of a question mark, asterisk or escape character that follows immediately after the escape character. If 0 defines no escape character is used.

Common values are '\' (U+005C REVERSE SOLIDUS) aka backslash in text processing context, or '~' (U+007E TILDE) in spreadsheet processing context.


The documentation for this struct was generated from the following file: