author L10n Bumper Bot <release+l10nbumper@mozilla.com>
Mon, 14 Jan 2019 04:00:15 -0800
changeset 506679 b6bde01c7a183e9191a23a005734b747d321620a
parent 505383 6f3709b3878117466168c40affa7bca0b60cf75b
permissions -rw-r--r--
no bug - Bumping Fennec l10n changesets r=release a=l10n-bump DONTBUILD cak -> 3bd3d9938de2 ml -> da8508490cac trs -> a73bd0fa9499 uk -> de7742fa098e ur -> f3bfe0211b0d uz -> 6c42381becf7 vi -> 18fe987ca77d wo -> eaabeed6eb6c xh -> 1fe19625ce80 zam -> 5b7a669c784f zh-CN -> 2ff77a53b21c zh-TW -> 574f9f4100d8

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

#ifndef mozilla_textinputdispatcherlistener_h_
#define mozilla_textinputdispatcherlistener_h_

#include "nsWeakReference.h"

namespace mozilla {
namespace widget {

class TextEventDispatcher;
struct IMENotification;
struct IMENotificationRequests;

  {0xf2226f55,                           \
   0x6ddb,                               \
   0x40d5,                               \
   {0x8a, 0x24, 0xce, 0x4d, 0x5b, 0x38, 0x15, 0xf0}};

class TextEventDispatcherListener : public nsSupportsWeakReference {

   * NotifyIME() is called by TextEventDispatcher::NotifyIME().  This is a
   * notification or request to IME.  See document of nsIWidget::NotifyIME()
   * for the detail.
  NS_IMETHOD NotifyIME(TextEventDispatcher* aTextEventDispatcher,
                       const IMENotification& aNotification) = 0;

   * Returns preference for which IME notification are received by NotifyIME().
  NS_IMETHOD_(IMENotificationRequests) GetIMENotificationRequests() = 0;

   * OnRemovedFrom() is called when the TextEventDispatcher stops working and
   * is releasing the listener.
  OnRemovedFrom(TextEventDispatcher* aTextEventDispatcher) = 0;

   * WillDispatchKeyboardEvent() may be called immediately before
   * TextEventDispatcher dispatching a keyboard event.  This is called only
   * during calling TextEventDispatcher::DispatchKeyboardEvent() or
   * TextEventDispatcher::MaybeDispatchKeypressEvents().  But this may not
   * be called if TextEventDispatcher thinks that the keyboard event doesn't
   * need alternative char codes.
   * This method can overwrite any members of aKeyboardEvent which is already
   * initialized by TextEventDispatcher.  If it's necessary, this method should
   * overwrite the charCode when Control key is pressed.  TextEventDispatcher
   * computes charCode from mKeyValue.  However, when Control key is pressed,
   * charCode should be an ASCII char.  In such case, this method needs to
   * overwrite it properly.
   * @param aTextEventDispatcher    Pointer to the caller.
   * @param aKeyboardEvent          The event trying to dispatch.
   *                                This is already initialized, but if it's
   *                                necessary, this method should overwrite the
   *                                members and set alternative char codes.
   * @param aIndexOfKeypress        When aKeyboardEvent is eKeyPress event,
   *                                it may be a sequence of keypress events
   *                                if the key causes multiple characters.
   *                                In such case, this indicates the index from
   *                                first keypress event.
   *                                If aKeyboardEvent is the first eKeyPress or
   *                                other events, this value is 0.
   * @param aData                   The pointer which was specified at calling
   *                                the method of TextEventDispatcher.
   *                                For example, if you do:
   *                                |TextEventDispatcher->DispatchKeyboardEvent(
   *                                   eKeyDown, event, status, this);|
   *                                Then, aData of this method becomes |this|.
   *                                Finally, you can use it like:
   *                                |static_cast<NativeEventHandler*>(aData)|
  WillDispatchKeyboardEvent(TextEventDispatcher* aTextEventDispatcher,
                            WidgetKeyboardEvent& aKeyboardEvent,
                            uint32_t aIndexOfKeypress, void* aData) = 0;


}  // namespace widget
}  // namespace mozilla

#endif  // #ifndef mozilla_textinputdispatcherlistener_h_