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

   1 /*************************************************************************
   2  *
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * Copyright 2000, 2010 Oracle and/or its affiliates.
   6  *
   7  * OpenOffice.org - a multi-platform office productivity suite
   8  *
   9  * This file is part of OpenOffice.org.
  10  *
  11  * OpenOffice.org is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU Lesser General Public License version 3
  13  * only, as published by the Free Software Foundation.
  14  *
  15  * OpenOffice.org is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Lesser General Public License version 3 for more details
  19  * (a copy is included in the LICENSE file that accompanied this code).
  20  *
  21  * You should have received a copy of the GNU Lesser General Public License
  22  * version 3 along with OpenOffice.org.  If not, see
  23  * <http://www.openoffice.org/license.html>
  24  * for a copy of the LGPLv3 License.
  25  *
  26  ************************************************************************/
  27 #ifndef __com_sun_star_form_DatabaseParameterEvent_idl__
  28 #define __com_sun_star_form_DatabaseParameterEvent_idl__
  29
  30 #ifndef __com_sun_star_lang_EventObject_idl__
  31 #include <com/sun/star/lang/EventObject.idl>
  32 #endif
  33
  34 #ifndef __com_sun_star_container_XIndexAccess_idl__
  35 #include <com/sun/star/container/XIndexAccess.idl>
  36 #endif
  37
  38
  39 //=============================================================================
  40
  41  module com {  module sun {  module star {  module form {
  42
  43 //=============================================================================
  44
  45 /** is fired if values for parameters are needed.
  46  */
  47 published struct DatabaseParameterEvent: com::sun::star::lang::EventObject
  48 {
  49     /** specifies the list of parameters which are required for opening a result set.
  50
  51         <p>Usually, a <type scope="com::sun::star::form::component">DataForm</type> fires this
  52         event when loading the form requires parameters to be filled in.</p>
  53
  54         <p>Every parameter object supports the <type scope="com::sun::star::beans">XPropertySet</type>
  55         interface, and at least the properties <em>Name</em> and <em>Value</em></p>
  56
  57         @see com::sun::star::sdb::RowSet
  58         @see com::sun::star::form::component::DataForm
  59      */
  60     com::sun::star::container::XIndexAccess Parameters;
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 /*=============================================================================
  68
  69 =============================================================================*/
  70 #endif