xref: /AOO41X/main/offapi/com/sun/star/ucb/RuleAction.idl (revision d1766043198e81d0bcfc626e12893e7b4d7e31ca)
1/**************************************************************
2 *
3 * Licensed to the Apache Software Foundation (ASF) under one
4 * or more contributor license agreements.  See the NOTICE file
5 * distributed with this work for additional information
6 * regarding copyright ownership.  The ASF licenses this file
7 * to you under the Apache License, Version 2.0 (the
8 * "License"); you may not use this file except in compliance
9 * with the License.  You may obtain a copy of the License at
10 *
11 *   http://www.apache.org/licenses/LICENSE-2.0
12 *
13 * Unless required by applicable law or agreed to in writing,
14 * software distributed under the License is distributed on an
15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 * KIND, either express or implied.  See the License for the
17 * specific language governing permissions and limitations
18 * under the License.
19 *
20 *************************************************************/
21
22
23#ifndef __com_sun_star_ucb_RuleAction_idl__
24#define __com_sun_star_ucb_RuleAction_idl__
25
26
27//=============================================================================
28
29module com { module sun { module star { module ucb {
30
31//=============================================================================
32/**  These are the possible values for <member>Rule::Action</member>.
33
34     @see RuleSet
35*/
36published constants RuleAction
37{
38    //-------------------------------------------------------------------------
39    /** "None" - Do nothing.
40    */
41    const short NONE = 0;
42
43    //-------------------------------------------------------------------------
44    /** "Show" - Shows object when term matches.
45    */
46    const short SHOW = 1;
47
48    //-------------------------------------------------------------------------
49    /** "Hide" - Hides object when term matches.
50    */
51    const short HIDE = 2;
52
53    //-------------------------------------------------------------------------
54    /** "Mark" - Marks object when term matches.
55    */
56    const short MARK = 3;
57
58    //-------------------------------------------------------------------------
59    /** "UnMark" - Removes mark from object when term matches.
60    */
61    const short UNMARK = 4;
62
63    //-------------------------------------------------------------------------
64    /** "MarkRead" - Marks object as read when term matches.
65    */
66    const short MARKREAD = 5;
67
68    //-------------------------------------------------------------------------
69    /** "MarkUnRead" - Marks object as not read when term matches.
70    */
71    const short MARKUNREAD = 6;
72
73    //-------------------------------------------------------------------------
74    /** "Move" - Moves object to <member>Rule::Parameter</member> when term
75        matches.
76    */
77    const short MOVE = 7;
78
79    //-------------------------------------------------------------------------
80    /** "Copy" - Copies object to <member>Rule::Parameter</member> when term
81        matches.
82    */
83    const short COPY = 8;
84
85    //-------------------------------------------------------------------------
86    /** "Delete" - Deletes object when term matches.
87    */
88    const short DELETE = 9;
89
90    //-------------------------------------------------------------------------
91    /** "Link" - Creates a link to <member>Rule::Parameter</member> when term
92        matches.
93    */
94    const short LINK = 10;
95
96    //-------------------------------------------------------------------------
97    /** "Forward" - Forwards object to <member>Rule::Parameter</member> when
98        term matches.
99    */
100    const short FORWARD = 11;
101
102};
103
104//=============================================================================
105
106}; }; }; };
107
108#endif
109