offapi/com/sun/star/ucb/RuleTerm.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  * 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 ucb {
  23
  24 /** describes a term.
  25
  26     <p>A term is used to select objects to which a rule should apply.
  27 */
  28 published struct RuleTerm
  29 {
  30     /** the name of the property used to match the term.
  31     */
  32     string Property;
  33
  34     /** the value of the property used to compare with the document
  35         property.
  36     */
  37     any Operand;
  38
  39     /** the operator used to compare the property of the document with
  40         the given value (e.g. "contains" or "greater equal").
  41
  42         <p>The value can be one of the RuleOperator constants.
  43     */
  44     short Operator;
  45
  46     /** this flag indicates whether a string "operand" shall be compared
  47         case sensitive.
  48     */
  49     boolean CaseSensitive;
  50
  51     /** this flag indicates whether a string "operand" shall be treated
  52         as a regular expression.
  53     */
  54     boolean RegularExpression;
  55
  56 };
  57
  58
  59 }; }; }; };
  60
  61 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */