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

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