author Lucas Rocha <lucasr@lucasr.org>
Mon, 13 Oct 2014 15:50:39 +0100
changeset 225773 47ef137f046fd0f9a4ea00e9a0fee0e72c0a8eb2
parent 186388 43e799fdb80b9723d32d11772efe38dfffa6f7a3
child 233442 9936bcca134f807e9295c6b1db0d0497e3525fec
permissions -rw-r--r--
Bug 1058660 - Use consistent bg color in about:home's tab strip. r=margaret, a=lmandel

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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 WinIMEHandler_h_
#define WinIMEHandler_h_

#include "nscore.h"
#include "nsIWidget.h"
#include <windows.h>
#include <inputscope.h>


class nsWindow;

namespace mozilla {
namespace widget {

struct MSGResult;

 * IMEHandler class is a mediator class.  On Windows, there are two IME API
 * sets: One is IMM which is legacy API set. The other is TSF which is modern
 * API set. By using this class, non-IME handler classes don't need to worry
 * that we're in which mode.
class IMEHandler MOZ_FINAL
  static void Initialize();
  static void Terminate();

   * Returns TSF related native data.
  static void* GetNativeData(uint32_t aDataType);

   * ProcessRawKeyMessage() message is called before calling TranslateMessage()
   * and DispatchMessage().  If this returns true, the message is consumed.
   * Then, caller must not perform TranslateMessage() nor DispatchMessage().
  static bool ProcessRawKeyMessage(const MSG& aMsg);

   * When the message is not needed to handle anymore by the caller, this
   * returns true.  Otherwise, false.
  static bool ProcessMessage(nsWindow* aWindow, UINT aMessage,
                             WPARAM& aWParam, LPARAM& aLParam,
                             MSGResult& aResult);

   * When there is a composition, returns true.  Otherwise, false.
  static bool IsComposing();

   * When there is a composition and it's in the window, returns true.
   * Otherwise, false.
  static bool IsComposingOn(nsWindow* aWindow);

   * Notifies IME of the notification (a request or an event).
  static nsresult NotifyIME(nsWindow* aWindow,
                            const IMENotification& aIMENotification);

   * Returns update preferences.
  static nsIMEUpdatePreference GetUpdatePreference();

   * Returns IME open state on the window.
  static bool GetOpenState(nsWindow* aWindow);

   * Called when the window is destroying.
  static void OnDestroyWindow(nsWindow* aWindow);

   * Called when nsIWidget::SetInputContext() is called before the window's
   * InputContext is modified actually.
  static void SetInputContext(nsWindow* aWindow,
                              InputContext& aInputContext,
                              const InputContextAction& aAction);

   * Associate or disassociate IME context to/from the aWindow.
  static void AssociateIMEContext(nsWindow* aWindow, bool aEnable);

   * Called when the window is created.
  static void InitInputContext(nsWindow* aWindow, InputContext& aInputContext);

#ifdef DEBUG
   * Returns true when current keyboard layout has IME.  Otherwise, false.
  static bool CurrentKeyboardLayoutHasIME();
#endif // #ifdef DEBUG

  static decltype(SetInputScopes)* sSetInputScopes;
  static void SetInputScopeForIMM32(nsWindow* aWindow,
                                    const nsAString& aHTMLInputType);
  static bool sIsInTSFMode;
  // If sIMMEnabled is false, any IME messages are not handled in TSF mode.
  // Additionally, IME context is always disassociated from focused window.
  static bool sIsIMMEnabled;
  static bool sPluginHasFocus;

  static bool IsTSFAvailable() { return (sIsInTSFMode && !sPluginHasFocus); }
#endif // #ifdef NS_ENABLE_TSF

} // namespace widget
} // namespace mozilla

#endif // #ifndef WinIMEHandler_h_