offapi/com/sun/star/sdb/application/CopyTableRowEvent.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: CopyTableRowEvent.idl,v $
  10  * $Revision: 1.3 $
  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
  31 #ifndef __com_sun_star_sdb_application_CopyTableRowEvent_idl__
  32 #define __com_sun_star_sdb_application_CopyTableRowEvent_idl__
  33
  34 #ifndef __com_sun_star_lang_EventObject_idl__
  35 #include <com/sun/star/lang/EventObject.idl>
  36 #endif
  37 #ifndef __com_sun_star_sdbc_XResultSet_idl__
  38 #include <com/sun/star/sdbc/XResultSet.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com { module sun { module star { module sdb { module application {
  44
  45 //=============================================================================
  46
  47 /** specifies an event happening while copying table data between databases.
  48
  49     <p>Whenever this event is fired to an <type>XCopyTableListener</type>,
  50     <member scope="com::sun::star::lang">EventObject::Source</member> contains the
  51     wizard instance which actually does the copying.</p>
  52
  53     @see CopyTableWizard
  54  */
  55 struct CopyTableRowEvent : ::com::sun::star::lang::EventObject
  56 {
  57     /** contains the result set which is being copied by the wizard currently.
  58     */
  59     ::com::sun::star::sdbc::XResultSet  SourceData;
  60
  61     /** denotes the error which happened while copying the data.
  62
  63         <p>Usually, this contains an instance of <type scope="com::sun::star::sdbc">SQLException</type>.</p>
  64     */
  65     any Error;
  66 };
  67
  68 //=============================================================================
  69
  70 }; }; }; }; };
  71
  72 //=============================================================================
  73
  74 #endif