layout/base/nsIFocusEventSuppressor.h

   1 /* -*- Mode: C++; 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 mozilla.org code.
  16  *
  17  * The Initial Developer of the Original Code is Mozilla Foundation.
  18  * Portions created by the Initial Developer are Copyright (C) 2008
  19  * the Initial Developer. All Rights Reserved.
  20  *
  21  * Contributor(s):
  22  *   Olli Pettay <Olli.Pettay@helsinki.fi> (Original Author)
  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 #ifndef nsIFocusEventSuppressor_h___
  39 #define nsIFocusEventSuppressor_h___
  40 #include "nsISupports.h"
  41
  42 typedef void (* nsFocusEventSuppressorCallback)(PRBool aSuppress);
  43
  44 #define NS_NSIFOCUSEVENTSUPPRESSORSERVICE_IID \
  45   { 0x8aae5cee, 0x59ab, 0x42d4, \
  46     { 0xa3, 0x76, 0xbf, 0x63, 0x54, 0x04, 0xc7, 0x98 } }
  47
  48 class nsIFocusEventSuppressorService : public nsISupports
  49 {
  50 public:
  51   NS_DECLARE_STATIC_IID_ACCESSOR(NS_NSIFOCUSEVENTSUPPRESSORSERVICE_IID)
  52   virtual void AddObserverCallback(nsFocusEventSuppressorCallback aCallback) = 0;
  53   virtual void Suppress() = 0;
  54   virtual void Unsuppress() = 0;
  55 };
  56
  57 NS_DEFINE_STATIC_IID_ACCESSOR(nsIFocusEventSuppressorService,
  58                               NS_NSIFOCUSEVENTSUPPRESSORSERVICE_IID)
  59
  60 #if defined(_IMPL_NS_LAYOUT) || defined(NS_STATIC_FOCUS_SUPPRESSOR)
  61 void NS_SuppressFocusEvent();
  62 void NS_UnsuppressFocusEvent();
  63 void NS_AddFocusSuppressorCallback(nsFocusEventSuppressorCallback aCallback);
  64 void NS_ShutdownFocusSuppressor();
  65 #endif
  66
  67 #define NS_NSIFOCUSEVENTSUPPRESSORSERVICE_CID \
  68   { 0x35b2656c, 0x4102, 0x4bc1, \
  69     { 0x87, 0x6a, 0xfd, 0x6c, 0xb8, 0x30, 0x78, 0x7b } }
  70
  71 #define NS_NSIFOCUSEVENTSUPPRESSORSERVICE_CONTRACTID \
  72   "@mozilla.org/focus-event-suppressor-service;1"
  73
  74 #endif