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