gecko-dev/xpcom/threads/nsIEventTarget.idl

68 строки
2.4 KiB
Plaintext

/* ***** 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 Mozilla.
*
* The Initial Developer of the Original Code is IBM Corporation.
* Portions created by IBM Corporation are Copyright (C) 2003
* IBM Corporation. All Rights Reserved.
*
* Contributor(s):
* IBM Corp.
*
* 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"
%{C++
#include "plevent.h"
%}
[ptr] native PLEventPtr(PLEvent);
/**
* nsIEventTarget
*
* This interface is used to dispatch events to a particular thread. In many
* cases the event target also supports nsIEventQueue.
*/
[scriptable, uuid(ea99ad5b-cc67-4efb-97c9-2ef620a59f2a)]
interface nsIEventTarget : nsISupports
{
/**
* Method for posting an asynchronous event to the event target. If this
* method succeeds, then the event will be dispatched on the target thread.
*
* @param aEvent
* The event to dispatched.
*/
[noscript] void postEvent(in PLEventPtr aEvent);
/**
* This method returns true if the event target is the current thread.
*/
boolean isOnCurrentThread();
};