offapi/com/sun/star/linguistic2/DictionaryEvent.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_DictionaryEvent_idl__
  20 #define __com_sun_star_linguistic2_DictionaryEvent_idl__
  21
  22 #include <com/sun/star/lang/EventObject.idl>
  23 #include <com/sun/star/linguistic2/XDictionaryEntry.idl>
  24
  25
  26
  27 module com { module sun { module star { module linguistic2 {
  28
  29 /** represents a dictionary event.
  30
  31     <P>This type of event is used by a dictionary to inform
  32     its listeners about changes in its properties or its entry list.
  33     It consists of an event type and may supply an affected
  34     dictionary entry.</P>
  35
  36     @see    com::sun::star::linguistic2::XDictionary
  37     @see    com::sun::star::linguistic2::XDictionaryEventListener
  38     @see    com::sun::star::lang::EventObject
  39 */
  40 published struct DictionaryEvent : com::sun::star::lang::EventObject
  41 {
  42     /** is the type of event.
  43
  44          <p>This must be the value of a single flag. No combinations are
  45          allowed.</p>
  46
  47         @see    com::sun::star::linguistic2::DictionaryEventFlags
  48     */
  49     short nEvent;
  50
  51     /** is the affected dictionary entry (if any).
  52
  53          <p>It must be set if an entry was
  54          added or deleted, otherwise it should be empty.</p>
  55
  56         @see    com::sun::star::linguistic2::XDictionaryEntry
  57     */
  58     com::sun::star::linguistic2::XDictionaryEntry xDictionaryEntry;
  59
  60 };
  61
  62
  63 }; }; }; };
  64
  65 #endif
  66
  67 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */