offapi/com/sun/star/awt/XRequestCallback.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: XRequestCallback.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_awt_XRequestCallback_idl__
  32 #define __com_sun_star_awt_XRequestCallback_idl__
  33
  34 #ifndef __com_sun_star_awt_XCallback_idl__
  35 #include <com/sun/star/awt/XCallback.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module awt {
  41
  42 //=============================================================================
  43
  44 /** specifices an interface which can be used to call back
  45     an implementation
  46  */
  47 interface XRequestCallback
  48 {
  49     //-------------------------------------------------------------------------
  50
  51     /** adds a callback request to the implementation
  52
  53         @param aData
  54         any private data which will be provided to the callback implementation.
  55
  56         @param xCallback
  57         a reference to the callback which should be called by the implementation
  58         of this interface.
  59     */
  60     void addCallback( [in] XCallback xCallback, [in] any aData );
  61 };
  62
  63 //=============================================================================
  64
  65 }; }; }; };
  66
  67 #endif