summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl
diff options
context:
space:
mode:
Diffstat (limited to 'offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl')
-rw-r--r--offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl65
1 files changed, 65 insertions, 0 deletions
diff --git a/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl
new file mode 100644
index 000000000..eec7b9c4b
--- /dev/null
+++ b/offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl
@@ -0,0 +1,65 @@
+/* -*- 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_XDatabaseParameterBroadcaster_idl__
+#define __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+
+#include <com/sun/star/form/XDatabaseParameterListener.idl>
+
+
+
+ module com { module sun { module star { module form {
+
+
+/** provides the possibility of receiving an event for configuration of parameters.
+ <p>This interface is usually implemented by components which are to execute a statement,
+ and may need parameter information. For example, the
+ com::sun::star::form::component::DataForm is such a component. When it is
+ bound to a statement which contains parameters, or to a query which is based upon a parametrized
+ statement, it needs values to fill in the parameters with actual values when it is being loaded.
+ One method to gather these values is calling the XDatabaseParameterListener listeners, which
+ can fill them in.</p>
+ */
+published interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface
+{
+
+ /** adds the specified listener, to allow it to fill in necessary parameter values.
+ @param aListener
+ the listener to add.
+ @see com::sun::star::form::XDatabaseParameterListener
+ */
+ void addParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
+
+
+ /** removes the specified listener.
+ @param aListener
+ the listener to remove.
+ @see com::sun::star::form::XDatabaseParameterListener
+ */
+ void removeParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
+
+};
+
+
+}; }; }; };
+
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */