summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/ucb/RuleTerm.idl
blob: 49b2a51dfabc077585a9ba1e9bbfd3abfc049f5a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
/*
 * This file is part of the LibreOffice project.
 *
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
 *
 * This file incorporates work covered by the following license notice:
 *
 *   Licensed to the Apache Software Foundation (ASF) under one or more
 *   contributor license agreements. See the NOTICE file distributed
 *   with this work for additional information regarding copyright
 *   ownership. The ASF licenses this file to you under the Apache
 *   License, Version 2.0 (the "License"); you may not use this file
 *   except in compliance with the License. You may obtain a copy of
 *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
 */
#ifndef __com_sun_star_ucb_RuleTerm_idl__
#define __com_sun_star_ucb_RuleTerm_idl__



module com { module sun { module star { module ucb {

/** describes a term.

    <p>A term is used to select objects to which a rule should apply.
*/
published struct RuleTerm
{
    /** the name of the property used to match the term.
    */
    string Property;

    /** the value of the property used to compare with the document
        property.
    */
    any Operand;

    /** the operator used to compare the property of the document with
        the given value (e.g. "contains" or "greater equal").

        <p>The value can be one of the RuleOperator constants.
    */
    short Operator;

    /** this flag indicates whether a string "operand" shall be compared
        case sensitive.
    */
    boolean CaseSensitive;

    /** this flag indicates whether a string "operand" shall be treated
        as a regular expression.
    */
    boolean RegularExpression;

};


}; }; }; };

#endif

/* vim:set shiftwidth=4 softtabstop=4 expandtab: */