embedding/browser/webBrowser/nsIPrintPreviewNavigation.idl

   1 /* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
   2  *
   3  * ***** BEGIN LICENSE BLOCK *****
   4  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   5  *
   6  * The contents of this file are subject to the Mozilla Public License Version
   7  * 1.1 (the "License"); you may not use this file except in compliance with
   8  * the License. You may obtain a copy of the License at
   9  * http://www.mozilla.org/MPL/
  10  *
  11  * Software distributed under the License is distributed on an "AS IS" basis,
  12  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  13  * for the specific language governing rights and limitations under the
  14  * License.
  15  *
  16  * The Original Code is the Mozilla browser.
  17  *
  18  * The Initial Developer of the Original Code is
  19  * Netscape Communications, Inc.
  20  * Portions created by the Initial Developer are Copyright (C) 2001
  21  * the Initial Developer. All Rights Reserved.
  22  *
  23  * Contributor(s):
  24  *   Don Cone <dcone@netscape.com>
  25  *
  26  * Alternatively, the contents of this file may be used under the terms of
  27  * either the GNU General Public License Version 2 or later (the "GPL"), or
  28  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  29  * in which case the provisions of the GPL or the LGPL are applicable instead
  30  * of those above. If you wish to allow use of your version of this file only
  31  * under the terms of either the GPL or the LGPL, and not to allow others to
  32  * use your version of this file under the terms of the MPL, indicate your
  33  * decision by deleting the provisions above and replace them with the notice
  34  * and other provisions required by the GPL or the LGPL. If you do not delete
  35  * the provisions above, a recipient may use your version of this file under
  36  * the terms of any one of the MPL, the GPL or the LGPL.
  37  *
  38  * ***** END LICENSE BLOCK ***** */
  39
  40 #include "nsISupports.idl"
  41
  42
  43 /**
  44  * The nsIPrintPreviewNavigation
  45  */
  46 [scriptable, uuid(8148E3F1-2E8B-11d5-A86C-00105A183419)]
  47 interface nsIPrintPreviewNavigation  : nsISupports
  48 {
  49
  50   readonly attribute long pageCount;
  51
  52
  53   /**
  54    * Preview the next Page
  55    *
  56    * Return - PR_TRUE if success
  57    */
  58   boolean       nextPage();
  59
  60   /**
  61    * Preview the previous Page
  62    *
  63    * Return - PR_TRUE if success
  64    */
  65   boolean       previousPage();
  66
  67   /**
  68    * Go to a page to preview
  69    *
  70    * aPageNumber - Page to go preview
  71    * Return - PR_TRUE if success
  72    */
  73   boolean       goToPage(unsigned long aPageNumber);
  74
  75
  76   /**
  77    * Skip pages
  78    *
  79    * aNumPages - number of pages to skip including the current page. Neg. goes back
  80    * Return - true if success
  81    */
  82   boolean       skipPages(long aNumPages);
  83
  84
  85 };