content/xul/templates/public/nsIXULSortService.idl

   1 /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
   2 /* ***** BEGIN LICENSE BLOCK *****
   3  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   4  *
   5  * The contents of this file are subject to the Mozilla Public License Version
   6  * 1.1 (the "License"); you may not use this file except in compliance with
   7  * the License. You may obtain a copy of the License at
   8  * http://www.mozilla.org/MPL/
   9  *
  10  * Software distributed under the License is distributed on an "AS IS" basis,
  11  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12  * for the specific language governing rights and limitations under the
  13  * License.
  14  *
  15  * The Original Code is mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * Netscape Communications Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 1998
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *
  24  * Alternatively, the contents of this file may be used under the terms of
  25  * either of the GNU General Public License Version 2 or later (the "GPL"),
  26  * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  27  * in which case the provisions of the GPL or the LGPL are applicable instead
  28  * of those above. If you wish to allow use of your version of this file only
  29  * under the terms of either the GPL or the LGPL, and not to allow others to
  30  * use your version of this file under the terms of the MPL, indicate your
  31  * decision by deleting the provisions above and replace them with the notice
  32  * and other provisions required by the GPL or the LGPL. If you do not delete
  33  * the provisions above, a recipient may use your version of this file under
  34  * the terms of any one of the MPL, the GPL or the LGPL.
  35  *
  36  * ***** END LICENSE BLOCK ***** */
  37
  38 #include "nsISupports.idl"
  39
  40 interface nsIDOMNode;
  41
  42 /**
  43  * A service used to sort the contents of a XUL widget.
  44  */
  45 [scriptable, uuid(F29270C8-3BE5-4046-9B57-945A84DFF132)]
  46 interface nsIXULSortService : nsISupports
  47 {
  48     /**
  49      * Sort the contents of the widget containing <code>aNode</code>
  50      * using <code>aSortKey</code> as the comparison key, and
  51      * <code>aSortDirection</code> as the direction.
  52      *
  53      * @param aNode A node in the XUL widget whose children are to be sorted.
  54      * @param aSortKey The value to be used as the comparison key.
  55      * @param aSortDirection May be either <b>natural</b> to return
  56      * the contents to their natural (unsorted) order,
  57      * <b>ascending</b> to sort the contents in ascending order, or
  58      * <b>descending</b> to sort the contents in descending order.
  59      */
  60     void sort(in nsIDOMNode aNode,
  61               in AString aSortKey,
  62               in AString aSortDirection);
  63 };
  64
  65 %{C++
  66 nsresult
  67 NS_NewXULSortService(nsIXULSortService **result);
  68 %}