summaryrefslogtreecommitdiffstats
path: root/dom/events/InputEventOptions.h
diff options
context:
space:
mode:
Diffstat (limited to 'dom/events/InputEventOptions.h')
-rw-r--r--dom/events/InputEventOptions.h75
1 files changed, 75 insertions, 0 deletions
diff --git a/dom/events/InputEventOptions.h b/dom/events/InputEventOptions.h
new file mode 100644
index 0000000000..94096d759f
--- /dev/null
+++ b/dom/events/InputEventOptions.h
@@ -0,0 +1,75 @@
+/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* vim: set ts=8 sts=2 et sw=2 tw=80: */
+/* 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_InputEventOptions_h
+#define mozilla_InputEventOptions_h
+
+#include "mozilla/Attributes.h"
+#include "mozilla/RefPtr.h"
+#include "mozilla/TextEvents.h"
+#include "mozilla/dom/DataTransfer.h"
+#include "mozilla/dom/StaticRange.h"
+#include "nsString.h"
+#include "nsTArray.h"
+
+namespace mozilla {
+
+/**
+ * InputEventOptions is used by nsContentUtils::DispatchInputEvent() to specify
+ * some attributes of InputEvent. It would be nice if this was in
+ * nsContentUtils.h, however, it needs to include StaticRange.h for declaring
+ * this. That would cause unnecessary dependency and makes incremental build
+ * slower when you touch StaticRange.h even though most nsContentUtils.h users
+ * don't use it. Therefore, this struct is declared in separated header file
+ * here.
+ */
+struct MOZ_STACK_CLASS InputEventOptions final {
+ enum class NeverCancelable {
+ No,
+ Yes,
+ };
+ InputEventOptions() : mDataTransfer(nullptr), mNeverCancelable(false) {}
+ explicit InputEventOptions(const InputEventOptions& aOther) = delete;
+ InputEventOptions(InputEventOptions&& aOther) = default;
+ explicit InputEventOptions(const nsAString& aData,
+ NeverCancelable aNeverCancelable)
+ : mData(aData),
+ mDataTransfer(nullptr),
+ mNeverCancelable(aNeverCancelable == NeverCancelable::Yes) {}
+ explicit InputEventOptions(dom::DataTransfer* aDataTransfer,
+ NeverCancelable aNeverCancelable)
+ : mDataTransfer(aDataTransfer),
+ mNeverCancelable(aNeverCancelable == NeverCancelable::Yes) {
+ MOZ_ASSERT(mDataTransfer);
+ MOZ_ASSERT(mDataTransfer->IsReadOnly());
+ }
+ InputEventOptions(const nsAString& aData,
+ OwningNonNullStaticRangeArray&& aTargetRanges,
+ NeverCancelable aNeverCancelable)
+ : mData(aData),
+ mDataTransfer(nullptr),
+ mTargetRanges(std::move(aTargetRanges)),
+ mNeverCancelable(aNeverCancelable == NeverCancelable::Yes) {}
+ InputEventOptions(dom::DataTransfer* aDataTransfer,
+ OwningNonNullStaticRangeArray&& aTargetRanges,
+ NeverCancelable aNeverCancelable)
+ : mDataTransfer(aDataTransfer),
+ mTargetRanges(std::move(aTargetRanges)),
+ mNeverCancelable(aNeverCancelable == NeverCancelable::Yes) {
+ MOZ_ASSERT(mDataTransfer);
+ MOZ_ASSERT(mDataTransfer->IsReadOnly());
+ }
+
+ nsString mData;
+ dom::DataTransfer* mDataTransfer;
+ OwningNonNullStaticRangeArray mTargetRanges;
+ // If this is set to true, dispatching event won't be cancelable.
+ bool mNeverCancelable;
+};
+
+} // namespace mozilla
+
+#endif // #ifndef mozilla_InputEventOptions_h