/* ***** 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 Verbosio File Search Service.
 *
 * The Initial Developer of the Original Code is
 * Alexander J. Vincent <ajvincent@gmail.com>.
 * Portions created by the Initial Developer are Copyright (C) 2007
 * 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"

[scriptable, uuid(f448066b-5db3-47ca-bcfb-cafb235d8130)]
interface xeIFileSearchResult : nsISupports
{
  /**
   * The local file path to the matched file.
   */
  readonly attribute ACString path;

  /**
   * Get the line numbers for a the result's content matches as an array.
   */
  void getLineNumbers(out PRUint32 count,
                      [retval, array, size_is(count)] out PRUint32 lineNumbers);

  /**
   * Get a source code line for a given line number which matched.
   *
   * @param aLineNumber The line number to look the line up with.
   *
   * @return String with the source code line.
   */
  ACString getLine(in PRUint32 aLineNumber);

  /**
   * Set a source code line for a given line number which matched.
   *
   * @param aLineNumber The line number to look the line up with.
   *
   * @return String with the source code line.
   */
  void setLine(in PRUint32 aLineNumber, in ACString aLine);

  /**
   * Get the index of the search service's criteria which this result matched.
   */
  readonly attribute PRInt32 criteriaIndex;

  /**
   * Set the index of the search service's criteria which this result matched.
   *
   * @param aIndex The index to set.
   */
  void setCriteriaIndex(in PRInt32 aIndex);
};
