xpcom/system/nsIXULAppInfo.idl

   1 /* ***** BEGIN LICENSE BLOCK *****
   2  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
   3  *
   4  * The contents of this file are subject to the Mozilla Public License Version
   5  * 1.1 (the "License"); you may not use this file except in compliance with
   6  * the License. You may obtain a copy of the License at
   7  * http://www.mozilla.org/MPL/
   8  *
   9  * Software distributed under the License is distributed on an "AS IS" basis,
  10  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  11  * for the specific language governing rights and limitations under the
  12  * License.
  13  *
  14  * The Original Code is XUL bootstrap code.
  15  *
  16  * The Initial Developer of the Original Code is
  17  * Benjamin Smedberg <benjamin@smedbergs.us>
  18  * Portions created by the Initial Developer are Copyright (C) 2004
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *
  23  * Alternatively, the contents of this file may be used under the terms of
  24  * either the GNU General Public License Version 2 or later (the "GPL"), or
  25  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  26  * in which case the provisions of the GPL or the LGPL are applicable instead
  27  * of those above. If you wish to allow use of your version of this file only
  28  * under the terms of either the GPL or the LGPL, and not to allow others to
  29  * use your version of this file under the terms of the MPL, indicate your
  30  * decision by deleting the provisions above and replace them with the notice
  31  * and other provisions required by the GPL or the LGPL. If you do not delete
  32  * the provisions above, a recipient may use your version of this file under
  33  * the terms of any one of the MPL, the GPL or the LGPL.
  34  *
  35  * ***** END LICENSE BLOCK ***** */
  36
  37 #include "nsISupports.idl"
  38
  39 /**
  40  * A scriptable interface to the nsXULAppAPI structure. See nsXULAppAPI.h for
  41  * a detailed description of each attribute.
  42  *
  43  * @status FROZEN - This interface is frozen for use by embedders and will
  44  *                  not change in the future.
  45  */
  46
  47 [scriptable, uuid(a61ede2a-ef09-11d9-a5ce-001124787b2e)]
  48 interface nsIXULAppInfo : nsISupports
  49 {
  50   /**
  51    * @see nsXREAppData.vendor
  52    * @returns an empty string if nsXREAppData.vendor is not set.
  53    */
  54   readonly attribute ACString vendor;
  55
  56   /**
  57    * @see nsXREAppData.name
  58    */
  59   readonly attribute ACString name;
  60
  61   /**
  62    * @see nsXREAppData.ID
  63    * @returns an empty string if nsXREAppData.ID is not set.
  64    */
  65   readonly attribute ACString ID;
  66
  67   /**
  68    * The version of the XUL application. It is different than the
  69    * version of the XULRunner platform. Be careful about which one you want.
  70    *
  71    * @see nsXREAppData.version
  72    * @returns an empty string if nsXREAppData.version is not set.
  73    */
  74   readonly attribute ACString version;
  75
  76   /**
  77    * The build ID/date of the application. For xulrunner applications,
  78    * this will be different than the build ID of the platform. Be careful
  79    * about which one you want.
  80    */
  81   readonly attribute ACString appBuildID;
  82
  83   /**
  84    * The version of the XULRunner platform.
  85    */
  86   readonly attribute ACString platformVersion;
  87
  88   /**
  89    * The build ID/date of gecko and the XULRunner platform.
  90    */
  91   readonly attribute ACString platformBuildID;
  92 };