diff options
Diffstat (limited to 'offapi/com/sun/star/ucb/ListAction.idl')
-rw-r--r-- | offapi/com/sun/star/ucb/ListAction.idl | 162 |
1 files changed, 162 insertions, 0 deletions
diff --git a/offapi/com/sun/star/ucb/ListAction.idl b/offapi/com/sun/star/ucb/ListAction.idl new file mode 100644 index 000000000000..76820b4c6dfc --- /dev/null +++ b/offapi/com/sun/star/ucb/ListAction.idl @@ -0,0 +1,162 @@ +/************************************************************************* + * + * $RCSfile: ListAction.idl,v $ + * + * $Revision: 1.1 $ + * + * last change: $Author: mi $ $Date: 2000-11-06 09:22:31 $ + * + * The Contents of this file are made available subject to the terms of + * either of the following licenses + * + * - GNU Lesser General Public License Version 2.1 + * - Sun Industry Standards Source License Version 1.1 + * + * Sun Microsystems Inc., October, 2000 + * + * GNU Lesser General Public License Version 2.1 + * ============================================= + * Copyright 2000 by Sun Microsystems, Inc. + * 901 San Antonio Road, Palo Alto, CA 94303, USA + * + * This library is free software; you can redistribute it and/or + * modify it under the terms of the GNU Lesser General Public + * License version 2.1, as published by the Free Software Foundation. + * + * This library is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU + * Lesser General Public License for more details. + * + * You should have received a copy of the GNU Lesser General Public + * License along with this library; if not, write to the Free Software + * Foundation, Inc., 59 Temple Place, Suite 330, Boston, + * MA 02111-1307 USA + * + * + * Sun Industry Standards Source License Version 1.1 + * ================================================= + * The contents of this file are subject to the Sun Industry Standards + * Source License Version 1.1 (the "License"); You may not use this file + * except in compliance with the License. You may obtain a copy of the + * License at http://www.openoffice.org/license.html. + * + * Software provided under this License is provided on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, + * WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE IS FREE OF DEFECTS, + * MERCHANTABLE, FIT FOR A PARTICULAR PURPOSE, OR NON-INFRINGING. + * See the License for the specific provisions governing your rights and + * obligations concerning the Software. + * + * The Initial Developer of the Original Code is: Sun Microsystems, Inc. + * + * Copyright: 2000 by Sun Microsystems, Inc. + * + * All Rights Reserved. + * + * Contributor(s): _______________________________________ + * + * + ************************************************************************/ +#ifndef __com_sun_star_ucb_ListAction_idl__ +#define __com_sun_star_ucb_ListAction_idl__ + + +//============================================================================= + +module com { module sun { module star { module ucb { + +//============================================================================= +/** This struct contains information needed in the notifications of a +<type>XDynamicResultSet</type> + +@see ListEvent +*/ + +struct ListAction +{ + //------------------------------------------------------------------------- + /** The position where something has happened ( index begins with 1 as + usual with JDBC ). + Its value does not necessary indicate the new position in the new + <type>XResultSet</type>, but a position while doing the changes step by + step beginning with the old <type>XResultSet</type>. + */ + long Position; + + //------------------------------------------------------------------------- + /** The Count of involved rows. + */ + long Count; + + + //------------------------------------------------------------------------- + /** specifies the kind of modification happened to all assigned rows. + + <p>The <member>ListAction::ListActionType</member> must contain a + constant of the <type>ListActionType</type> constants group. + + <p><type>ListAction</type>s with different contents of + <member>ListAction::ListActionType</member> need or can contain + different values for <member>ListAction::Position</member>, + <member>ListAction::Count</member> and + <member>ListAction::ActionInfo</member>: + + <p>So this member is to be filled as follows: + + <table border=1> + <tr align=left> <th>ListActionType</th> + <th>Position</th> + <th>Count</th> + <th>ActionInfo</th></tr> + + <tr align=left> <th><br></th><th><br></th> + <th><br></th><th><br></th></tr> + + <tr align=left> <th>WELCOME</th> + <th>useless</th> + <th>useless</th> + <th>type WelcomeDynamicResultSetStruct required</th></tr> + + <tr align=left> <th>CLEARED</th> + <th>useless</th> + <th>useless</th> + <th>useless</th></tr> + + <tr align=left> <th>INSERTED</th> + <th>required 1-x</th> + <th>required 1-x</th> + <th>allowed but not required... @todo </th></tr> + + <tr align=left> <th>REMOVED</th> + <th>required 1-x</th> + <th>required 1-x</th> + <th>useless</th></tr> + + <tr align=left> <th>MOVED</th> + <th>required 1-x</th> + <th>required 1-x</th> + <th>type long required</th></tr> + + <tr align=left> <th>PROPERTIES_CHANGED</th> + <th>required 1-x</th> + <th>required 1-x</th> + <th>allowed but not required... @todo</th></tr> + </table> + */ + long ListActionType; + + //------------------------------------------------------------------------- + /** dependend on the content of <member>ListAction::ListActionType</member> + the <member>ListAction::ActionInfo</member> could contain additional + information about the changes happened ( see table above ). + */ + + any ActionInfo; +}; + +//============================================================================= + +}; }; }; }; + +#endif |