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

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