gecko-dev/embedding/browser/webBrowser/nsIPrintPreviewNavigation.idl

/* -*- Mode: IDL; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 2 -*-
 *
 * The contents of this file are subject to the Mozilla Public
 * License Version 1.1 (the "License"); you may not use this file
 * except in compliance with the License. You may obtain a copy of
 * the License at http://www.mozilla.org/MPL/
 * 
 * Software distributed under the License is distributed on an "AS
 * IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or
 * implied. See the License for the specific language governing
 * rights and limitations under the License.
 * 
 * The Original Code is the Mozilla browser.
 * 
 * The Initial Developer of the Original Code is Netscape
 * Communications, Inc.  Portions created by Netscape are
 * Copyright (C) 2001, Mozilla.  All Rights Reserved.
 * 
 * Contributor(s):
 *   Don Cone <dcone@netscape.com>
 */

#include "nsISupports.idl"


/**
 * The nsIPrintPreviewNavigation
 */
[scriptable, uuid(8148E3F1-2E8B-11d5-A86C-00105A183419)]
interface nsIPrintPreviewNavigation  : nsISupports
{

  readonly attribute long pageCount;


  /**
   * Preview the next Page
   *
   * Return - PR_TRUE if success
   */
  boolean	NextPage();
  
  /**
   * Preview the previous Page
   *
   * Return - PR_TRUE if success
   */
  boolean	PreviousPage();

  /**
   * Go to a page to preview
   *
   * aPageNumber - Page to go preview
   * Return - PR_TRUE if success
   */
  boolean	GoToPage(unsigned long aPageNumber);


  /**
   * Skip pages
   *
   * aNumPages - number of pages to skip including the current page. Neg. goes back
   * Return - true if success
   */
  boolean	SkipPages(long aNumPages);


  /**
   * PageCount
   *
   * Return - Number of pages for preview session
   */
  unsigned long PageCount();



};