1/************************************************************** 2 * 3 * Licensed to the Apache Software Foundation (ASF) under one 4 * or more contributor license agreements. See the NOTICE file 5 * distributed with this work for additional information 6 * regarding copyright ownership. The ASF licenses this file 7 * to you under the Apache License, Version 2.0 (the 8 * "License"); you may not use this file except in compliance 9 * with the License. You may obtain a copy of the License at 10 * 11 * http://www.apache.org/licenses/LICENSE-2.0 12 * 13 * Unless required by applicable law or agreed to in writing, 14 * software distributed under the License is distributed on an 15 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY 16 * KIND, either express or implied. See the License for the 17 * specific language governing permissions and limitations 18 * under the License. 19 * 20 *************************************************************/ 21 22 23 24#ifndef __com_sun_star_sdb_application_XCopyTableListener_idl__ 25#define __com_sun_star_sdb_application_XCopyTableListener_idl__ 26 27#ifndef __com_sun_star_lang_XEventListener_idl__ 28#include <com/sun/star/lang/XEventListener.idl> 29#endif 30#ifndef __com_sun_star_sdb_application_CopyTableRowEvent_idl__ 31#include <com/sun/star/sdb/application/CopyTableRowEvent.idl> 32#endif 33 34//============================================================================= 35 36module com { module sun { module star { module sdb { module application { 37 38//============================================================================= 39 40/** specifies the interface required to listen for progress in copying 41 table rows via a <code>CopyTableWizard</code>. 42 43 @see CopyTableRowEvent 44 @see CopyTableWizard 45 */ 46interface XCopyTableListener : ::com::sun::star::lang::XEventListener 47{ 48 /** is called when a row is about to be copied. 49 50 <p>This method is called immediately before a row is copied. It might be used, for instance, 51 to update a progress indicator.</p> 52 53 @param Event 54 describes the current state of the copy operation. 55 <member>CopyTableRowEvent::SourceData</member> is positioned at the row 56 which is about to be copied. 57 */ 58 void copyingRow( [in] CopyTableRowEvent Event ); 59 60 /** is called when a row was successfully copied. 61 62 <p>This method is called right after a row has been successfully copied. It might be used, 63 for instance, to update a progress indicator.</p> 64 65 @param Event 66 describes the current state of the copy operation. 67 <member>CopyTableRowEvent::SourceData</member> is positioned at the row 68 which was just copied to the target database. 69 */ 70 void copiedRow( [in] CopyTableRowEvent Event ); 71 72 /** is called when copying a row failed. 73 74 @param Event 75 describes the current state of the copy operation. 76 <member>CopyTableRowEvent::SourceData</member> is positioned at the row 77 which was attempted to be copied to the target database. 78 <member>CopyTableRowEvent::Error</member> will contain the actual error which 79 happened. 80 81 @return 82 how to continue with copying. Must be one of the <type>CopyTableContinuation</type> 83 constants. 84 */ 85 short copyRowError( [in] CopyTableRowEvent Event ); 86}; 87 88//============================================================================= 89 90}; }; }; }; }; 91 92//============================================================================= 93 94#endif 95