offapi/com/sun/star/form/XDatabaseParameterBroadcaster.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
  20 #define __com_sun_star_form_XDatabaseParameterBroadcaster_idl__
  21
  22 #include <com/sun/star/uno/XInterface.idl>
  23
  24 #include <com/sun/star/form/XDatabaseParameterListener.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module form {
  29
  30
  31 /** provides the possibility of receiving an event for configuration of parameters.
  32     <p>This interface is usually implemented by components which are to execute a statement,
  33     and may need parameter information. For example, the
  34     com::sun::star::form::component::DataForm is such a component. When it is
  35     bound to a statement which contains parameters, or to a query which is based upon a parametrized
  36     statement, it needs values to fill in the parameters with actual values when it is being loaded.
  37     One method to gather these values is calling the XDatabaseParameterListener listeners, which
  38     can fill them in.</p>
  39  */
  40 published interface XDatabaseParameterBroadcaster: com::sun::star::uno::XInterface
  41 {
  42
  43     /** adds the specified listener, to allow it to fill in necessary parameter values.
  44         @param aListener
  45             the listener to add.
  46         @see com::sun::star::form::XDatabaseParameterListener
  47      */
  48     void addParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
  49
  50
  51     /** removes the specified listener.
  52         @param aListener
  53             the listener to remove.
  54         @see com::sun::star::form::XDatabaseParameterListener
  55      */
  56     void removeParameterListener( [in] com::sun::star::form::XDatabaseParameterListener aListener );
  57
  58 };
  59
  60
  61 }; }; }; };
  62
  63 #endif
  64
  65 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */