widget/nsIBidiKeyboard.idl

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this
   5  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "nsISupports.idl"
   8
   9 [scriptable, uuid(99957506-f21b-4a61-ad64-5b641cf508e2)]
  10 interface nsIBidiKeyboard : nsISupports
  11 {
  12   /**
  13    * Determines if the current keyboard language is right-to-left
  14    * @throws NS_ERROR_FAILURE if no right-to-left keyboards are installed
  15    */
  16   boolean isLangRTL();
  17
  18   /**
  19    * Sets the keyboard language to left-to-right or right-to-left
  20    * @param aLevel - if odd set the keyboard to RTL, if even set LTR
  21    * @throws NS_ERROR_FAILURE if no right-to-left keyboards are installed
  22    */
  23   void setLangFromBidiLevel(in PRUint8 aLevel);
  24
  25   /**
  26    * Determines whether the system has at least one keyboard of each direction
  27    * installed.
  28    *
  29    * @throws NS_ERROR_NOT_IMPLEMENTED if the widget layer does not provide this
  30    * information.
  31    */
  32   readonly attribute boolean haveBidiKeyboards;
  33 };
  34