gecko/widget/MiscEvents.h

183 lines
5.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_MiscEvents_h__
#define mozilla_MiscEvents_h__
#include <stdint.h>
#include "mozilla/BasicEvents.h"
#include "nsCOMPtr.h"
#include "nsIAtom.h"
#include "nsITransferable.h"
namespace mozilla {
/******************************************************************************
* mozilla::WidgetContentCommandEvent
******************************************************************************/
class WidgetContentCommandEvent : public WidgetGUIEvent
{
public:
virtual WidgetContentCommandEvent* AsContentCommandEvent() override
{
return this;
}
WidgetContentCommandEvent(bool aIsTrusted, EventMessage aMessage,
nsIWidget* aWidget,
bool aOnlyEnabledCheck = false)
: WidgetGUIEvent(aIsTrusted, aMessage, aWidget, eContentCommandEventClass)
, mOnlyEnabledCheck(aOnlyEnabledCheck)
, mSucceeded(false)
, mIsEnabled(false)
{
}
virtual WidgetEvent* Duplicate() const override
{
// This event isn't an internal event of any DOM event.
NS_ASSERTION(!IsAllowedToDispatchDOMEvent(),
"WidgetQueryContentEvent needs to support Duplicate()");
MOZ_CRASH("WidgetQueryContentEvent doesn't support Duplicate()");
return nullptr;
}
// eContentCommandPasteTransferable
nsCOMPtr<nsITransferable> mTransferable; // [in]
// eContentCommandScroll
// for mScroll.mUnit
enum
{
eCmdScrollUnit_Line,
eCmdScrollUnit_Page,
eCmdScrollUnit_Whole
};
struct ScrollInfo
{
ScrollInfo() :
mAmount(0), mUnit(eCmdScrollUnit_Line), mIsHorizontal(false)
{
}
int32_t mAmount; // [in]
uint8_t mUnit; // [in]
bool mIsHorizontal; // [in]
} mScroll;
bool mOnlyEnabledCheck; // [in]
bool mSucceeded; // [out]
bool mIsEnabled; // [out]
void AssignContentCommandEventData(const WidgetContentCommandEvent& aEvent,
bool aCopyTargets)
{
AssignGUIEventData(aEvent, aCopyTargets);
mScroll = aEvent.mScroll;
mOnlyEnabledCheck = aEvent.mOnlyEnabledCheck;
mSucceeded = aEvent.mSucceeded;
mIsEnabled = aEvent.mIsEnabled;
}
};
/******************************************************************************
* mozilla::WidgetCommandEvent
*
* This sends a command to chrome. If you want to request what is performed
* in focused content, you should use WidgetContentCommandEvent instead.
*
* XXX Should be |WidgetChromeCommandEvent|?
******************************************************************************/
class WidgetCommandEvent : public WidgetGUIEvent
{
public:
virtual WidgetCommandEvent* AsCommandEvent() override { return this; }
WidgetCommandEvent(bool aIsTrusted, nsIAtom* aEventType,
nsIAtom* aCommand, nsIWidget* aWidget)
: WidgetGUIEvent(aIsTrusted, eUnidentifiedEvent, aWidget,
eCommandEventClass)
, command(aCommand)
{
userType = aEventType;
}
virtual WidgetEvent* Duplicate() const override
{
MOZ_ASSERT(mClass == eCommandEventClass,
"Duplicate() must be overridden by sub class");
// Not copying widget, it is a weak reference.
WidgetCommandEvent* result =
new WidgetCommandEvent(false, userType, command, nullptr);
result->AssignCommandEventData(*this, true);
result->mFlags = mFlags;
return result;
}
nsCOMPtr<nsIAtom> command;
// XXX Not tested by test_assign_event_data.html
void AssignCommandEventData(const WidgetCommandEvent& aEvent,
bool aCopyTargets)
{
AssignGUIEventData(aEvent, aCopyTargets);
// command must have been initialized with the constructor.
}
};
/******************************************************************************
* mozilla::WidgetPluginEvent
*
* This event delivers only a native event to focused plugin.
******************************************************************************/
class WidgetPluginEvent : public WidgetGUIEvent
{
public:
virtual WidgetPluginEvent* AsPluginEvent() override { return this; }
WidgetPluginEvent(bool aIsTrusted, EventMessage aMessage, nsIWidget* aWidget)
: WidgetGUIEvent(aIsTrusted, aMessage, aWidget, ePluginEventClass)
, retargetToFocusedDocument(false)
{
}
virtual WidgetEvent* Duplicate() const override
{
// NOTE: PluginEvent has to be dispatched to nsIFrame::HandleEvent().
// So, this event needs to support Duplicate().
MOZ_ASSERT(mClass == ePluginEventClass,
"Duplicate() must be overridden by sub class");
// Not copying widget, it is a weak reference.
WidgetPluginEvent* result = new WidgetPluginEvent(false, mMessage, nullptr);
result->AssignPluginEventData(*this, true);
result->mFlags = mFlags;
return result;
}
// If true, this event needs to be retargeted to focused document.
// Otherwise, never retargeted. Defaults to false.
bool retargetToFocusedDocument;
void AssignPluginEventData(const WidgetPluginEvent& aEvent,
bool aCopyTargets)
{
AssignGUIEventData(aEvent, aCopyTargets);
retargetToFocusedDocument = aEvent.retargetToFocusedDocument;
}
};
} // namespace mozilla
#endif // mozilla_MiscEvents_h__