xpcom/system/nsIGConfService.idl

   1 /* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   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 the Mozilla GNOME integration code.
  16  *
  17  * The Initial Developer of the Original Code is
  18  * IBM Corporation.
  19  * Portions created by the Initial Developer are Copyright (C) 2004
  20  * the Initial Developer. All Rights Reserved.
  21  *
  22  * Contributor(s):
  23  *  Brian Ryner <bryner@brianryner.com>
  24  *
  25  * Alternatively, the contents of this file may be used under the terms of
  26  * either the GNU General Public License Version 2 or later (the "GPL"), or
  27  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  28  * in which case the provisions of the GPL or the LGPL are applicable instead
  29  * of those above. If you wish to allow use of your version of this file only
  30  * under the terms of either the GPL or the LGPL, and not to allow others to
  31  * use your version of this file under the terms of the MPL, indicate your
  32  * decision by deleting the provisions above and replace them with the notice
  33  * and other provisions required by the GPL or the LGPL. If you do not delete
  34  * the provisions above, a recipient may use your version of this file under
  35  * the terms of any one of the MPL, the GPL or the LGPL.
  36  *
  37  * ***** END LICENSE BLOCK ***** */
  38
  39 #include "nsISupports.idl"
  40 #include "nsIArray.idl"
  41
  42 [scriptable, uuid(5009acae-6973-48c3-b6d6-52c692cc5d9d)]
  43 interface nsIGConfService : nsISupports
  44 {
  45   /* Basic registry access */
  46   boolean       getBool(in AUTF8String key);
  47   AUTF8String   getString(in AUTF8String key);
  48   long          getInt(in AUTF8String key);
  49   float         getFloat(in AUTF8String key);
  50
  51   /*
  52    * Use this to return any list items in GConf, this will return
  53    * an array of UTF16 nsISupportsString's.
  54    */
  55   nsIArray      getStringList(in AUTF8String key);
  56
  57   void setBool(in AUTF8String key, in boolean value);
  58   void setString(in AUTF8String key, in AUTF8String value);
  59   void setInt(in AUTF8String key, in long value);
  60   void setFloat(in AUTF8String key, in float value);
  61
  62   /*
  63    * Look up the handler for a protocol under the
  64    * /desktop/gnome/url-handlers hierarchy.
  65    */
  66   AUTF8String getAppForProtocol(in AUTF8String scheme, out boolean enabled);
  67
  68   /*
  69    * Check whether the handler for a scheme requires a terminal to run.
  70    */
  71   boolean handlerRequiresTerminal(in AUTF8String scheme);
  72
  73   /*
  74    * Set the handler for a protocol, marking it as enabled.
  75    * This removes any GnomeVFSMimeApp association for the protocol.
  76    */
  77   void   setAppForProtocol(in AUTF8String scheme, in AUTF8String command);
  78 };
  79
  80 %{C++
  81 #define NS_GCONFSERVICE_CONTRACTID "@mozilla.org/gnome-gconf-service;1"
  82 %}