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

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

9 files changed, 464 insertions, 0 deletions

diff --git a/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl
new file mode 100644
index 0000000000..83225a614a
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/ButtonNavigationHandler.idl
@@ -0,0 +1,46 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which is able to enhance the com::sun::star::form::component::CommandButton::ButtonType
+    and com::sun::star::form::component::CommandButton::TargetURL properties of a
+    com::sun::star::form::component::CommandButton.
+
+    <p>For this, the two properties are superseded by new versions, where as button type, additional
+    possible values are added for navigating the parent form of the button. For instance, in an
+    com::sun::star::inspection::ObjectInspector using this handler, the user will be able
+    to choose a button type saying "move to the next record", which, when chosen, well, moves the parent
+    database form of the button to the next record.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::component::CommandButton
+*/
+service ButtonNavigationHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl
new file mode 100644
index 0000000000..cbd4150488
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/CellBindingPropertyHandler.idl
@@ -0,0 +1,49 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which is able to provide properties to bind a form component to a spreadsheet cell.
+
+    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
+    That is, the com::sun::star::uno::XComponentContext used for creating the
+    CellBindingPropertyHandler is examined for a value with this name. If the object in this
+    value denotes a spreadsheet document (indicated by supporting the com::sun::star::sheet::XSpreadsheetDocument
+    interface), this document is used to create the com::sun::star::form::binding::ValueBindings
+    to bind the inspected object to cells in this document.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::binding::BindableControlModel
+    @see com::sun::star::form::binding::ValueBinding
+    @see com::sun::star::table::CellValueBinding
+    @see com::sun::star::table::ListPositionCellBinding
+    @see com::sun::star::uno::XComponentContext::getValueByName
+*/
+service CellBindingPropertyHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl
new file mode 100644
index 0000000000..5c82e0e1d2
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/DefaultFormComponentInspectorModel.idl
@@ -0,0 +1,81 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a com::sun::star::inspection::XObjectInspectorModel for
+    inspecting form components, in particular all components implementing the FormComponent
+    service.
+
+    <p>A DefaultFormComponentInspectorModel provides the following handlers by default:
+    <ul><li>ButtonNavigationHandler</li>
+        <li>CellBindingPropertyHandler</li>
+        <li>EditPropertyHandler</li>
+        <li>EventHandler</li>
+        <li>FormComponentPropertyHandler</li>
+        <li>SubmissionPropertyHandler</li>
+        <li>XMLFormsPropertyHandler</li>
+        <li>XSDValidationPropertyHandler</li>
+    </ul></p>
+
+    @see com::sun::star::inspection::XObjectInspectorModel::HandlerFactories
+*/
+service DefaultFormComponentInspectorModel : com::sun::star::inspection::XObjectInspectorModel
+{
+    /** creates a default DefaultFormComponentInspectorModel, providing factories for all
+        handlers listed above.
+
+        @since OOo 2.2
+    */
+    createDefault();
+
+    /** creates a default DefaultFormComponentInspectorModel, providing factories for all
+        handlers listed above, and describing an ObjectInspector which has a help section.
+
+        @param minHelpTextLines
+            denotes the minimum number of lines of text to be reserved for the help
+            section.
+
+        @param maxHelpTextLines
+            denotes the maximum number of lines of text to be reserved for the help
+            section.
+
+        @throws ::com::sun::star::lang::IllegalArgumentException
+            if minHelpTextLines or maxHelpTextLines are negative,
+            or if minHelpTextLines is greater than maxHelpTextLines.
+
+        @see XObjectInspectorModel::HasHelpSection
+        @see XObjectInspectorModel::MinHelpTextLines
+        @see XObjectInspectorModel::MaxHelpTextLines
+
+        @since OOo 2.2
+    */
+    createWithHelpSection(
+        [in] long minHelpTextLines,
+        [in] long maxHelpTextLines
+    )
+        raises ( ::com::sun::star::lang::IllegalArgumentException );
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl b/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl
new file mode 100644
index 0000000000..b9e030a02a
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/EditPropertyHandler.idl
@@ -0,0 +1,50 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which provides convenience wrappers for some properties existing at a form component
+    derived from com::sun::star::awt::UnoControlEditModel.
+
+    <p>First, the handler supersedes the HScroll and the VScroll properties of a com::sun::star::awt::UnoControlEditModel
+    and puts them into one common property, allowing the user to choose whether she want to
+    have "no", a "vertical", a "horizontal", or "both" scrollbars.<p>
+
+    <p>Second, if it detects a com::sun::star::form::component::RichTextControl to inspect,
+    it supersedes the com::sun::star::form::component::RichTextControl::RichText
+    and the com::sun::star::awt::UnoControlEditModel::MultiLine properties with a new
+    one which allows choosing the text type with one single action.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::awt::UnoControlEditModel
+    @see com::sun::star::form::component::RichTextControl
+    @see com::sun::star::form::component::TextField
+*/
+service EditPropertyHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/EventHandler.idl b/offapi/com/sun/star/form/inspection/EventHandler.idl
new file mode 100644
index 0000000000..f65ab9fae3
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/EventHandler.idl
@@ -0,0 +1,44 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which, for a com::sun::star::form::FormComponent, provides the script events
+    offered by this form component.
+
+    <p>For this, the parent of the form component, which by definition supports the com::sun::star::form::FormComponent
+    service, is examined for the com::sun::star::script::XEventAttacherManager interface.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::component::CommandButton
+    @see com::sun::star::form::FormComponents
+    @see com::sun::star::script::XEventAttacherManager
+*/
+service EventHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl
new file mode 100644
index 0000000000..88c33ba676
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/FormComponentPropertyHandler.idl
@@ -0,0 +1,34 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements the default property handler for all known types of com::sun::star::form::FormComponents.
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::FormComponents
+*/
+service FormComponentPropertyHandler : com::sun::star::inspection::XPropertyHandler;
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl
new file mode 100644
index 0000000000..bc8c8936b8
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/SubmissionPropertyHandler.idl
@@ -0,0 +1,48 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which provides properties for button controls which support submission of XML forms.
+
+    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
+    That is, the com::sun::star::uno::XComponentContext used for creating the
+    CellBindingPropertyHandler is examined for a value with this name. If the object in this
+    value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier
+    interface), this document is used to examine the XML submissions which the button can be bound to.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::submission::XSubmission
+    @see com::sun::star::form::submission::XSubmissionProvider
+    @see com::sun::star::form::component::SubmitButton
+    @see com::sun::star::xforms::XSubmission
+    @see com::sun::star::uno::XComponentContext::getValueByName
+*/
+service SubmissionPropertyHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl
new file mode 100644
index 0000000000..4e10367e60
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/XMLFormsPropertyHandler.idl
@@ -0,0 +1,54 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which provides properties related to binding form control models to XForm bindings.
+
+    <p>The handler introduces new properties to choose a com::sun::star::xforms::XModel
+    and a com::sun::star::xforms::Binding within this model. Additionally,
+    it introduces properties which reflect the different facets of the binding (e.g.
+    com::sun::star::xforms::Binding::BindingExpression), so they can be changed
+    directly in the com::sun::star::inspection::ObjectInspector as if they were a
+    property of the form component which is being inspected.</p>
+
+    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
+    That is, the com::sun::star::uno::XComponentContext used for creating the
+    CellBindingPropertyHandler is examined for a value with this name. If the object in this
+    value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier
+    interface), this document is used to do XML binding related work.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::binding::BindableControlModel
+    @see com::sun::star::form::binding::ValueBinding
+    @see com::sun::star::xforms::Binding
+    @see com::sun::star::uno::XComponentContext::getValueByName
+*/
+service XMLFormsPropertyHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
diff --git a/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl
new file mode 100644
index 0000000000..bc6e2e514d
--- /dev/null
+++ b/offapi/com/sun/star/form/inspection/XSDValidationPropertyHandler.idl
@@ -0,0 +1,58 @@
+/* -*- 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 .
+ */
+
+
+module com {  module sun {  module star {  module form { module inspection {
+
+
+/** implements a property handler for use with a com::sun::star::inspection::ObjectInspector
+    which provides properties related to binding form control models to XForm bindings and validating
+    the form control content.
+
+    <p>By using an XMLFormsPropertyHandler, a com::sun::star::inspection::ObjectInspector
+    can be used to bind form components to com::sun::star::xforms::Binding instances.
+    Since those instances also support validating form control content (by supporting an
+    com::sun::star::form::validation::XValidator interface), it seems reasonable to
+    edit those validate-related properties (like the XSD data type to validate against) in the
+    com::sun::star::inspection::ObjectInspector, too. This is what an XSDValidationPropertyHandler
+    is good for.</p>
+
+    <p>The handler expects a value named "ContextDocument" in the context in which it is created.
+    That is, the com::sun::star::uno::XComponentContext used for creating the
+    CellBindingPropertyHandler is examined for a value with this name. If the object in this
+    value denotes a XML form document (indicated by supporting the com::sun::star::xforms::XFormsSupplier
+    interface), this document is used to do XML binding related work.</p>
+
+    @see com::sun::star::inspection::XPropertyHandler
+    @see com::sun::star::form::binding::BindableControlModel
+    @see com::sun::star::form::binding::ValueBinding
+    @see com::sun::star::forms::validation::ValidatableControlModel
+    @see com::sun::star::xforms::Binding
+    @see com::sun::star::xsd::XDataType
+    @see com::sun::star::uno::XComponentContext::getValueByName
+*/
+service XSDValidationPropertyHandler
+{
+    interface com::sun::star::inspection::XPropertyHandler;
+};
+
+
+}; }; }; }; };
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */