offapi/com/sun/star/util/SearchOptions2.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
  10
  11
  12
  13 module com { module sun { module star { module util {
  14
  15 /** This augments com::sun::star::util::SearchOptions to be able to
  16     specify additional search algorithms for use with
  17     com::sun::star::util::XTextSearch2
  18
  19     @since LibreOffice 5.2
  20  */
  21 struct SearchOptions2 : com::sun::star::util::SearchOptions {
  22
  23     /** Search type, one of com::sun::star::util::SearchAlgorithms2
  24         constants. This is preferred over the content of the
  25         SearchAlgorithms SearchOptions::algorithmType enum field.
  26      */
  27     short   AlgorithmType2;
  28
  29     /** The escape character to be used with a
  30         com::sun::star::util::SearchAlgorithms2::WILDCARD search.
  31
  32         <p> A Unicode character, if not 0 escapes the special meaning of
  33         a question mark, asterisk or escape character that follows
  34         immediately after the escape character. If 0 defines no escape
  35         character is used. </p>
  36
  37         <p> Common values are '\' (U+005C REVERSE SOLIDUS) aka backslash
  38         in text processing context, or '~' (U+007E TILDE) in spreadsheet
  39         processing context. </p>
  40      */
  41     long    WildcardEscapeCharacter;
  42 };
  43
  44 }; }; }; };
  45
  46 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */