xref: /trunk/main/offapi/com/sun/star/ucb/OpenMode.idl (revision cdf0e10c4e3984b49a9502b011690b615761d4a3)

/*************************************************************************
 *
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * Copyright 2000, 2010 Oracle and/or its affiliates.
 *
 * OpenOffice.org - a multi-platform office productivity suite
 *
 * This file is part of OpenOffice.org.
 *
 * OpenOffice.org is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License version 3
 * only, as published by the Free Software Foundation.
 *
 * OpenOffice.org 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 version 3 for more details
 * (a copy is included in the LICENSE file that accompanied this code).
 *
 * You should have received a copy of the GNU Lesser General Public License
 * version 3 along with OpenOffice.org.  If not, see
 * <http://www.openoffice.org/license.html>
 * for a copy of the LGPLv3 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