/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** BEGIN LICENSE BLOCK *****
 * Version: NPL 1.1/GPL 2.0/LGPL 2.1
 *
 * The contents of this file are subject to the Netscape 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/NPL/
 *
 * 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.org code.
 *
 * The Initial Developer of the Original Code is 
 * Netscape Communications Corporation.
 * Portions created by the Initial Developer are Copyright (C) 1998
 * the Initial Developer. All Rights Reserved.
 *
 * Contributor(s):
 * Original Author: David W. Hyatt (hyatt@netscape.com)
 *
 * 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 NPL, 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 NPL, the GPL or the LGPL.
 *
 * ***** END LICENSE BLOCK ***** */

#include "nsITreeBoxObject.idl"
#include "nsISupportsArray.idl"
#include "domstubs.idl"

interface nsITreeSelection;

[scriptable, uuid(58A53734-1837-4f30-9BFD-EE58F63CA049)]
interface nsITreeView : nsISupports
{
  /** 
   * The total number of rows in the tree (including the offscreen rows).
   */
  readonly attribute long rowCount;

  /**
   * The selection for this view.
   */
  attribute nsITreeSelection selection;

  /** 
   * An atomized list of properties for a given row.  Each property, x, that
   * the view gives back will cause the pseudoclass :moz-tree-row-x
   * to be matched on the pseudoelement ::moz-tree-row.
   */
  void getRowProperties(in long index, in nsISupportsArray properties);

  /** 
   * An atomized list of properties for a given cell.  Each property, x, that
   * the view gives back will cause the pseudoclass :moz-tree-cell-x
   * to be matched on the ::moz-tree-cell pseudoelement.
   */
  void getCellProperties(in long row, in wstring colID, in nsISupportsArray properties);
  
  /** 
   * Called to get properties to paint a column background.  For shading the sort
   * column, etc.
   */
  void getColumnProperties(in wstring colID, in nsIDOMElement colElt, in nsISupportsArray properties);

  /** 
   * Methods that can be used to test whether or not a twisty should be drawn,
   * and if so, whether an open or closed twisty should be used.
   */
  boolean isContainer(in long index);
  boolean isContainerOpen(in long index);
  boolean isContainerEmpty(in long index);
 
  /** 
   * isSeparator is used to determine if the row at index is a separator.
   * A value of true will result in the tree drawing a horizontal line.
   * The tree uses the border properties on the ::moz-tree-separator
   * pseudoclass to draw the separator.
   */
  boolean isSeparator(in long index);

  /**
   * Specifies if there is currently a sort on any column. Used mostly by dragdrop
   * to affect drop feedback.
   */
  boolean isSorted();
  
  /**
   * Methods used by the drag feedback code to determine if a drag is allowable at
   * the current location. To get the behavior where drops are only allowed on
   * items, such as the mailNews folder pane, always return false from |canDropBeforeAfter()|.
   */
  boolean canDropOn (in long index);
  boolean canDropBeforeAfter (in long index, in boolean before);
  
  /**
   * Called when the user drops something on this view. The |orientation| param
   * specifies before/on/after the given |row|.
   */
  const short inDropBefore = 0;
  const short inDropOn = 1;
  const short inDropAfter = 2;
  void drop(in long row, in long orientation); 
  
  /** 
   * Methods used by the tree to draw vertical lines in the tree.
   * GetParentIndex is used to obtain the index of a parent row.
   */
  long getParentIndex(in long rowIndex);

  /** 
   * HasNextSibling is used to determine if the row at rowIndex has a nextSibling
   * that occurs *after* the index specified by afterIndex.  Code that is forced
   * to march down the view looking at levels can optimize the march by starting
   * at afterIndex+1.
   */
  boolean hasNextSibling(in long rowIndex, in long afterIndex);

  /** 
   * The level is an integer value that represents
   * the level of indentation.  It is multiplied by the width specified in the 
   * :moz-tree-indentation pseudoelement to compute the exact indendation.
   */
  long getLevel(in long index);

  /** 
   * The image path for a given cell. For defining an icon for a cell.
   * If the empty string is returned, the :moz-tree-image pseudoelement
   * will be used.
   */
  AString getImageSrc(in long row, in wstring colID);

  /**
   * The progress mode for a given cell. This method is only called for
   * columns of type |progressmeter|.
   */
  const short progressNormal = 1;
  const short progressUndetermined = 2;
  const short progressNone = 3;
  long getProgressMode(in long row, in wstring colID);

  /** 
   * The value for a given cell. This method is only called for columns
   * of type other than |text|.
   */
  AString getCellValue(in long row, in wstring colID);

  /** 
   * The text for a given cell.  If a column consists only of an image, then
   * the empty string is returned.  
   */
  AString getCellText(in long row, in wstring colID);

  /**
   * Called during initialization to link the view to the front end box object.
   */
  void setTree(in nsITreeBoxObject tree);
  
  /** 
   * Called on the view when an item is opened or closed.
   */
  void toggleOpenState(in long index);

  /**
   * Called on the view when a header is clicked.
   */
  void cycleHeader(in wstring colID, in nsIDOMElement elt);

  /** 
   * Should be called from a XUL onselect handler whenever the selection changes.
   * XXX Should this be done automatically?
   */
  void selectionChanged();

  /** 
   * Called on the view when a cell in a non-selectable cycling column (e.g., unread/flag/etc.) is clicked.
   */
  void cycleCell(in long row, in wstring colID);
  
  /** 
   * isEditable is called to ask the view if the cell contents are editable.  
   * A value of true will result in the tree popping up a text field when 
   * the user tries to inline edit the cell.
   */
  boolean isEditable(in long row, in wstring colID);

  /** 
   * setCellText is called when the contents of the cell have been edited by the user.
   */   
  void setCellText(in long row, in wstring colID, in wstring value);

  /** 
   * A command API that can be used to invoke commands on the selection.  The tree
   * will automatically invoke this method when certain keys are pressed.  For example,
   * when the DEL key is pressed, performAction will be called with the "delete" string.
   */
  void performAction(in wstring action);

  /** 
   * A command API that can be used to invoke commands on a specific row.
   */
  void performActionOnRow(in wstring action, in long row);

  /** 
   * A command API that can be used to invoke commands on a specific cell.
   */
  void performActionOnCell(in wstring action, in long row, in wstring colID);
};

%{C++
// Initializer,
%}

