summaryrefslogtreecommitdiffstats
path: root/image/IProgressObserver.h
diff options
context:
space:
mode:
authorMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
committerMatt A. Tobin <mattatobin@localhost.localdomain>2018-02-02 04:16:08 -0500
commit5f8de423f190bbb79a62f804151bc24824fa32d8 (patch)
tree10027f336435511475e392454359edea8e25895d /image/IProgressObserver.h
parent49ee0794b5d912db1f95dce6eb52d781dc210db5 (diff)
downloadUXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.gz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.lz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.tar.xz
UXP-5f8de423f190bbb79a62f804151bc24824fa32d8.zip
Add m-esr52 at 52.6.0
Diffstat (limited to 'image/IProgressObserver.h')
-rw-r--r--image/IProgressObserver.h58
1 files changed, 58 insertions, 0 deletions
diff --git a/image/IProgressObserver.h b/image/IProgressObserver.h
new file mode 100644
index 000000000..ba2f1e9ac
--- /dev/null
+++ b/image/IProgressObserver.h
@@ -0,0 +1,58 @@
+/* -*- 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_image_IProgressObserver_h
+#define mozilla_image_IProgressObserver_h
+
+#include "mozilla/WeakPtr.h"
+#include "nsISupports.h"
+#include "nsRect.h"
+
+namespace mozilla {
+namespace image {
+
+/**
+ * An interface for observing changes to image state, as reported by
+ * ProgressTracker.
+ *
+ * This is the ImageLib-internal version of imgINotificationObserver,
+ * essentially, with implementation details that code outside of ImageLib
+ * shouldn't see.
+ *
+ * XXX(seth): It's preferable to avoid adding anything to this interface if
+ * possible. In the long term, it would be ideal to get to a place where we can
+ * just use the imgINotificationObserver interface internally as well.
+ */
+class IProgressObserver : public SupportsWeakPtr<IProgressObserver>
+{
+public:
+ MOZ_DECLARE_WEAKREFERENCE_TYPENAME(IProgressObserver)
+
+ // Subclasses may or may not be XPCOM classes, so we just require that they
+ // implement AddRef and Release.
+ NS_IMETHOD_(MozExternalRefCountType) AddRef(void) = 0;
+ NS_IMETHOD_(MozExternalRefCountType) Release(void) = 0;
+
+ // imgINotificationObserver methods:
+ virtual void Notify(int32_t aType, const nsIntRect* aRect = nullptr) = 0;
+ virtual void OnLoadComplete(bool aLastPart) = 0;
+
+ // imgIOnloadBlocker methods:
+ virtual void BlockOnload() = 0;
+ virtual void UnblockOnload() = 0;
+
+ // Other, internal-only methods:
+ virtual void SetHasImage() = 0;
+ virtual bool NotificationsDeferred() const = 0;
+ virtual void SetNotificationsDeferred(bool aDeferNotifications) = 0;
+
+protected:
+ virtual ~IProgressObserver() { }
+};
+
+} // namespace image
+} // namespace mozilla
+
+#endif // mozilla_image_IProgressObserver_h