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