offapi/com/sun/star/linguistic2/LinguServiceEvent.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_LinguServiceEvent_idl__
  20 #define __com_sun_star_linguistic2_LinguServiceEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23
  24
  25 module com { module sun { module star { module linguistic2 {
  26
  27 /** represents a linguistic service event.
  28
  29     <P>This type of event may be broadcast by a spell checker or
  30     hyphenator service implementation to inform its listeners (clients)
  31     that the results of previous function calls may be different now.
  32     It is possible to suggest that hyphenation should be done again
  33     and/or the spelling of previously incorrect or correct words
  34     should be checked again.</P>
  35
  36     @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventBroadcaster</type>
  37     @see    <type scope="com::sun::star::linguistic2">XLinguServiceEventListener</type>
  38     @see    <type scope="com::sun::star::linguistic2">SpellChecker</type>
  39     @see    <type scope="com::sun::star::linguistic2">Hyphenator</type>
  40     @see    <type scope="com::sun::star::lang">EventObject</type>
  41 */
  42 published struct LinguServiceEvent : com::sun::star::lang::EventObject
  43 {
  44     /** The type of event.
  45
  46          <p>The value may be combined via logical OR from those values
  47         defined in <type scope="com::sun::star::linguistic2">LinguServiceEventFlags</type></p>
  48     */
  49     short nEvent;
  50
  51 };
  52
  53
  54 }; }; }; };
  55
  56 #endif
  57
  58 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */