widget/EventForwards.h

   1 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* This Source Code Form is subject to the terms of the Mozilla Public
   3  * License, v. 2.0. If a copy of the MPL was not distributed with this
   4  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   5
   6 #ifndef mozilla_EventForwards_h__
   7 #define mozilla_EventForwards_h__
   8
   9 #include <stdint.h>
  10
  11 #include "nsStringFwd.h"
  12 #include "nsTArray.h"
  13
  14 /**
  15  * XXX Following enums should be in BasicEvents.h.  However, currently, it's
  16  *     impossible to use foward delearation for enum.
  17  */
  18
  19 /**
  20  * Return status for event processors.
  21  */
  22 enum nsEventStatus
  23 {
  24   // The event is ignored, do default processing
  25   nsEventStatus_eIgnore,
  26   // The event is consumed, don't do default processing
  27   nsEventStatus_eConsumeNoDefault,
  28   // The event is consumed, but do default processing
  29   nsEventStatus_eConsumeDoDefault,
  30   // Value is not for use, only for serialization
  31   nsEventStatus_eSentinel
  32 };
  33
  34 namespace mozilla {
  35
  36 enum class CanBubble
  37 {
  38   eYes,
  39   eNo
  40 };
  41
  42 enum class Cancelable
  43 {
  44   eYes,
  45   eNo
  46 };
  47
  48 enum class ChromeOnlyDispatch
  49 {
  50   eYes,
  51   eNo
  52 };
  53
  54 enum class Trusted
  55 {
  56   eYes,
  57   eNo
  58 };
  59
  60 enum class Composed
  61 {
  62   eYes,
  63   eNo,
  64   eDefault
  65 };
  66
  67 /**
  68  * Event messages
  69  */
  70
  71 typedef uint16_t EventMessageType;
  72
  73 enum EventMessage : EventMessageType
  74 {
  75
  76 #define NS_EVENT_MESSAGE(aMessage) aMessage,
  77 #define NS_EVENT_MESSAGE_FIRST_LAST(aMessage, aFirst, aLast) \
  78   aMessage##First = aFirst, aMessage##Last = aLast,
  79
  80 #include "mozilla/EventMessageList.h"
  81
  82 #undef NS_EVENT_MESSAGE
  83 #undef NS_EVENT_MESSAGE_FIRST_LAST
  84
  85   // For preventing bustage due to "," after the last item.
  86   eEventMessage_MaxValue
  87 };
  88
  89 const char* ToChar(EventMessage aEventMessage);
  90
  91 /**
  92  * Event class IDs
  93  */
  94
  95 typedef uint8_t EventClassIDType;
  96
  97 enum EventClassID : EventClassIDType
  98 {
  99   // The event class name will be:
 100   //   eBasicEventClass for WidgetEvent
 101   //   eFooEventClass for WidgetFooEvent or InternalFooEvent
 102 #define NS_ROOT_EVENT_CLASS(aPrefix, aName)   eBasic##aName##Class
 103 #define NS_EVENT_CLASS(aPrefix, aName)      , e##aName##Class
 104
 105 #include "mozilla/EventClassList.h"
 106
 107 #undef NS_EVENT_CLASS
 108 #undef NS_ROOT_EVENT_CLASS
 109 };
 110
 111 const char* ToChar(EventClassID aEventClassID);
 112
 113 typedef uint16_t Modifiers;
 114
 115 #define NS_DEFINE_KEYNAME(aCPPName, aDOMKeyName) \
 116   KEY_NAME_INDEX_##aCPPName,
 117
 118 typedef uint16_t KeyNameIndexType;
 119 enum KeyNameIndex : KeyNameIndexType
 120 {
 121 #include "mozilla/KeyNameList.h"
 122   // If a DOM keyboard event is synthesized by script, this is used.  Then,
 123   // specified key name should be stored and use it as .key value.
 124   KEY_NAME_INDEX_USE_STRING
 125 };
 126
 127 #undef NS_DEFINE_KEYNAME
 128
 129 const nsCString ToString(KeyNameIndex aKeyNameIndex);
 130
 131 #define NS_DEFINE_PHYSICAL_KEY_CODE_NAME(aCPPName, aDOMCodeName) \
 132   CODE_NAME_INDEX_##aCPPName,
 133
 134 typedef uint8_t CodeNameIndexType;
 135 enum CodeNameIndex : CodeNameIndexType
 136 {
 137 #include "mozilla/PhysicalKeyCodeNameList.h"
 138   // If a DOM keyboard event is synthesized by script, this is used.  Then,
 139   // specified code name should be stored and use it as .code value.
 140   CODE_NAME_INDEX_USE_STRING
 141 };
 142
 143 #undef NS_DEFINE_PHYSICAL_KEY_CODE_NAME
 144
 145 const nsCString ToString(CodeNameIndex aCodeNameIndex);
 146
 147 #define NS_DEFINE_COMMAND(aName, aCommandStr) , Command##aName
 148 #define NS_DEFINE_COMMAND_NO_EXEC_COMMAND(aName) , Command##aName
 149
 150 typedef int8_t CommandInt;
 151 enum Command : CommandInt
 152 {
 153   CommandDoNothing
 154
 155 #include "mozilla/CommandList.h"
 156 };
 157 #undef NS_DEFINE_COMMAND
 158 #undef NS_DEFINE_COMMAND_NO_EXEC_COMMAND
 159
 160 const char* ToChar(Command aCommand);
 161
 162 } // namespace mozilla
 163
 164 /**
 165  * All header files should include this header instead of *Events.h.
 166  */
 167
 168 namespace mozilla {
 169
 170 #define NS_EVENT_CLASS(aPrefix, aName) class aPrefix##aName;
 171 #define NS_ROOT_EVENT_CLASS(aPrefix, aName) NS_EVENT_CLASS(aPrefix, aName)
 172
 173 #include "mozilla/EventClassList.h"
 174
 175 #undef NS_EVENT_CLASS
 176 #undef NS_ROOT_EVENT_CLASS
 177
 178 // BasicEvents.h
 179 struct BaseEventFlags;
 180 struct EventFlags;
 181
 182 class WidgetEventTime;
 183
 184 class NativeEventData;
 185
 186 // TextEvents.h
 187 enum class AccessKeyType;
 188
 189 struct AlternativeCharCode;
 190 struct ShortcutKeyCandidate;
 191
 192 typedef nsTArray<ShortcutKeyCandidate> ShortcutKeyCandidateArray;
 193 typedef AutoTArray<ShortcutKeyCandidate, 10> AutoShortcutKeyCandidateArray;
 194
 195 // TextRange.h
 196 typedef uint8_t RawTextRangeType;
 197 enum class TextRangeType : RawTextRangeType;
 198
 199 struct TextRangeStyle;
 200 struct TextRange;
 201
 202 class EditCommands;
 203 class TextRangeArray;
 204
 205 // FontRange.h
 206 struct FontRange;
 207
 208 } // namespace mozilla
 209
 210 #endif // mozilla_EventForwards_h__