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

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /*
   3  * This file is part of the LibreOffice project.
   4  *
   5  * This Source Code Form is subject to the terms of the Mozilla Public
   6  * License, v. 2.0. If a copy of the MPL was not distributed with this
   7  * file, You can obtain one at http://mozilla.org/MPL/2.0/.
   8  *
   9  * This file incorporates work covered by the following license notice:
  10  *
  11  *   Licensed to the Apache Software Foundation (ASF) under one or more
  12  *   contributor license agreements. See the NOTICE file distributed
  13  *   with this work for additional information regarding copyright
  14  *   ownership. The ASF licenses this file to you under the Apache
  15  *   License, Version 2.0 (the "License"); you may not use this file
  16  *   except in compliance with the License. You may obtain a copy of
  17  *   the License at http://www.apache.org/licenses/LICENSE-2.0 .
  18  */
  19 #ifndef __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  20 #define __com_sun_star_linguistic2_XLinguServiceEventBroadcaster_idl__
  21
  22
  23 #include <com/sun/star/uno/XInterface.idl>
  24 #include <com/sun/star/linguistic2/XLinguServiceEventListener.idl>
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** is used to register a listener for LinguServiceEvents.
  30
  31     <P>This interface may be used by spell checker or hyphenator
  32     implementations to allow clients to be registered and informed about
  33     com::sun::star::linguistic2::LinguServiceEvents.
  34     </P>
  35
  36     <P>Note: The LinguServiceManager forwards the
  37     com::sun::star::linguistic2::LinguServiceEvents
  38     it receives (from spell checkers or hyphenators) to its own listeners.
  39     Thus, there should be no need to register
  40     as a listener for a specific implementation./P>
  41
  42     @see    com::sun::star::linguistic2::XLinguServiceManager
  43     @see    com::sun::star::linguistic2::XLinguServiceEventListener
  44 */
  45 published interface XLinguServiceEventBroadcaster : com::sun::star::uno::XInterface
  46 {
  47     /**
  48          @returns
  49              `TRUE` if the listener was successfully added,
  50             `FALSE` otherwise.
  51
  52         @param xLstnr
  53             the listener to be added.
  54      */
  55     boolean addLinguServiceEventListener (
  56         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  57
  58     /**
  59          @returns
  60              `TRUE` if the listener was successfully removed,
  61             `FALSE` otherwise.
  62
  63         @param xLstnr
  64             the listener to be removed.
  65      */
  66     boolean removeLinguServiceEventListener (
  67         [in] com::sun::star::linguistic2::XLinguServiceEventListener    xLstnr );
  68
  69 };
  70
  71
  72 }; }; }; };
  73
  74 #endif
  75
  76 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */