summaryrefslogtreecommitdiffstats
path: root/layout/generic/nsIPageSequenceFrame.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 /layout/generic/nsIPageSequenceFrame.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 'layout/generic/nsIPageSequenceFrame.h')
-rw-r--r--layout/generic/nsIPageSequenceFrame.h62
1 files changed, 62 insertions, 0 deletions
diff --git a/layout/generic/nsIPageSequenceFrame.h b/layout/generic/nsIPageSequenceFrame.h
new file mode 100644
index 000000000..2359288fd
--- /dev/null
+++ b/layout/generic/nsIPageSequenceFrame.h
@@ -0,0 +1,62 @@
+/* -*- 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 nsIPageSequenceFrame_h___
+#define nsIPageSequenceFrame_h___
+
+#include "nsQueryFrame.h"
+#include "nsCoord.h"
+
+class nsPresContext;
+class nsIPrintSettings;
+class nsITimerCallback;
+
+/**
+ * Interface for accessing special capabilities of the page sequence frame.
+ *
+ * Today all that exists are member functions for printing.
+ */
+class nsIPageSequenceFrame : public nsQueryFrame
+{
+public:
+ NS_DECL_QUERYFRAME_TARGET(nsIPageSequenceFrame)
+
+ /**
+ * Print the set of pages.
+ *
+ * @param aPrintOptions options for printing
+ * @param aStatusCallback interface that the client provides to receive
+ * progress notifications. Can be nullptr
+ * @return NS_OK if successful
+ * NS_ERROR_ABORT if the client cancels printing using the callback
+ * interface
+ * NS_ERROR_INVALID_ARG if printing a range of pages (not all pages)
+ * and the start page is greater than the total number of pages
+ * NS_ERROR_FAILURE if there is an error
+ */
+ NS_IMETHOD StartPrint(nsPresContext* aPresContext,
+ nsIPrintSettings* aPrintOptions,
+ const nsAString& aDocTitle,
+ const nsAString& aDocURL) = 0;
+
+ NS_IMETHOD PrePrintNextPage(nsITimerCallback* aCallback, bool* aDone) = 0;
+ NS_IMETHOD PrintNextPage() = 0;
+ NS_IMETHOD ResetPrintCanvasList() = 0;
+ NS_IMETHOD GetCurrentPageNum(int32_t* aPageNum) = 0;
+ NS_IMETHOD GetNumPages(int32_t* aNumPages) = 0;
+ NS_IMETHOD IsDoingPrintRange(bool* aDoing) = 0;
+ NS_IMETHOD GetPrintRange(int32_t* aFromPage, int32_t* aToPage) = 0;
+
+ NS_IMETHOD DoPageEnd() = 0;
+ NS_IMETHOD SetSelectionHeight(nscoord aYOffset, nscoord aHeight) = 0;
+
+ NS_IMETHOD SetTotalNumPages(int32_t aTotal) = 0;
+
+ // For Shrink To Fit
+ NS_IMETHOD GetSTFPercent(float& aSTFPercent) = 0;
+};
+
+#endif /* nsIPageSequenceFrame_h___ */
+
+