~ubuntu-branches/ubuntu/gutsy/virtualbox-ose/gutsy

« back to all changes in this revision

Viewing changes to src/libs/xpcom18a4/xpcom/threads/nsPIEventQueueChain.h

  • Committer: Bazaar Package Importer
  • Author(s): Steve Kowalik
  • Date: 2007-09-08 16:44:58 UTC
  • Revision ID: james.westby@ubuntu.com-20070908164458-wao29470vqtr8ksy
Tags: upstream-1.5.0-dfsg2
ImportĀ upstreamĀ versionĀ 1.5.0-dfsg2

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
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 Communicator client code.
 
16
 *
 
17
 * The Initial Developer of the Original Code is
 
18
 * Netscape Communications Corporation.
 
19
 * Portions created by the Initial Developer are Copyright (C) 1998
 
20
 * the Initial Developer. All Rights Reserved.
 
21
 *
 
22
 * Contributor(s):
 
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 nsPIEventQueueChain_h__
 
39
#define nsPIEventQueueChain_h__
 
40
 
 
41
#include "nsISupports.h"
 
42
 
 
43
// {8f310040-82a7-11d3-95bc-0060083a0bcf}
 
44
#define NS_IEVENTQUEUECHAIN_IID \
 
45
{ 0x8f310040, 0x82a7, 0x11d3, { 0x95, 0xbc, 0x0, 0x60, 0x8, 0x3a, 0xb, 0xcf } }
 
46
 
 
47
class nsIEventQueue;
 
48
 
 
49
class nsPIEventQueueChain : public nsISupports
 
50
{
 
51
public:
 
52
    NS_DEFINE_STATIC_IID_ACCESSOR(NS_IEVENTQUEUECHAIN_IID);
 
53
 
 
54
    /**
 
55
     * Add the given queue as the new youngest member of our chain.
 
56
     * It will not be addrefed.
 
57
     * @param aQueue the queue. must not be null.
 
58
     * @return error indication
 
59
     */
 
60
    NS_IMETHOD AppendQueue(nsIEventQueue *aQueue) = 0;
 
61
 
 
62
    /**
 
63
     * Remove this element from the chain.
 
64
     * @return NS_OK
 
65
     */
 
66
    NS_IMETHOD Unlink() = 0;
 
67
 
 
68
    /**
 
69
     * Fetch (and addref) the youngest member of the chain.
 
70
     * @param *aQueue the youngest queue. aQueue must not be null.
 
71
     * @return error indication
 
72
     */
 
73
    NS_IMETHOD GetYoungest(nsIEventQueue **aQueue) = 0;
 
74
 
 
75
    /**
 
76
     * Fetch (and addref) the youngest member of the chain which is
 
77
     * still accepting events, or at least still contains events in need
 
78
     * of processing.
 
79
     * @param *aQueue the youngest such queue. aQueue must not be null.
 
80
     *        *aQueue will be returned null, if no such queue is found.
 
81
     * @return error indication -- can be NS_OK even if *aQueue is 0
 
82
     */
 
83
    NS_IMETHOD GetYoungestActive(nsIEventQueue **aQueue) = 0;
 
84
 
 
85
    NS_IMETHOD SetYounger(nsPIEventQueueChain *aQueue) = 0;
 
86
    NS_IMETHOD GetYounger(nsIEventQueue **aQueue) = 0;
 
87
 
 
88
    NS_IMETHOD SetElder(nsPIEventQueueChain *aQueue) = 0;
 
89
    NS_IMETHOD GetElder(nsIEventQueue **aQueue) = 0;
 
90
};
 
91
 
 
92
#endif /* nsPIEventQueueChain_h___ */
 
93