LibreOffice
LibreOffice 24.2 SDK API Reference
Variables
com::sun::star::ucb::OpenMode Constant Group Referencepublished

These are the possible values for OpenCommandArgument::Mode. More...

Variables

const short ALL = 0
 open a folder, include all children in result set (documents and folders). More...
 
const short FOLDERS = 1
 open a folder, include only children, that are folders, in result set. More...
 
const short DOCUMENTS = 3
 open a folder, include only children, that are documents, in result set. More...
 
const short DOCUMENT = 2
 open a document. More...
 
const short DOCUMENT_SHARE_DENY_NONE = 4
 open a document. More...
 
const short DOCUMENT_SHARE_DENY_WRITE = 5
 open a document. More...
 

Detailed Description

These are the possible values for OpenCommandArgument::Mode.

Variable Documentation

◆ ALL

const short ALL = 0

open a folder, include all children in result set (documents and folders).

◆ DOCUMENT

const short DOCUMENT = 2

open a document.

There are no special requirements for data access sharing.

Note: There must be a data sink supplied in the OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data.

◆ DOCUMENT_SHARE_DENY_NONE

const short DOCUMENT_SHARE_DENY_NONE = 4

open a document.

Allow shared read and write access.

Note: There must be a data sink supplied in the OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data.

◆ DOCUMENT_SHARE_DENY_WRITE

const short DOCUMENT_SHARE_DENY_WRITE = 5

open a document.

Deny shared write access.

Note: There must be a data sink supplied in the OpenCommandArgument struct, if this value is set. This sink will be used by the content implementation to supply the document data.

◆ DOCUMENTS

const short DOCUMENTS = 3

open a folder, include only children, that are documents, in result set.

◆ FOLDERS

const short FOLDERS = 1

open a folder, include only children, that are folders, in result set.