summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/embed/ElementModes.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/embed/ElementModes.idl')
-rw-r--r--offapi/com/sun/star/embed/ElementModes.idl99
1 files changed, 99 insertions, 0 deletions
diff --git a/offapi/com/sun/star/embed/ElementModes.idl b/offapi/com/sun/star/embed/ElementModes.idl
new file mode 100644
index 000000000..aaf004c9d
--- /dev/null
+++ b/offapi/com/sun/star/embed/ElementModes.idl
@@ -0,0 +1,99 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * 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 .
+ */
+#ifndef __com_sun_star_embed_ElementModes_idl__
+#define __com_sun_star_embed_ElementModes_idl__
+
+
+
+module com { module sun { module star { module embed {
+
+/** The constant set contains possible modes to open an element.
+
+ <p>
+ The modes can be combined by "or" operation.
+ ElementModes::READ and ElementModes::WRITE
+ are base modes. A result mode must include one of base modes.
+ </p>
+
+ @see XStorage
+*/
+published constants ElementModes
+{
+ /** specifies opening of an element for reading.
+ */
+ const long READ = 1;
+
+ /** specifies opening of a seekable element.
+
+ <p>
+ This mode is ignored for Storage elements.
+ This flag makes sense only in combination with
+ ElementModes::READ and/or
+ ElementModes::WRITE.
+ </p>
+ */
+ const long SEEKABLE = 2;
+
+ /** specifies opening of a seekable element for reading.
+
+ <p>
+ This is just a combination of the previous two values. For storages
+ it is the same as ElementModes::READ.
+ </p>
+ */
+ const long SEEKABLEREAD = 3;
+
+ /** specifies opening of an element for writing.
+ */
+ const long WRITE = 4;
+
+ /** specifies opening of an element for reading and writing.
+
+ <p>
+ For a stream element is also specifies that it must be seekable.
+ </p>
+ */
+ const long READWRITE = 7;
+
+ /** lets the document be truncated immediately after opening.
+
+ <p>
+ This flag makes sense only in combination with
+ ElementModes::WRITE.
+ </p>
+ */
+ const long TRUNCATE = 8;
+
+ /** restricts creation of a new element on opening in case a requested one
+ does not exist.
+
+ <p>
+ This flag makes sense only in combination with
+ ElementModes::WRITE.
+ </p>
+ */
+ const long NOCREATE = 16;
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */