xref: /aoo41x/main/offapi/com/sun/star/ucb/RuleAction.idl (revision cdf0e10c)
1/*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2000, 2010 Oracle and/or its affiliates.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * This file is part of OpenOffice.org.
10 *
11 * OpenOffice.org is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU Lesser General Public License version 3
13 * only, as published by the Free Software Foundation.
14 *
15 * OpenOffice.org is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 * GNU Lesser General Public License version 3 for more details
19 * (a copy is included in the LICENSE file that accompanied this code).
20 *
21 * You should have received a copy of the GNU Lesser General Public License
22 * version 3 along with OpenOffice.org.  If not, see
23 * <http://www.openoffice.org/license.html>
24 * for a copy of the LGPLv3 License.
25 *
26 ************************************************************************/
27#ifndef __com_sun_star_ucb_RuleAction_idl__
28#define __com_sun_star_ucb_RuleAction_idl__
29
30
31//=============================================================================
32
33module com { module sun { module star { module ucb {
34
35//=============================================================================
36/**  These are the possible values for <member>Rule::Action</member>.
37
38	 @see RuleSet
39*/
40published constants RuleAction
41{
42	//-------------------------------------------------------------------------
43	/** "None" - Do nothing.
44	*/
45	const short NONE = 0;
46
47	//-------------------------------------------------------------------------
48	/** "Show" - Shows object when term matches.
49	*/
50	const short SHOW = 1;
51
52	//-------------------------------------------------------------------------
53	/** "Hide" - Hides object when term matches.
54	*/
55	const short HIDE = 2;
56
57	//-------------------------------------------------------------------------
58	/** "Mark" - Marks object when term matches.
59	*/
60	const short MARK = 3;
61
62	//-------------------------------------------------------------------------
63	/** "UnMark" - Removes mark from object when term matches.
64	*/
65	const short UNMARK = 4;
66
67	//-------------------------------------------------------------------------
68	/** "MarkRead" - Marks object as read when term matches.
69	*/
70	const short MARKREAD = 5;
71
72	//-------------------------------------------------------------------------
73	/** "MarkUnRead" - Marks object as not read when term matches.
74	*/
75	const short MARKUNREAD = 6;
76
77	//-------------------------------------------------------------------------
78	/** "Move" - Moves object to <member>Rule::Parameter</member> when term
79	    matches.
80	*/
81	const short MOVE = 7;
82
83	//-------------------------------------------------------------------------
84	/** "Copy" - Copies object to <member>Rule::Parameter</member> when term
85	    matches.
86	*/
87	const short COPY = 8;
88
89	//-------------------------------------------------------------------------
90	/** "Delete" - Deletes object when term matches.
91	*/
92	const short DELETE = 9;
93
94	//-------------------------------------------------------------------------
95	/** "Link" - Creates a link to <member>Rule::Parameter</member> when term
96	    matches.
97	*/
98	const short LINK = 10;
99
100	//-------------------------------------------------------------------------
101	/** "Forward" - Forwards object to <member>Rule::Parameter</member> when
102	    term matches.
103	*/
104	const short FORWARD = 11;
105
106};
107
108//=============================================================================
109
110}; }; }; };
111
112#endif
113