/*************************************************************************
 *
 *  OpenOffice.org - a multi-platform office productivity suite
 *
 *  $RCSfile: OpenMode.idl,v $
 *
 *  $Revision: 1.7 $
 *
 *  last change: $Author: rt $ $Date: 2005/09/08 07:42:13 $
 *
 *  The Contents of this file are made available subject to
 *  the terms of GNU Lesser General Public License Version 2.1.
 *
 *
 *    GNU Lesser General Public License Version 2.1
 *    =============================================
 *    Copyright 2005 by Sun Microsystems, Inc.
 *    901 San Antonio Road, Palo Alto, CA 94303, USA
 *
 *    This library is free software; you can redistribute it and/or
 *    modify it under the terms of the GNU Lesser General Public
 *    License version 2.1, as published by the Free Software Foundation.
 *
 *    This library is distributed in the hope that it will be useful,
 *    but WITHOUT ANY WARRANTY; without even the implied warranty of
 *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *    Lesser General Public License for more details.
 *
 *    You should have received a copy of the GNU Lesser General Public
 *    License along with this library; if not, write to the Free Software
 *    Foundation, Inc., 59 Temple Place, Suite 330, Boston,
 *    MA  02111-1307  USA
 *
 ************************************************************************/
#ifndef __com_sun_star_ucb_OpenMode_idl__
#define __com_sun_star_ucb_OpenMode_idl__


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

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

//=============================================================================
/** These are the possible values for <member>OpenCommandArgument::Mode</member>.
*/
published constants OpenMode
{
	//-------------------------------------------------------------------------
	/** open a folder, include all children in result set (documents and
	    folders).
	*/
	const short ALL = 0;

	//-------------------------------------------------------------------------
	/** open a folder, include only children, that are folders, in result set.
	*/
	const short FOLDERS = 1;

	//-------------------------------------------------------------------------
	/** open a folder, include only children, that are documents, in result set.
	*/
	const short DOCUMENTS = 3;

	//-------------------------------------------------------------------------
	/** open a document. There are no special requirements for data access
	    sharing.

		<p>Note: There must be a data sink supplied in the
		<type>OpenCommandArgument</type> struct, if this value is set. This
		sink will be used by the content implementation to supply the document
		data.
	*/
	const short DOCUMENT = 2;

	//-------------------------------------------------------------------------
	/** open a document. Allow shared read and write access.

		<p>Note: There must be a data sink supplied in the
		<type>OpenCommandArgument</type> struct, if this value is set. This
		sink will be used by the content implementation to supply the document
		data.
	*/
	const short DOCUMENT_SHARE_DENY_NONE = 4;

	//-------------------------------------------------------------------------
	/** open a document. Deny shared write access.

		<p>Note: There must be a data sink supplied in the
		<type>OpenCommandArgument</type> struct, if this value is set. This
		sink will be used by the content implementation to supply the document
		data.
	*/
	const short DOCUMENT_SHARE_DENY_WRITE = 5;

//	const short DOCUMENT_SHARE_DENY_READ = 6;
};

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

}; }; }; };

#endif
