xref: /aoo4110/main/offapi/com/sun/star/ucb/RuleTerm.idl (revision b1cdbd2c)
1*b1cdbd2cSJim Jagielski/**************************************************************
2*b1cdbd2cSJim Jagielski *
3*b1cdbd2cSJim Jagielski * Licensed to the Apache Software Foundation (ASF) under one
4*b1cdbd2cSJim Jagielski * or more contributor license agreements.  See the NOTICE file
5*b1cdbd2cSJim Jagielski * distributed with this work for additional information
6*b1cdbd2cSJim Jagielski * regarding copyright ownership.  The ASF licenses this file
7*b1cdbd2cSJim Jagielski * to you under the Apache License, Version 2.0 (the
8*b1cdbd2cSJim Jagielski * "License"); you may not use this file except in compliance
9*b1cdbd2cSJim Jagielski * with the License.  You may obtain a copy of the License at
10*b1cdbd2cSJim Jagielski *
11*b1cdbd2cSJim Jagielski *   http://www.apache.org/licenses/LICENSE-2.0
12*b1cdbd2cSJim Jagielski *
13*b1cdbd2cSJim Jagielski * Unless required by applicable law or agreed to in writing,
14*b1cdbd2cSJim Jagielski * software distributed under the License is distributed on an
15*b1cdbd2cSJim Jagielski * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16*b1cdbd2cSJim Jagielski * KIND, either express or implied.  See the License for the
17*b1cdbd2cSJim Jagielski * specific language governing permissions and limitations
18*b1cdbd2cSJim Jagielski * under the License.
19*b1cdbd2cSJim Jagielski *
20*b1cdbd2cSJim Jagielski *************************************************************/
21*b1cdbd2cSJim Jagielski
22*b1cdbd2cSJim Jagielski
23*b1cdbd2cSJim Jagielski#ifndef __com_sun_star_ucb_RuleTerm_idl__
24*b1cdbd2cSJim Jagielski#define __com_sun_star_ucb_RuleTerm_idl__
25*b1cdbd2cSJim Jagielski
26*b1cdbd2cSJim Jagielski
27*b1cdbd2cSJim Jagielski//=============================================================================
28*b1cdbd2cSJim Jagielski
29*b1cdbd2cSJim Jagielskimodule com { module sun { module star { module ucb {
30*b1cdbd2cSJim Jagielski
31*b1cdbd2cSJim Jagielski//=============================================================================
32*b1cdbd2cSJim Jagielski/** describes a term.
33*b1cdbd2cSJim Jagielski
34*b1cdbd2cSJim Jagielski    <p>A term is used to select objects to which a rule should apply.
35*b1cdbd2cSJim Jagielski*/
36*b1cdbd2cSJim Jagielskipublished struct RuleTerm
37*b1cdbd2cSJim Jagielski{
38*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
39*b1cdbd2cSJim Jagielski	/** the name of the property used to match the term.
40*b1cdbd2cSJim Jagielski	*/
41*b1cdbd2cSJim Jagielski	string Property;
42*b1cdbd2cSJim Jagielski
43*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
44*b1cdbd2cSJim Jagielski	/** the value of the property used to compare with the document
45*b1cdbd2cSJim Jagielski		property.
46*b1cdbd2cSJim Jagielski	*/
47*b1cdbd2cSJim Jagielski	any Operand;
48*b1cdbd2cSJim Jagielski
49*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
50*b1cdbd2cSJim Jagielski	/** the operator used to compare the property of the document with
51*b1cdbd2cSJim Jagielski		the given value (e.g. "contains" or "greater equal").
52*b1cdbd2cSJim Jagielski
53*b1cdbd2cSJim Jagielski		<p>The value can be one of the <type>RuleOperator</type> constants.
54*b1cdbd2cSJim Jagielski	*/
55*b1cdbd2cSJim Jagielski	short Operator;
56*b1cdbd2cSJim Jagielski
57*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
58*b1cdbd2cSJim Jagielski	/** this flag indicates whether a string "operand" shall be compared
59*b1cdbd2cSJim Jagielski	    case sensitive.
60*b1cdbd2cSJim Jagielski	*/
61*b1cdbd2cSJim Jagielski	boolean CaseSensitive;
62*b1cdbd2cSJim Jagielski
63*b1cdbd2cSJim Jagielski	//-------------------------------------------------------------------------
64*b1cdbd2cSJim Jagielski	/** this flag indicates whether a string "operand" shall be treated
65*b1cdbd2cSJim Jagielski	    as a regular expression.
66*b1cdbd2cSJim Jagielski	*/
67*b1cdbd2cSJim Jagielski	boolean RegularExpression;
68*b1cdbd2cSJim Jagielski
69*b1cdbd2cSJim Jagielski};
70*b1cdbd2cSJim Jagielski
71*b1cdbd2cSJim Jagielski//=============================================================================
72*b1cdbd2cSJim Jagielski
73*b1cdbd2cSJim Jagielski}; }; }; };
74*b1cdbd2cSJim Jagielski
75*b1cdbd2cSJim Jagielski#endif
76