3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync/* ***** BEGIN LICENSE BLOCK *****
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Version: MPL 1.1/GPL 2.0/LGPL 2.1
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * The contents of this file are subject to the Mozilla Public License Version
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * 1.1 (the "License"); you may not use this file except in compliance with
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * the License. You may obtain a copy of the License at
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * http://www.mozilla.org/MPL/
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Software distributed under the License is distributed on an "AS IS" basis,
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * for the specific language governing rights and limitations under the
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * License.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * The Original Code is Mozilla Communicator client code.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * The Initial Developer of the Original Code is
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Netscape Communications Corporation.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Portions created by the Initial Developer are Copyright (C) 1998
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * the Initial Developer. All Rights Reserved.
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync *
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * Contributor(s):
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync *
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * Alternatively, the contents of this file may be used under the terms of
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * either of the GNU General Public License Version 2 or later (the "GPL"),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * in which case the provisions of the GPL or the LGPL are applicable instead
930b5f872e89407f445d4000d4e4aaecaa6a0998vboxsync * of those above. If you wish to allow use of your version of this file only
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * under the terms of either the GPL or the LGPL, and not to allow others to
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * use your version of this file under the terms of the MPL, indicate your
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * decision by deleting the provisions above and replace them with the notice
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * and other provisions required by the GPL or the LGPL. If you do not delete
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * the provisions above, a recipient may use your version of this file under
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * the terms of any one of the MPL, the GPL or the LGPL.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync *
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * ***** END LICENSE BLOCK ***** */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#ifndef nsPIEventQueueChain_h__
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define nsPIEventQueueChain_h__
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#include "nsISupports.h"
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync// {8f310040-82a7-11d3-95bc-0060083a0bcf}
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#define NS_IEVENTQUEUECHAIN_IID \
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{ 0x8f310040, 0x82a7, 0x11d3, { 0x95, 0xbc, 0x0, 0x60, 0x8, 0x3a, 0xb, 0xcf } }
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncclass nsIEventQueue;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncclass nsPIEventQueueChain : public nsISupports
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync{
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsyncpublic:
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_DEFINE_STATIC_IID_ACCESSOR(NS_IEVENTQUEUECHAIN_IID);
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Add the given queue as the new youngest member of our chain.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * It will not be addrefed.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param aQueue the queue. must not be null.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return error indication
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD AppendQueue(nsIEventQueue *aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Remove this element from the chain.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return NS_OK
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD Unlink() = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Fetch (and addref) the youngest member of the chain.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param *aQueue the youngest queue. aQueue must not be null.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return error indication
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD GetYoungest(nsIEventQueue **aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync /**
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * Fetch (and addref) the youngest member of the chain which is
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * still accepting events, or at least still contains events in need
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * of processing.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @param *aQueue the youngest such queue. aQueue must not be null.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * *aQueue will be returned null, if no such queue is found.
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync * @return error indication -- can be NS_OK even if *aQueue is 0
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD GetYoungestActive(nsIEventQueue **aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD SetYounger(nsPIEventQueueChain *aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD GetYounger(nsIEventQueue **aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD SetElder(nsPIEventQueueChain *aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync NS_IMETHOD GetElder(nsIEventQueue **aQueue) = 0;
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync};
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync#endif /* nsPIEventQueueChain_h___ */
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync
3194da424708abdd288b28d96892b3a5f3f7df0bvboxsync