chrome/browser/chromeos/base/locale_util.h

   1 // Copyright 2013 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 // This file contains utility functions for locale change.
   6
   7 #ifndef CHROME_BROWSER_CHROMEOS_BASE_LOCALE_UTIL_H_
   8 #define CHROME_BROWSER_CHROMEOS_BASE_LOCALE_UTIL_H_
   9
  10 #include <string>
  11
  12 #include "base/memory/scoped_ptr.h"
  13
  14 class Profile;
  15
  16 namespace base {
  17
  18 template <typename T>
  19 class Callback;
  20
  21 }  // namespace base
  22
  23 namespace chromeos {
  24 namespace locale_util {
  25
  26 struct LanguageSwitchResult {
  27   LanguageSwitchResult(const std::string& requested_locale,
  28                        const std::string& loaded_locale,
  29                        bool success);
  30
  31   std::string requested_locale;
  32   std::string loaded_locale;
  33   bool success;
  34 };
  35
  36 // This callback is called on UI thread, when ReloadLocaleResources() is
  37 // completed on BlockingPool.
  38 // |result| contains:
  39 //   locale - (copy of) locale argument to SwitchLanguage(). Expected locale.
  40 //   loaded_locale - actual locale name loaded.
  41 //   success - if locale load succeeded.
  42 // (const std::string* locale, const std::string* loaded_locale, bool success)
  43 typedef base::Callback<void(const LanguageSwitchResult& result)>
  44     SwitchLanguageCallback;
  45
  46 // This function updates input methods only if requested. In general, you want
  47 // |enable_locale_keyboard_layouts = true|. |profile| is needed because IME
  48 // extensions are per-user.
  49 // Note: in case of |enable_locale_keyboard_layouts = false|, the input method
  50 // currently in use may not be supported by the new locale. Using the new locale
  51 // with an unsupported input method may lead to undefined behavior. Use
  52 // |enable_locale_keyboard_layouts = false| with caution.
  53 // Note 2: |login_layouts_only = true| enables only login-capable layouts.
  54 void SwitchLanguage(const std::string& locale,
  55                     const bool enable_locale_keyboard_layouts,
  56                     const bool login_layouts_only,
  57                     const SwitchLanguageCallback& callback,
  58                     Profile* profile);
  59
  60 }  // namespace locale_util
  61 }  // namespace chromeos
  62
  63 #endif  // CHROME_BROWSER_CHROMEOS_BASE_LOCALE_UTIL_H_