ui/base/ime/win/tsf_input_scope.h

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #ifndef UI_BASE_IME_WIN_TSF_INPUT_SCOPE_H_
   6 #define UI_BASE_IME_WIN_TSF_INPUT_SCOPE_H_
   7
   8 #include <InputScope.h>
   9 #include <Windows.h>
  10 #include <vector>
  11
  12 #include "base/basictypes.h"
  13 #include "ui/base/ime/text_input_mode.h"
  14 #include "ui/base/ime/text_input_type.h"
  15 #include "ui/base/ime/ui_base_ime_export.h"
  16
  17 namespace ui {
  18 namespace tsf_inputscope {
  19
  20 // Returns InputScope list corresoponding to ui::TextInputType and
  21 // ui::TextInputMode.
  22 // This function is only used from following functions but declared for test.
  23 UI_BASE_IME_EXPORT std::vector<InputScope> GetInputScopes(
  24     TextInputType text_input_type,
  25     TextInputMode text_input_mode);
  26
  27 // Returns an instance of ITfInputScope, which is the Windows-specific
  28 // category representation corresponding to ui::TextInputType and
  29 // ui::TextInputMode that we are using to specify the expected text type
  30 // in the target field.
  31 // The returned instance has 0 reference count. The caller must maintain its
  32 // reference count.
  33 UI_BASE_IME_EXPORT ITfInputScope* CreateInputScope(
  34     TextInputType text_input_type,
  35     TextInputMode text_input_mode);
  36
  37 // A wrapper of the SetInputScopes API exported by msctf.dll.
  38 // http://msdn.microsoft.com/en-us/library/windows/desktop/ms629026.aspx
  39 // Does nothing on Windows XP in case TSF is disabled.
  40 // NOTE: For TSF-aware window, you should use ITfInputScope instead.
  41 UI_BASE_IME_EXPORT void SetInputScopeForTsfUnawareWindow(
  42     HWND window_handle,
  43     TextInputType text_input_type,
  44     TextInputMode text_input_mode);
  45
  46 }  // namespace tsf_inputscope
  47 }  // namespace ui
  48
  49 #endif  // UI_BASE_IME_WIN_TSF_INPUT_SCOPE_H_