summaryrefslogtreecommitdiffstats
path: root/udkapi/com/sun/star/beans/PropertyState.idl
diff options
context:
space:
mode:
Diffstat (limited to 'udkapi/com/sun/star/beans/PropertyState.idl')
-rw-r--r--udkapi/com/sun/star/beans/PropertyState.idl85
1 files changed, 85 insertions, 0 deletions
diff --git a/udkapi/com/sun/star/beans/PropertyState.idl b/udkapi/com/sun/star/beans/PropertyState.idl
new file mode 100644
index 000000000..ffda69801
--- /dev/null
+++ b/udkapi/com/sun/star/beans/PropertyState.idl
@@ -0,0 +1,85 @@
+/* -*- 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_beans_PropertyState_idl__
+#define __com_sun_star_beans_PropertyState_idl__
+
+
+
+module com { module sun { module star { module beans {
+
+
+/** This enumeration lists the states that a property value can have.
+
+ <p>The state consists of two aspects: </p>
+ <ol>
+ <li>whether a value is available or void, </li>
+ <li>whether the value is stored in the property set itself or is a
+ default, or ambiguous. </li>
+ </ol>
+
+ @see XPropertyState
+ @see Property
+ */
+published enum PropertyState
+{
+
+ /** The value of the property is stored in the PropertySet itself.
+
+ <p>The property value must be available and of the specified type.
+ If the PropertyAttribute field in the struct
+ Property contains PropertyAttribute::MAYBEVOID,
+ then the value may be void. </p>
+ */
+ DIRECT_VALUE,
+
+
+ /** The value of the property is available from a master (e.g., template).
+
+ <p>The PropertyAttribute field in the struct
+ Property must contain the
+ PropertyAttribute::MAYBEDEFAULT flag. The property
+ value must be available and of the specified type. If the
+ PropertyAttribute field in the struct Property
+ contains PropertyAttribute::MAYBEVOID, then the
+ value may be void. </p>
+ */
+ DEFAULT_VALUE,
+
+
+ /** The value of the property is only a recommendation because there
+ are multiple values for this property (e.g., from a multi selection).
+
+ <p>The PropertyAttribute field in the struct
+ Property must contain the
+ PropertyAttribute::MAYBEAMBIGUOUS flag. The
+ property value must be available and of the specified type.
+ If the Attribute field in the struct Property contains
+ PropertyAttribute::MAYBEVOID, then the value
+ may be void. </p>
+ */
+ AMBIGUOUS_VALUE
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */