1 : /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
2 : /* ***** BEGIN LICENSE BLOCK *****
3 : * Version: MPL 1.1/GPL 2.0/LGPL 2.1
4 : *
5 : * The contents of this file are subject to the Mozilla Public License Version
6 : * 1.1 (the "License"); you may not use this file except in compliance with
7 : * the License. You may obtain a copy of the License at
8 : * http://www.mozilla.org/MPL/
9 : *
10 : * Software distributed under the License is distributed on an "AS IS" basis,
11 : * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
12 : * for the specific language governing rights and limitations under the
13 : * License.
14 : *
15 : * The Original Code is mozilla.org code.
16 : *
17 : * The Initial Developer of the Original Code is
18 : * Netscape Communications Corporation.
19 : * Portions created by the Initial Developer are Copyright (C) 1998
20 : * the Initial Developer. All Rights Reserved.
21 : *
22 : * Contributor(s):
23 : *
24 : * Alternatively, the contents of this file may be used under the terms of
25 : * either of the GNU General Public License Version 2 or later (the "GPL"),
26 : * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
27 : * in which case the provisions of the GPL or the LGPL are applicable instead
28 : * of those above. If you wish to allow use of your version of this file only
29 : * under the terms of either the GPL or the LGPL, and not to allow others to
30 : * use your version of this file under the terms of the MPL, indicate your
31 : * decision by deleting the provisions above and replace them with the notice
32 : * and other provisions required by the GPL or the LGPL. If you do not delete
33 : * the provisions above, a recipient may use your version of this file under
34 : * the terms of any one of the MPL, the GPL or the LGPL.
35 : *
36 : * ***** END LICENSE BLOCK ***** */
37 : #ifndef nsIPageSequenceFrame_h___
38 : #define nsIPageSequenceFrame_h___
39 :
40 : #include "nsQueryFrame.h"
41 : #include "nsRect.h"
42 :
43 : class nsPresContext;
44 : class nsIPrintSettings;
45 :
46 : /**
47 : * Interface for accessing special capabilities of the page sequence frame.
48 : *
49 : * Today all that exists are member functions for printing.
50 : */
51 : class nsIPageSequenceFrame : public nsQueryFrame
52 0 : {
53 : public:
54 : NS_DECL_QUERYFRAME_TARGET(nsIPageSequenceFrame)
55 :
56 : /**
57 : * Print the set of pages.
58 : *
59 : * @param aPrintOptions options for printing
60 : * @param aStatusCallback interface that the client provides to receive
61 : * progress notifications. Can be NULL
62 : * @return NS_OK if successful
63 : * NS_ERROR_ABORT if the client cancels printing using the callback
64 : * interface
65 : * NS_ERROR_INVALID_ARG if printing a range of pages (not all pages)
66 : * and the start page is greater than the total number of pages
67 : * NS_ERROR_FAILURE if there is an error
68 : */
69 : NS_IMETHOD StartPrint(nsPresContext* aPresContext,
70 : nsIPrintSettings* aPrintOptions,
71 : PRUnichar* aDocTitle,
72 : PRUnichar* aDocURL) = 0;
73 : NS_IMETHOD PrintNextPage() = 0;
74 : NS_IMETHOD GetCurrentPageNum(PRInt32* aPageNum) = 0;
75 : NS_IMETHOD GetNumPages(PRInt32* aNumPages) = 0;
76 : NS_IMETHOD IsDoingPrintRange(bool* aDoing) = 0;
77 : NS_IMETHOD GetPrintRange(PRInt32* aFromPage, PRInt32* aToPage) = 0;
78 :
79 : NS_IMETHOD DoPageEnd() = 0;
80 : NS_IMETHOD SetSelectionHeight(nscoord aYOffset, nscoord aHeight) = 0;
81 :
82 : NS_IMETHOD SetTotalNumPages(PRInt32 aTotal) = 0;
83 :
84 : // For Shrink To Fit
85 : NS_IMETHOD GetSTFPercent(float& aSTFPercent) = 0;
86 : };
87 :
88 : #endif /* nsIPageSequenceFrame_h___ */
89 :
90 :
|