xref: /AOO41X/main/offapi/com/sun/star/ucb/OpenMode.idl (revision 1ecadb572e7010ff3b3382ad9bf179dbc6efadbb)
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_OpenMode_idl__
28#define __com_sun_star_ucb_OpenMode_idl__
29
30
31//=============================================================================
32
33module com { module sun { module star { module ucb {
34
35//=============================================================================
36/** These are the possible values for <member>OpenCommandArgument::Mode</member>.
37*/
38published constants OpenMode
39{
40	//-------------------------------------------------------------------------
41	/** open a folder, include all children in result set (documents and
42	    folders).
43	*/
44	const short ALL = 0;
45
46	//-------------------------------------------------------------------------
47	/** open a folder, include only children, that are folders, in result set.
48	*/
49	const short FOLDERS = 1;
50
51	//-------------------------------------------------------------------------
52	/** open a folder, include only children, that are documents, in result set.
53	*/
54	const short DOCUMENTS = 3;
55
56	//-------------------------------------------------------------------------
57	/** open a document. There are no special requirements for data access
58	    sharing.
59
60		<p>Note: There must be a data sink supplied in the
61		<type>OpenCommandArgument</type> struct, if this value is set. This
62		sink will be used by the content implementation to supply the document
63		data.
64	*/
65	const short DOCUMENT = 2;
66
67	//-------------------------------------------------------------------------
68	/** open a document. Allow shared read and write access.
69
70		<p>Note: There must be a data sink supplied in the
71		<type>OpenCommandArgument</type> struct, if this value is set. This
72		sink will be used by the content implementation to supply the document
73		data.
74	*/
75	const short DOCUMENT_SHARE_DENY_NONE = 4;
76
77	//-------------------------------------------------------------------------
78	/** open a document. Deny shared write access.
79
80		<p>Note: There must be a data sink supplied in the
81		<type>OpenCommandArgument</type> struct, if this value is set. This
82		sink will be used by the content implementation to supply the document
83		data.
84	*/
85	const short DOCUMENT_SHARE_DENY_WRITE = 5;
86
87//	const short DOCUMENT_SHARE_DENY_READ = 6;
88};
89
90//=============================================================================
91
92}; }; }; };
93
94#endif
95