calendar/base/public/calIPrintFormatter.idl
author seabld
Fri, 16 Sep 2011 17:30:15 -0700
branchSEA_COMM70_20110916_RELBRANCH
changeset 8481 70c91f6afb9ca4e55e12b67bef8bc99c31efa61d
parent 372 7c0bfdcda6731e77303f3c47b01736aaa93d5534
child 12286 84ac3c71109811da751f0ef2d72108075938f094
permissions -rw-r--r--
Added tag SEAMONKEY_2_4b3_RELEASE for changeset b7ed5fe0f2b7. CLOSED TREE a=release

/* -*- Mode: IDL; tab-width: 20; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
 *
 * 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 Mozilla Calendar Code.
 *
 * The Initial Developer of the Original Code is
 * Michiel van Leeuwen <mvl@exedo.nl>.
 * Portions created by the Initial Developer are Copyright (C) 2006
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 *
 * Alternatively, the contents of this file may be used under the terms of
 * either the GNU General Public License Version 2 or later (the "GPL"), or
 * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
 * in which case the provisions of the GPL or the LGPL are applicable instead
 * of those above. If you wish to allow use of your version of this file only
 * under the terms of either the GPL or the LGPL, and not to allow others to
 * use your version of this file under the terms of the MPL, indicate your
 * decision by deleting the provisions above and replace them with the notice
 * and other provisions required by the GPL or the LGPL. If you do not delete
 * the provisions above, a recipient may use your version of this file under
 * the terms of any one of the MPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */


#include "nsISupports.idl"

interface calIItemBase;
interface calIDateTime;
interface nsIOutputStream;

[scriptable, uuid(014dea21-90cd-4563-b1bd-13b842a465e0)]
interface calIPrintFormatter : nsISupports
{
  /**
   * The name of this layout. Implementers should make sure this string
   * is localizable, ie uses nsIStringBundle
   */
  readonly attribute AString name;
  
  /**
   * Format the items into the stream, as html code.
   * May assume that all the items are inside the given daterange.
   * The user requested to show all the days in the daterange, so unless
   * there is a special reason, all the days should be shown.
   * aStart and aEnd may be null, in which case the implementation can
   * show the minimal days needed to show all the events. It can skip
   * months without events, for example.
   *
   * @param aStream  the stream to put the html data into
   * @param aStart   the first date that should be printed
   * @param aEnd     the last date that should be printed
   * @param aCount   the number of items being printed
   * @param aItems   the items to print
   * @param aTitle   a title for the HTML page
   */
  void formatToHtml(in nsIOutputStream aStream,
                    in calIDateTime aStart,
                    in calIDateTime aEnd,
                    in unsigned long aCount,
                    [array, size_is(aCount)] in calIItemBase aItems,
                    in AString aTitle);
};