Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream

Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>

1 files changed, 103 insertions, 0 deletions

diff --git a/udkapi/com/sun/star/beans/XIntrospection.idl b/udkapi/com/sun/star/beans/XIntrospection.idl
new file mode 100644
index 000000000..9fdb736fc
--- /dev/null
+++ b/udkapi/com/sun/star/beans/XIntrospection.idl
@@ -0,0 +1,103 @@
+/* -*- 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_XIntrospection_idl__
+#define __com_sun_star_beans_XIntrospection_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/beans/XIntrospectionAccess.idl>
+
+
+
+ module com {  module sun {  module star {  module beans {
+
+/** allows the inspection of an object's properties and methods.
+
+    <p><strong>Important note:</strong>An object can only be
+    inspected completely if it supports the com::sun::star::lang::XTypeProvider
+    interface.</p>
+
+    <p>For details see method XIntrospection::inspect(). </p>
+
+    @see XIntrospectionAccess
+ */
+published interface XIntrospection: com::sun::star::uno::XInterface
+{
+    /** inspects the given object.
+
+        <p>It identifies all properties supported by the object
+        if they are represented in one of the following ways: </p>
+
+        <dl>
+            <dt>property set </dt>
+            <dd>If the object supports an XPropertySet
+                interface, all its properties are adopted.
+            </dd>
+
+            <dt>attributes </dt>
+            <dd>All of an object's attributes are considered as properties
+                with same name. If an attribute is read-only, the property
+                also is read-only.
+            </dd>
+
+            <dt>get/set methods </dt>
+            <dd>Every method <code>RetType getX()</code> defines a
+                property where "X" stands for the property name and
+                "RetType" for its type. The method must not have any
+                parameters, or there is no property access method
+                and "X" has no property.  If there is also a method
+                <code>void setX( [in] RetType )</code>, the property
+                "X" also allows write access; otherwise it is read-only.
+            </dd>
+
+            <dt> <strong>Important note:</strong></dt>
+            <dd>If an object implements com::sun::star::container::XNameAccess,
+                the items that can be accessed are not considered as properties
+                of the object and so are not included in the property list offered by
+                com::sun::star::beans::XIntrospectionAccess::getProperties().
+                com::sun::star::container::XNameAccess items have to be
+                accessed separately by com::sun::star::beans::XIntrospectionAccess::getNameAccess().
+            </dd>
+        </dl>
+
+        <p>In addition, the inspect method identifies all listener
+        access methods in the form <code>add...Listener</code>/
+        <code>remove...Listener</code> (except methods of interface
+        XPropertySet) where "..." stands for the listener type.
+        </p>
+
+        <p>Methods which do not belong to a property nor which represent
+        a listener access nor which are methods of XPropertySet,
+        com::sun::star::container::XNameAccess,
+        com::sun::star::container::XIndexAccess, or
+        com::sun::star::container::XEnumerationAccess, are considered to be normal
+        methods. </p>
+
+        @see XIntrospectionAccess
+     */
+    com::sun::star::beans::XIntrospectionAccess inspect( [in] any aObject );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */