offapi/com/sun/star/form/DatabaseParameterEvent.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_DatabaseParameterEvent_idl__
  20 #define __com_sun_star_form_DatabaseParameterEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24 #include <com/sun/star/container/XIndexAccess.idl>
  25
  26
  27
  28  module com {  module sun {  module star {  module form {
  29
  30
  31 /** is fired if values for parameters are needed.
  32  */
  33 published struct DatabaseParameterEvent: com::sun::star::lang::EventObject
  34 {
  35     /** specifies the list of parameters which are required for opening a result set.
  36
  37         <p>Usually, a com::sun::star::form::component::DataForm fires this
  38         event when loading the form requires parameters to be filled in.</p>
  39
  40         <p>Every parameter object supports the com::sun::star::beans::XPropertySet
  41         interface, and at least the properties <em>Name</em> and <em>Value</em></p>
  42
  43         @see com::sun::star::sdb::RowSet
  44         @see com::sun::star::form::component::DataForm
  45      */
  46     com::sun::star::container::XIndexAccess Parameters;
  47 };
  48
  49
  50 }; }; }; };
  51
  52 #endif
  53
  54 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */