xref: /aoo42x/main/offapi/com/sun/star/ucb/RuleAction.idl (revision d1766043)

/**************************************************************
 *
 * 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
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 *
 *************************************************************/


#ifndef __com_sun_star_ucb_RuleAction_idl__
#define __com_sun_star_ucb_RuleAction_idl__


//=============================================================================

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

//=============================================================================
/**  These are the possible values for <member>Rule::Action</member>.

	 @see RuleSet
*/
published constants RuleAction
{
	//-------------------------------------------------------------------------
	/** "None" - Do nothing.
	*/
	const short NONE = 0;

	//-------------------------------------------------------------------------
	/** "Show" - Shows object when term matches.
	*/
	const short SHOW = 1;

	//-------------------------------------------------------------------------
	/** "Hide" - Hides object when term matches.
	*/
	const short HIDE = 2;

	//-------------------------------------------------------------------------
	/** "Mark" - Marks object when term matches.
	*/
	const short MARK = 3;

	//-------------------------------------------------------------------------
	/** "UnMark" - Removes mark from object when term matches.
	*/
	const short UNMARK = 4;

	//-------------------------------------------------------------------------
	/** "MarkRead" - Marks object as read when term matches.
	*/
	const short MARKREAD = 5;

	//-------------------------------------------------------------------------
	/** "MarkUnRead" - Marks object as not read when term matches.
	*/
	const short MARKUNREAD = 6;

	//-------------------------------------------------------------------------
	/** "Move" - Moves object to <member>Rule::Parameter</member> when term
	    matches.
	*/
	const short MOVE = 7;

	//-------------------------------------------------------------------------
	/** "Copy" - Copies object to <member>Rule::Parameter</member> when term
	    matches.
	*/
	const short COPY = 8;

	//-------------------------------------------------------------------------
	/** "Delete" - Deletes object when term matches.
	*/
	const short DELETE = 9;

	//-------------------------------------------------------------------------
	/** "Link" - Creates a link to <member>Rule::Parameter</member> when term
	    matches.
	*/
	const short LINK = 10;

	//-------------------------------------------------------------------------
	/** "Forward" - Forwards object to <member>Rule::Parameter</member> when
	    term matches.
	*/
	const short FORWARD = 11;

};

//=============================================================================

}; }; }; };

#endif