offapi/com/sun/star/view/XPrintJobBroadcaster.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: XPrintJobBroadcaster.idl,v $
  10  * $Revision: 1.7 $
  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 #ifndef __com_sun_star_view_XPrintJobBroadcaster_idl__
  31 #define __com_sun_star_view_XPrintJobBroadcaster_idl__
  32
  33 #ifndef __com_sun_star_uno_XInterface_idl__
  34 #include <com/sun/star/uno/XInterface.idl>
  35 #endif
  36
  37 #ifndef __com_sun_star_view_XPrintJobListener_idl__
  38 #include <com/sun/star/view/XPrintJobListener.idl>
  39 #endif
  40
  41 //=============================================================================
  42
  43 module com {  module sun {  module star {  module view {
  44
  45 //-----------------------------------------------------------------------------
  46 /** allows for getting information about a print job.
  47
  48     <p><type>XPrintJobBroadcaster</type> can be implemented by classes which
  49     implement <type>XPrintable</type>. It allows a <type>XPrintJobListener</type>
  50     to be registered, thus a client object will learn about the print progress.</p>
  51
  52     @see XPrintJobListener
  53
  54     @since OOo 1.1.2
  55  */
  56 published interface XPrintJobBroadcaster : com::sun::star::uno::XInterface
  57 {
  58     /** adds an <type>XPrintJobListener</type> to be notified about print progress.
  59      */
  60     [oneway] void addPrintJobListener( [in] XPrintJobListener xListener );
  61
  62     /** removes an <type>XPrintJobListener</type>.
  63      */
  64     [oneway] void removePrintJobListener( [in] XPrintJobListener xListener );
  65 };
  66
  67 }; }; }; };
  68
  69 #endif