widget/MiscEvents.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_MiscEvents_h__
   7 #define mozilla_MiscEvents_h__
   8
   9 #include <stdint.h>
  10
  11 #include "mozilla/BasicEvents.h"
  12 #include "nsCOMPtr.h"
  13 #include "nsIAtom.h"
  14 #include "nsITransferable.h"
  15
  16 namespace mozilla {
  17
  18 /******************************************************************************
  19  * mozilla::WidgetContentCommandEvent
  20  ******************************************************************************/
  21
  22 class WidgetContentCommandEvent : public WidgetGUIEvent
  23 {
  24 public:
  25   virtual WidgetContentCommandEvent* AsContentCommandEvent() MOZ_OVERRIDE
  26   {
  27     return this;
  28   }
  29
  30   WidgetContentCommandEvent(bool aIsTrusted, uint32_t aMessage,
  31                             nsIWidget* aWidget,
  32                             bool aOnlyEnabledCheck = false) :
  33     WidgetGUIEvent(aIsTrusted, aMessage, aWidget, NS_CONTENT_COMMAND_EVENT),
  34     mOnlyEnabledCheck(aOnlyEnabledCheck), mSucceeded(false), mIsEnabled(false)
  35   {
  36   }
  37
  38   // NS_CONTENT_COMMAND_PASTE_TRANSFERABLE
  39   nsCOMPtr<nsITransferable> mTransferable; // [in]
  40
  41   // NS_CONTENT_COMMAND_SCROLL
  42   // for mScroll.mUnit
  43   enum
  44   {
  45     eCmdScrollUnit_Line,
  46     eCmdScrollUnit_Page,
  47     eCmdScrollUnit_Whole
  48   };
  49
  50   struct ScrollInfo
  51   {
  52     ScrollInfo() :
  53       mAmount(0), mUnit(eCmdScrollUnit_Line), mIsHorizontal(false)
  54     {
  55     }
  56
  57     int32_t mAmount;    // [in]
  58     uint8_t mUnit;      // [in]
  59     bool mIsHorizontal; // [in]
  60   } mScroll;
  61
  62   bool mOnlyEnabledCheck; // [in]
  63
  64   bool mSucceeded; // [out]
  65   bool mIsEnabled; // [out]
  66
  67   void AssignContentCommandEventData(const WidgetContentCommandEvent& aEvent,
  68                                      bool aCopyTargets)
  69   {
  70     AssignGUIEventData(aEvent, aCopyTargets);
  71
  72     mScroll = aEvent.mScroll;
  73     mOnlyEnabledCheck = aEvent.mOnlyEnabledCheck;
  74     mSucceeded = aEvent.mSucceeded;
  75     mIsEnabled = aEvent.mIsEnabled;
  76   }
  77 };
  78
  79 /******************************************************************************
  80  * mozilla::WidgetCommandEvent
  81  *
  82  * This sends a command to chrome.  If you want to request what is performed
  83  * in focused content, you should use WidgetContentCommandEvent instead.
  84  *
  85  * XXX Should be |WidgetChromeCommandEvent|?
  86  ******************************************************************************/
  87
  88 class WidgetCommandEvent : public WidgetGUIEvent
  89 {
  90 public:
  91   virtual WidgetCommandEvent* AsCommandEvent() MOZ_OVERRIDE { return this; }
  92
  93   WidgetCommandEvent(bool aIsTrusted, nsIAtom* aEventType,
  94                      nsIAtom* aCommand, nsIWidget* aWidget) :
  95     WidgetGUIEvent(aIsTrusted, NS_USER_DEFINED_EVENT, aWidget,
  96                    NS_COMMAND_EVENT),
  97     command(aCommand)
  98   {
  99     userType = aEventType;
 100   }
 101
 102   nsCOMPtr<nsIAtom> command;
 103
 104   // XXX Not tested by test_assign_event_data.html
 105   void AssignCommandEventData(const WidgetCommandEvent& aEvent,
 106                               bool aCopyTargets)
 107   {
 108     AssignGUIEventData(aEvent, aCopyTargets);
 109
 110     // command must have been initialized with the constructor.
 111   }
 112 };
 113
 114 /******************************************************************************
 115  * mozilla::WidgetPluginEvent
 116  *
 117  * This event delivers only a native event to focused plugin.
 118  ******************************************************************************/
 119
 120 class WidgetPluginEvent : public WidgetGUIEvent
 121 {
 122 public:
 123   virtual WidgetPluginEvent* AsPluginEvent() MOZ_OVERRIDE { return this; }
 124
 125   WidgetPluginEvent(bool aIsTrusted, uint32_t aMessage, nsIWidget* aWidget) :
 126     WidgetGUIEvent(aIsTrusted, aMessage, aWidget, NS_PLUGIN_EVENT),
 127     retargetToFocusedDocument(false)
 128   {
 129   }
 130
 131   // If true, this event needs to be retargeted to focused document.
 132   // Otherwise, never retargeted. Defaults to false.
 133   bool retargetToFocusedDocument;
 134 };
 135
 136 } // namespace mozilla
 137
 138 #endif // mozilla_MiscEvents_h__