offapi/com/sun/star/linguistic2/XLinguServiceEventBroadcaster.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*************************************************************************
   3  *
   4  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   5  *
   6  * Copyright 2000, 2010 Oracle and/or its affiliates.
   7  *
   8  * OpenOffice.org - a multi-platform office productivity suite
   9  *
  10  * This file is part of OpenOffice.org.
  11  *
  12  * OpenOffice.org is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU Lesser General Public License version 3
  14  * only, as published by the Free Software Foundation.
  15  *
  16  * OpenOffice.org is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU Lesser General Public License version 3 for more details
  20  * (a copy is included in the LICENSE file that accompanied this code).
  21  *
  22  * You should have received a copy of the GNU Lesser General Public License
  23  * version 3 along with OpenOffice.org.  If not, see
  24  * <http://www.openoffice.org/license.html>
  25  * for a copy of the LGPLv3 License.
  26  *
  27  ************************************************************************/
  28 #ifndef __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  29 #define __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  30
  31
  32 #include <com/sun/star/uno/XInterface.idl>
  33 #include <com/sun/star/linguistic2/XLinguServiceEventListener.idl>
  34
  35 //=============================================================================
  36
  37 module com { module sun { module star { module linguistic2 {
  38
  39 //=============================================================================
  40 /** is used to register a listener for LinguServiceEvents.
  41
  42     <P>This interface may be used by spell checker or hyphenator
  43     implementations to allow clients to be registered and informed about
  44     <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s.
  45     </P>
  46
  47     <P>Note: The LinguServiceManager forwards the
  48     <type scope="com::sun::star::linguistic2">LinguServiceEvent</type>s
  49     it receives (from spell checkers or hyphenators) to its own listeners.
  50     Thus, there should be no need to register
  51     as a listener for a specific implementation./P>
  52
  53     @see    <type scope="com::sun::star::linguistic2">XLinguServiceManager</type>
  54     @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
  55 */
  56 published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface
  57 {
  58     //-------------------------------------------------------------------------
  59     /**
  60          @returns
  61              <TRUE/> if the listener was successfully added,
  62             <FALSE/> otherwise.
  63
  64         @param xLstnr
  65             the listener to be added.
  66      */
  67     boolean addLinguServiceEventListener (
  68         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  69
  70     //-------------------------------------------------------------------------
  71     /**
  72          @returns
  73              <TRUE/> if the listener was successfully removed,
  74             <FALSE/> otherwise.
  75
  76         @param xLstnr
  77             the listener to be removed.
  78      */
  79     boolean removeLinguServiceEventListener (
  80         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  81
  82 };
  83
  84 //=============================================================================
  85
  86 }; }; }; };
  87
  88 #endif
  89
  90 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */