gecko-dev/widget/shared/WidgetUtils.h
2013-10-28 10:05:51 -04:00

68 lines
2.4 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*-
*
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
#ifndef __mozilla_widget_WidgetUtils_h__
#define __mozilla_widget_WidgetUtils_h__
#include "nsCOMPtr.h"
#include "nsIWidget.h"
#include "nsPIDOMWindow.h"
#include "nsIDOMWindow.h"
#include "mozilla/EventForwards.h"
namespace mozilla {
namespace widget {
class WidgetUtils
{
public:
/**
* Starting at the docshell item for the passed in DOM window this looks up
* the docshell tree until it finds a docshell item that has a widget.
*/
static already_AddRefed<nsIWidget> DOMWindowToWidget(nsIDOMWindow *aDOMWindow);
/**
* Compute our keyCode value (NS_VK_*) from an ASCII character.
*/
static uint32_t ComputeKeyCodeFromChar(uint32_t aCharCode);
/**
* Get unshifted charCode and shifted charCode for aKeyCode if the keyboad
* layout is a Latin keyboard layout.
*
* @param aKeyCode Our keyCode (NS_VK_*).
* @param aIsCapsLock TRUE if CapsLock is Locked. Otherwise, FALSE.
* This is used only when aKeyCode is NS_VK_[0-9].
* @param aUnshiftedCharCode CharCode for aKeyCode without Shift key.
* This may be zero if aKeyCode key doesn't input
* a Latin character.
* Note that must not be nullptr.
* @param aShiftedCharCode CharCode for aKeyCOde with Shift key.
* This is always 0 when aKeyCode isn't
* NS_VK_[A-Z].
* Note that must not be nullptr.
*/
static void GetLatinCharCodeForKeyCode(uint32_t aKeyCode,
bool aIsCapsLock,
uint32_t* aUnshiftedCharCode,
uint32_t* aShiftedCharCode);
/**
* GetDeadKeyNameIndex() returns a key name index for dead key or
* "Unidentified". This method can return the index from non-combining
* unicode character, e.g., '`' returns KEY_NAME_INDEX_DeadGrave.
* So, you cannot use this method for checking if the char is a dead char.
*/
static KeyNameIndex GetDeadKeyNameIndex(PRUnichar aChar);
};
} // namespace widget
} // namespace mozilla
#endif