← Back to branch summary

~ubuntu-branches/ubuntu/precise/kompozer/precise

« back to all changes in this revision

Viewing changes to mozilla/layout/base/public/nsIPageSequenceFrame.h

  • Committer: Bazaar Package Importer
  • Author(s): Anthony Yarusso
  • Date: 2007-08-27 01:11:03 UTC
  • Revision ID: james.westby@ubuntu.com-20070827011103-2jgf4s6532gqu2ka
Tags: upstream-0.7.10
Import upstream version 0.7.10

Show diffs side-by-side

added added

removed removed

Lines of Context:
mozilla/layout/base/public/nsIPageSequenceFrame.h
 
1
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 
2
/* ***** BEGIN LICENSE BLOCK *****
 
3
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 
4
 *
 
5
 * The contents of this file are subject to the Netscape Public License
 
6
 * Version 1.1 (the "License"); you may not use this file except in
 
7
 * compliance with the License. You may obtain a copy of the License at
 
8
 * http://www.mozilla.org/NPL/
 
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 the GNU General Public License Version 2 or later (the "GPL"), or 
 
26
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 
35
 *
 
36
 * ***** END LICENSE BLOCK ***** */
 
37
#ifndef nsIPageSequenceFrame_h___
 
38
#define nsIPageSequenceFrame_h___
 
39
 
 
40
#include "nsISupports.h"
 
41
#include "nsRect.h"
 
42
 
 
43
class nsIPresContext;
 
44
class nsIPrintSettings;
 
45
 
 
46
// IID for the nsIPageSequenceFrame interface 
 
47
// a6cf90d2-15b3-11d2-932e-00805f8add32
 
48
#define NS_IPAGESEQUENCEFRAME_IID \
 
49
 { 0xa6cf90d2, 0x15b3, 0x11d2,{0x93, 0x2e, 0x00, 0x80, 0x5f, 0x8a, 0xdd, 0x32}}
 
50
 
 
51
//----------------------------------------------------------------------
 
52
 
 
53
/**
 
54
 * Interface for accessing special capabilities of the page sequence frame.
 
55
 *
 
56
 * Today all that exists are member functions for printing.
 
57
 */
 
58
class nsIPageSequenceFrame : public nsISupports {
 
59
public:
 
60
  NS_DEFINE_STATIC_IID_ACCESSOR(NS_IPAGESEQUENCEFRAME_IID)
 
61
 
 
62
  /**
 
63
   * Print the set of pages.
 
64
   *
 
65
   * @param   aPrintOptions options for printing
 
66
   * @param   aStatusCallback interface that the client provides to receive
 
67
   *            progress notifications. Can be NULL
 
68
   * @return  NS_OK if successful
 
69
   *          NS_ERROR_ABORT if the client cancels printing using the callback
 
70
   *            interface
 
71
   *          NS_ERROR_INVALID_ARG if printing a range of pages (not all pages)
 
72
   *            and the start page is greater than the total number of pages
 
73
   *          NS_ERROR_FAILURE if there is an error
 
74
   */
 
75
  NS_IMETHOD StartPrint(nsIPresContext*  aPresContext,
 
76
                        nsIPrintSettings* aPrintOptions,
 
77
                        PRUnichar* aDocTitle,
 
78
                        PRUnichar* aDocURL) = 0;
 
79
  NS_IMETHOD PrintNextPage(nsIPresContext*  aPresContext) = 0;
 
80
  NS_IMETHOD GetCurrentPageNum(PRInt32* aPageNum) = 0;
 
81
  NS_IMETHOD GetNumPages(PRInt32* aNumPages) = 0;
 
82
  NS_IMETHOD IsDoingPrintRange(PRBool* aDoing) = 0;
 
83
  NS_IMETHOD GetPrintRange(PRInt32* aFromPage, PRInt32* aToPage) = 0;
 
84
 
 
85
  NS_IMETHOD SkipPageBegin() = 0;
 
86
  NS_IMETHOD SkipPageEnd() = 0;
 
87
 
 
88
  NS_IMETHOD DoPageEnd(nsIPresContext* aPresContext) = 0;
 
89
  NS_IMETHOD GetPrintThisPage(PRBool* aPrintThisPage) = 0;
 
90
  NS_IMETHOD SetOffset(nscoord aX, nscoord aY) = 0;
 
91
  NS_IMETHOD SuppressHeadersAndFooters(PRBool aDoSup) = 0;
 
92
  NS_IMETHOD SetClipRect(nsIPresContext*  aPresContext, nsRect* aSize) = 0;
 
93
  NS_IMETHOD SetSelectionHeight(nscoord aYOffset, nscoord aHeight) = 0;
 
94
 
 
95
  NS_IMETHOD SetTotalNumPages(PRInt32 aTotal) = 0;
 
96
 
 
97
  // Gets the dead space (the gray area) around the Print Preview Page
 
98
  NS_IMETHOD GetDeadSpaceValue(nscoord* aValue) = 0;
 
99
 
 
100
  // For Shrink To Fit
 
101
  NS_IMETHOD GetSTFPercent(float& aSTFPercent) = 0;
 
102
  
 
103
private:
 
104
  NS_IMETHOD_(nsrefcnt) AddRef(void) = 0;
 
105
  NS_IMETHOD_(nsrefcnt) Release(void) = 0;
 
106
};
 
107
 
 
108
#endif /* nsIPageSequenceFrame_h___ */
 
109
 
 
110