The Tor Browser: layout/xul/tree/nsITreeView.idl@6474c204b198 (annotated)

layout/xul/tree/nsITreeView.idl@6474c204b198 (annotated)

layout/xul/tree/nsITreeView.idl

Wed, 31 Dec 2014 06:09:35 +0100

author: Michael Schloh von Bennewitz <michael@schloh.com>
date: Wed, 31 Dec 2014 06:09:35 +0100
changeset 0: 6474c204b198
permissions: -rw-r--r--

Cloned upstream origin tor-browser at tor-browser-31.3.0esr-4.5-1-build1
revision ID fc1c9ff7c1b2defdbc039f12214767608f46423f for hacking purpose.

 /* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
 /* This Source Code Form is subject to the terms of the Mozilla Public
  * License, v. 2.0. If a copy of the MPL was not distributed with this
  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
 #include "nsISupports.idl"
 interface nsITreeBoxObject;
 interface nsITreeSelection;
 interface nsITreeColumn;
 interface nsIDOMDataTransfer;
 [scriptable, uuid(091116f0-0bdc-4b32-b9c8-c8d5a37cb088)]
 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;
   /**
    * A whitespace delimited list of properties.  For each property X the view
    * gives back will cause the pseudoclasses  ::-moz-tree-cell(x),
    * ::-moz-tree-row(x), ::-moz-tree-twisty(x), ::-moz-tree-image(x),
    * ::-moz-tree-cell-text(x).  to be matched on the pseudoelement
    * ::moz-tree-row.
    */
   AString getRowProperties(in long index);
   /**
    * A whitespace delimited list of properties for a given cell.  Each
    * property, x, that the view gives back will cause the pseudoclasses
    *  ::-moz-tree-cell(x), ::-moz-tree-row(x), ::-moz-tree-twisty(x),
    *  ::-moz-tree-image(x), ::-moz-tree-cell-text(x). to be matched on the
    *  cell.
    */
   AString getCellProperties(in long row, in nsITreeColumn col);
   /**
    * Called to get properties to paint a column background.  For shading the sort
    * column, etc.
    */
   AString getColumnProperties(in nsITreeColumn col);
   /**
    * 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 separator.
    * The tree uses 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();
   const short DROP_BEFORE = -1;
   const short DROP_ON = 0;
   const short DROP_AFTER = 1;
   /**
    * 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 when
    * the orientation is not DROP_ON.
    */
   boolean canDrop(in long index, in long orientation, in nsIDOMDataTransfer dataTransfer);
   /**
    * Called when the user drops something on this view. The |orientation| param
    * specifies before/on/after the given |row|.
    */
   void drop(in long row, in long orientation, in nsIDOMDataTransfer dataTransfer);
   /**
    * Methods used by the tree to draw thread lines in the tree.
    * getParentIndex is used to obtain the index of a parent row.
    * If there is no parent row, getParentIndex returns -1.
    */
   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 nsITreeColumn col);
   /**
    * The progress mode for a given cell. This method is only called for
    * columns of type |progressmeter|.
    */
   const short PROGRESS_NORMAL = 1;
   const short PROGRESS_UNDETERMINED = 2;
   const short PROGRESS_NONE = 3;
   long getProgressMode(in long row, in nsITreeColumn col);
   /**
    * The value for a given cell. This method is only called for columns
    * of type other than |text|.
    */
   AString getCellValue(in long row, in nsITreeColumn col);
   /**
    * 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 nsITreeColumn col);
   /**
    * 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 nsITreeColumn col);
   /**
    * Should be called from a XUL onselect handler whenever the selection changes.
    */
   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 nsITreeColumn col);
   /**
    * 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 nsITreeColumn col);
   /**
    * isSelectable is called to ask the view if the cell is selectable.
    * This method is only called if the selection style is |cell| or |text|.
    * XXXvarga shouldn't this be called isCellSelectable?
    */
   boolean isSelectable(in long row, in nsITreeColumn col);
   /**
    * setCellValue is called when the value of the cell has been set by the user.
    * This method is only called for columns of type other than |text|.
    */
   void setCellValue(in long row, in nsITreeColumn col, in AString value);
   /**
    * setCellText is called when the contents of the cell have been edited by the user.
    */
   void setCellText(in long row, in nsITreeColumn col, in AString 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 nsITreeColumn col);
 };
 /**
  * The following interface is not scriptable and MUST NEVER BE MADE scriptable.
  * Native treeviews implement it, and we use this to check whether a treeview
  * is native (and therefore suitable for use by untrusted content).
  */
 [uuid(46c90265-6553-41ae-8d39-7022e7d09145)]
 interface nsINativeTreeView : nsITreeView
 {
   [noscript] void ensureNative();
 };

The Tor Browser / annotate

layout/xul/tree/nsITreeView.idl@6474c204b198 (annotated)

layout/xul/tree/nsITreeView.idl