1 files changed, 104 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/FormComponent.idl b/offapi/com/sun/star/form/FormComponent.idl
new file mode 100644
index 000000000..e6abc2e04
--- /dev/null
+++ b/offapi/com/sun/star/form/FormComponent.idl
@@ -0,0 +1,104 @@
+/* -*- 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_form_FormComponent_idl__
+#define __com_sun_star_form_FormComponent_idl__
+
+#include <com/sun/star/form/XFormComponent.idl>
+#include <com/sun/star/lang/XComponent.idl>
+#include <com/sun/star/container/XNamed.idl>
+#include <com/sun/star/beans/XPropertySet.idl>
+#include <com/sun/star/io/XPersistObject.idl>
+#include <com/sun/star/beans/XPropertyBag.idl>
+
+
+
+ module com {  module sun {  module star {  module form {
+
+
+/** specifies a component which can be part of a form.
+
+    @see FormControlModel
+    @see com::sun::star::form::component::Form
+ */
+published service FormComponent
+{
+    /** identifies the component as a candidate for being part of a form.
+        <p>This interface also provides the access to the component's parent.</p>
+     */
+    interface com::sun::star::form::XFormComponent;
+
+
+    /** allows life-time control of form components.
+     */
+    interface com::sun::star::lang::XComponent;
+
+
+    /** Each FormComponent must supply a name for identification.
+     */
+    interface com::sun::star::container::XNamed;
+
+    /** gives access to the properties.
+    */
+    interface com::sun::star::beans::XPropertySet;
+
+
+    /** Each FormComponent must be able to be stored into and read from a stream.
+     */
+    interface com::sun::star::io::XPersistObject;
+
+    /** allows to associate arbitrary properties with the form component
+
+        <p>Every concrete form component - i.e. every service which includes
+        the <code>FormComponent</code> service - has a set of properties which
+        are available as long as the component lives - the so-called <em>static
+        properties</em>.</p>
+
+        <p>Additionally, you can add more properties to the component as needed,
+        using the com::sun::star::beans::XPropertyContainer interface.
+        Those properties are called <em>dynamic properties</em>.</p>
+
+        <p>Dynamic properties are not evaluated by the component itself,
+        nor by the form's runtime environment. They're only remembered and available for
+        use by other instances.</p>
+
+        <p>Note that dynamic properties added to a form component are, by definition,
+        removable. That is, the com::sun::star::beans::PropertyAttribute::REMOVABLE
+        will always be set, even if you do not specify it in the
+        com::sun::star::beans::XPropertyContainer::addProperty() call.</p>
+
+        @since OOo 2.3
+    */
+    [optional] interface com::sun::star::beans::XPropertyBag;
+
+
+    /** the name of the component.
+
+        <p>Note that the name accessed here is the same as when using the
+        com::sun::star::container::XNamed interface.</p>
+     */
+    [property] string Name;
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */