offapi/com/sun/star/datatransfer/clipboard/XClipboardNotifier.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: XClipboardNotifier.idl,v $
  10  * $Revision: 1.9 $
  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_datatransfer_clipboard_XClipboardNotifier_idl__
  32 #define __com_sun_star_datatransfer_clipboard_XClipboardNotifier_idl__
  33
  34 #ifndef __com_sun_star_uno_XInterface_idl__
  35 #include <com/sun/star/uno/XInterface.idl>
  36 #endif
  37
  38 //=============================================================================
  39
  40 module com { module sun { module star { module datatransfer { module clipboard {
  41
  42 //=============================================================================
  43 /** Provides the ability to request notifiations on clipboard content changes.
  44
  45     @see com::sun::star::datatransfer::clipboard::XClipboardListener
  46 */
  47
  48  published interface XClipboardListener;
  49
  50 published interface XClipboardNotifier: com::sun::star::uno::XInterface
  51 {
  52     //-------------------------------------------------------------------------
  53     /** Requests notifications on clipboard content changes.
  54
  55         @param listener
  56         The object receiving the notifications.
  57     */
  58     [oneway] void addClipboardListener( [in] XClipboardListener listener );
  59
  60     //-------------------------------------------------------------------------
  61     /** Removes listener from notification list.
  62
  63         @param listener
  64         The object to remove from notification list.
  65     */
  66     [oneway] void removeClipboardListener( [in] XClipboardListener listener );
  67 };
  68
  69 //=============================================================================
  70
  71 }; }; }; }; };
  72
  73 #endif