summaryrefslogtreecommitdiffstats
path: root/widget/nsIDeviceContextSpec.h
diff options
context:
space:
mode:
Diffstat (limited to 'widget/nsIDeviceContextSpec.h')
-rw-r--r--widget/nsIDeviceContextSpec.h85
1 files changed, 85 insertions, 0 deletions
diff --git a/widget/nsIDeviceContextSpec.h b/widget/nsIDeviceContextSpec.h
new file mode 100644
index 000000000..fc0fd2c12
--- /dev/null
+++ b/widget/nsIDeviceContextSpec.h
@@ -0,0 +1,85 @@
+/* -*- 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 nsIDeviceContextSpec_h___
+#define nsIDeviceContextSpec_h___
+
+#include "nsISupports.h"
+
+class nsIWidget;
+class nsIPrintSettings;
+
+namespace mozilla {
+namespace gfx{
+class DrawEventRecorder;
+class PrintTarget;
+}
+}
+
+#define NS_IDEVICE_CONTEXT_SPEC_IID \
+{ 0xf407cfba, 0xbe28, 0x46c9, \
+ { 0x8a, 0xba, 0x04, 0x2d, 0xae, 0xbb, 0x4f, 0x23 } }
+
+class nsIDeviceContextSpec : public nsISupports
+{
+public:
+ typedef mozilla::gfx::PrintTarget PrintTarget;
+
+ NS_DECLARE_STATIC_IID_ACCESSOR(NS_IDEVICE_CONTEXT_SPEC_IID)
+
+ /**
+ * Initialize the device context spec.
+ * @param aWidget A widget a dialog can be hosted in
+ * @param aPrintSettings Print settings for the print operation
+ * @param aIsPrintPreview True if creating Spec for PrintPreview
+ * @return NS_OK or a suitable error code.
+ */
+ NS_IMETHOD Init(nsIWidget *aWidget,
+ nsIPrintSettings* aPrintSettings,
+ bool aIsPrintPreview) = 0;
+
+ virtual already_AddRefed<PrintTarget> MakePrintTarget() = 0;
+
+ /**
+ * If required override to return a recorder to record the print.
+ *
+ * @param aDrawEventRecorder out param for the recorder to use
+ * @return NS_OK or a suitable error code
+ */
+ NS_IMETHOD GetDrawEventRecorder(mozilla::gfx::DrawEventRecorder** aDrawEventRecorder)
+ {
+ MOZ_ASSERT(aDrawEventRecorder);
+ *aDrawEventRecorder = nullptr;
+ return NS_OK;
+ }
+
+ /**
+ * Override to return something other than the default.
+ *
+ * @return DPI for printing.
+ */
+ virtual float GetDPI() { return 72.0f; }
+
+ /**
+ * Override to return something other than the default.
+ *
+ * @return the printing scale to be applied to the context for printing.
+ */
+ virtual float GetPrintingScale() { return 1.0f; }
+
+ NS_IMETHOD BeginDocument(const nsAString& aTitle,
+ const nsAString& aPrintToFileName,
+ int32_t aStartPage,
+ int32_t aEndPage) = 0;
+
+ NS_IMETHOD EndDocument() = 0;
+ NS_IMETHOD AbortDocument() { return EndDocument(); }
+ NS_IMETHOD BeginPage() = 0;
+ NS_IMETHOD EndPage() = 0;
+};
+
+NS_DEFINE_STATIC_IID_ACCESSOR(nsIDeviceContextSpec,
+ NS_IDEVICE_CONTEXT_SPEC_IID)
+#endif