offapi/com/sun/star/ucb/RuleTerm.idl

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_ucb_RuleTerm_idl__
  28 #define __com_sun_star_ucb_RuleTerm_idl__
  29
  30
  31 //=============================================================================
  32
  33 module com { module sun { module star { module ucb {
  34
  35 //=============================================================================
  36 /** describes a term.
  37
  38     <p>A term is used to select objects to which a rule should apply.
  39 */
  40 published struct RuleTerm
  41 {
  42     //-------------------------------------------------------------------------
  43     /** the name of the property used to match the term.
  44     */
  45     string Property;
  46
  47     //-------------------------------------------------------------------------
  48     /** the value of the property used to compare with the document
  49         property.
  50     */
  51     any Operand;
  52
  53     //-------------------------------------------------------------------------
  54     /** the operator used to compare the property of the document with
  55         the given value (e.g. "contains" or "greater equal").
  56
  57         <p>The value can be one of the <type>RuleOperator</type> constants.
  58     */
  59     short Operator;
  60
  61     //-------------------------------------------------------------------------
  62     /** this flag indicates whether a string "operand" shall be compared
  63         case sensitive.
  64     */
  65     boolean CaseSensitive;
  66
  67     //-------------------------------------------------------------------------
  68     /** this flag indicates whether a string "operand" shall be treated
  69         as a regular expression.
  70     */
  71     boolean RegularExpression;
  72
  73 };
  74
  75 //=============================================================================
  76
  77 }; }; }; };
  78
  79 #endif