widget/WidgetUtils.h

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  * vim: sw=2 ts=8 et :
   3  */
   4 /* This Source Code Form is subject to the terms of the Mozilla Public
   5  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   6  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   7
   8 #ifndef mozilla_WidgetUtils_h
   9 #define mozilla_WidgetUtils_h
  10
  11 #include "mozilla/EventForwards.h"
  12 #include "mozilla/gfx/Matrix.h"
  13 #include "nsCOMPtr.h"
  14 #include "nsIDOMWindow.h"
  15 #include "nsIWidget.h"
  16 #include "nsPIDOMWindow.h"
  17 #include "nsRect.h"
  18
  19 namespace mozilla {
  20
  21 // NB: these must match up with pseudo-enum in nsIScreen.idl.
  22 enum ScreenRotation {
  23   ROTATION_0 = 0,
  24   ROTATION_90,
  25   ROTATION_180,
  26   ROTATION_270,
  27
  28   ROTATION_COUNT
  29 };
  30
  31 gfx::Matrix ComputeTransformForRotation(const nsIntRect& aBounds,
  32                                         ScreenRotation aRotation);
  33
  34 gfx::Matrix ComputeTransformForUnRotation(const nsIntRect& aBounds,
  35                                           ScreenRotation aRotation);
  36
  37 nsIntRect RotateRect(nsIntRect aRect,
  38                      const nsIntRect& aBounds,
  39                      ScreenRotation aRotation);
  40
  41 namespace widget {
  42
  43 class WidgetUtils
  44 {
  45 public:
  46
  47   /**
  48    * Starting at the docshell item for the passed in DOM window this looks up
  49    * the docshell tree until it finds a docshell item that has a widget.
  50    */
  51   static already_AddRefed<nsIWidget> DOMWindowToWidget(nsIDOMWindow *aDOMWindow);
  52
  53   /**
  54    * Compute our keyCode value (NS_VK_*) from an ASCII character.
  55    */
  56   static uint32_t ComputeKeyCodeFromChar(uint32_t aCharCode);
  57
  58   /**
  59    * Get unshifted charCode and shifted charCode for aKeyCode if the keyboad
  60    * layout is a Latin keyboard layout.
  61    *
  62    * @param aKeyCode            Our keyCode (NS_VK_*).
  63    * @param aIsCapsLock         TRUE if CapsLock is Locked.  Otherwise, FALSE.
  64    *                            This is used only when aKeyCode is NS_VK_[0-9].
  65    * @param aUnshiftedCharCode  CharCode for aKeyCode without Shift key.
  66    *                            This may be zero if aKeyCode key doesn't input
  67    *                            a Latin character.
  68    *                            Note that must not be nullptr.
  69    * @param aShiftedCharCode    CharCode for aKeyCOde with Shift key.
  70    *                            This is always 0 when aKeyCode isn't
  71    *                            NS_VK_[A-Z].
  72    *                            Note that must not be nullptr.
  73    */
  74   static void GetLatinCharCodeForKeyCode(uint32_t aKeyCode,
  75                                          bool aIsCapsLock,
  76                                          uint32_t* aUnshiftedCharCode,
  77                                          uint32_t* aShiftedCharCode);
  78
  79   /**
  80    * GetDeadKeyNameIndex() returns a key name index for dead key or
  81    * "Unidentified".  This method can return the index from non-combining
  82    * unicode character, e.g., '`' returns KEY_NAME_INDEX_DeadGrave.
  83    * So, you cannot use this method for checking if the char is a dead char.
  84    */
  85   static KeyNameIndex GetDeadKeyNameIndex(char16_t aChar);
  86 };
  87
  88 } // namespace widget
  89 } // namespace mozilla
  90
  91 #endif // mozilla_WidgetUtils_h