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(44d9ef13-83be-4ab9-a2a1-95d9cbd96acd)]
  10 interface nsIBidiKeyboard : nsISupports
  11 {
  12   /**
  13    * Inspects the installed keyboards and resets the bidi keyboard state
  14    */
  15   void reset();
  16
  17   /**
  18    * Determines if the current keyboard language is right-to-left
  19    * @throws NS_ERROR_FAILURE if no right-to-left keyboards are installed
  20    */
  21   boolean isLangRTL();
  22
  23   /**
  24    * Sets the keyboard language to left-to-right or right-to-left
  25    * @param aLevel - if odd set the keyboard to RTL, if even set LTR
  26    * @throws NS_ERROR_FAILURE if no right-to-left keyboards are installed
  27    */
  28   void setLangFromBidiLevel(in uint8_t aLevel);
  29
  30   /**
  31    * Determines whether the system has at least one keyboard of each direction
  32    * installed.
  33    *
  34    * @throws NS_ERROR_NOT_IMPLEMENTED if the widget layer does not provide this
  35    * information.
  36    */
  37   readonly attribute boolean haveBidiKeyboards;
  38 };
  39