xref: /aoo41x/main/offapi/com/sun/star/ucb/OpenMode.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_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