| /* |
| * DO NOT EDIT. THIS FILE IS GENERATED FROM e:/builds/tinderbox/XR-Trunk/WINNT_5.2_Depend/mozilla/xpcom/threads/nsITimer.idl |
| */ |
| |
| #ifndef __gen_nsITimer_h__ |
| #define __gen_nsITimer_h__ |
| |
| |
| #ifndef __gen_nsISupports_h__ |
| #include "nsISupports.h" |
| #endif |
| |
| /* For IDL files that don't want to include root IDL files. */ |
| #ifndef NS_NO_VTABLE |
| #define NS_NO_VTABLE |
| #endif |
| class nsIObserver; /* forward declaration */ |
| |
| /** |
| * The signature of the timer callback function passed to initWithFuncCallback. |
| * This is the function that will get called when the timer expires if the |
| * timer is initialized via initWithFuncCallback. |
| * |
| * @param aTimer the timer which has expired |
| * @param aClosure opaque parameter passed to initWithFuncCallback |
| * |
| * Implementers should return the following: |
| * |
| * @return NS_OK |
| * |
| */ |
| class nsITimer; |
| typedef void (*nsTimerCallbackFunc) (nsITimer *aTimer, void *aClosure); |
| class nsITimer; /* forward declaration */ |
| |
| |
| /* starting interface: nsITimerCallback */ |
| #define NS_ITIMERCALLBACK_IID_STR "a796816d-7d47-4348-9ab8-c7aeb3216a7d" |
| |
| #define NS_ITIMERCALLBACK_IID \ |
| {0xa796816d, 0x7d47, 0x4348, \ |
| { 0x9a, 0xb8, 0xc7, 0xae, 0xb3, 0x21, 0x6a, 0x7d }} |
| |
| class NS_NO_VTABLE NS_SCRIPTABLE nsITimerCallback : public nsISupports { |
| public: |
| |
| NS_DECLARE_STATIC_IID_ACCESSOR(NS_ITIMERCALLBACK_IID) |
| |
| /** |
| * @param aTimer the timer which has expired |
| */ |
| /* void notify (in nsITimer timer); */ |
| NS_SCRIPTABLE NS_IMETHOD Notify(nsITimer *timer) = 0; |
| |
| }; |
| |
| NS_DEFINE_STATIC_IID_ACCESSOR(nsITimerCallback, NS_ITIMERCALLBACK_IID) |
| |
| /* Use this macro when declaring classes that implement this interface. */ |
| #define NS_DECL_NSITIMERCALLBACK \ |
| NS_SCRIPTABLE NS_IMETHOD Notify(nsITimer *timer); |
| |
| /* Use this macro to declare functions that forward the behavior of this interface to another object. */ |
| #define NS_FORWARD_NSITIMERCALLBACK(_to) \ |
| NS_SCRIPTABLE NS_IMETHOD Notify(nsITimer *timer) { return _to Notify(timer); } |
| |
| /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */ |
| #define NS_FORWARD_SAFE_NSITIMERCALLBACK(_to) \ |
| NS_SCRIPTABLE NS_IMETHOD Notify(nsITimer *timer) { return !_to ? NS_ERROR_NULL_POINTER : _to->Notify(timer); } |
| |
| #if 0 |
| /* Use the code below as a template for the implementation class for this interface. */ |
| |
| /* Header file */ |
| class nsTimerCallback : public nsITimerCallback |
| { |
| public: |
| NS_DECL_ISUPPORTS |
| NS_DECL_NSITIMERCALLBACK |
| |
| nsTimerCallback(); |
| |
| private: |
| ~nsTimerCallback(); |
| |
| protected: |
| /* additional members */ |
| }; |
| |
| /* Implementation file */ |
| NS_IMPL_ISUPPORTS1(nsTimerCallback, nsITimerCallback) |
| |
| nsTimerCallback::nsTimerCallback() |
| { |
| /* member initializers and constructor code */ |
| } |
| |
| nsTimerCallback::~nsTimerCallback() |
| { |
| /* destructor code */ |
| } |
| |
| /* void notify (in nsITimer timer); */ |
| NS_IMETHODIMP nsTimerCallback::Notify(nsITimer *timer) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* End of implementation class template. */ |
| #endif |
| |
| |
| /* starting interface: nsITimer */ |
| #define NS_ITIMER_IID_STR "436a83fa-b396-11d9-bcfa-00112478d626" |
| |
| #define NS_ITIMER_IID \ |
| {0x436a83fa, 0xb396, 0x11d9, \ |
| { 0xbc, 0xfa, 0x00, 0x11, 0x24, 0x78, 0xd6, 0x26 }} |
| |
| /** |
| * The callback interface for timers. |
| */ |
| class NS_NO_VTABLE NS_SCRIPTABLE nsITimer : public nsISupports { |
| public: |
| |
| NS_DECLARE_STATIC_IID_ACCESSOR(NS_ITIMER_IID) |
| |
| /** |
| * nsITimer instances must be initialized by calling one of the "init" methods |
| * documented below. You may also re-initialize an existing instance with new |
| * delay to avoid the overhead of destroying and creating a timer. It is not |
| * necessary to cancel the timer in that case. |
| */ |
| /** |
| * Type of a timer that fires once only. |
| */ |
| enum { TYPE_ONE_SHOT = 0 }; |
| |
| /** |
| * After firing, a TYPE_REPEATING_SLACK timer is stopped and not restarted |
| * until its callback completes. Specified timer period will be at least |
| * the time between when processing for last firing the callback completes |
| * and when the next firing occurs. |
| * |
| * This is the preferable repeating type for most situations. |
| */ |
| enum { TYPE_REPEATING_SLACK = 1 }; |
| |
| /** |
| * An TYPE_REPEATING_PRECISE repeating timer aims to have constant period |
| * between firings. The processing time for each timer callback should not |
| * influence the timer period. However, if the processing for the last |
| * timer firing could not be completed until just before the next firing |
| * occurs, then you could have two timer notification routines being |
| * executed in quick succession. |
| */ |
| enum { TYPE_REPEATING_PRECISE = 2 }; |
| |
| /** |
| * Initialize a timer that will fire after the said delay. |
| * A user must keep a reference to this timer till it is |
| * is no longer needed or has been cancelled. |
| * |
| * @param aObserver the callback object that observes the |
| * ``timer-callback'' topic with the subject being |
| * the timer itself when the timer fires: |
| * |
| * observe(nsISupports aSubject, => nsITimer |
| * string aTopic, => ``timer-callback'' |
| * wstring data => null |
| * |
| * @param aDelay delay in milliseconds for timer to fire |
| * @param aType timer type per TYPE* consts defined above |
| */ |
| /* void init (in nsIObserver aObserver, in unsigned long aDelay, in unsigned long aType); */ |
| NS_SCRIPTABLE NS_IMETHOD Init(nsIObserver *aObserver, PRUint32 aDelay, PRUint32 aType) = 0; |
| |
| /** |
| * Initialize a timer to fire after the given millisecond interval. |
| * This version takes a function to call and a closure to pass to |
| * that function. |
| * |
| * @param aFunc The function to invoke |
| * @param aClosure An opaque pointer to pass to that function |
| * @param aDelay The millisecond interval |
| * @param aType Timer type per TYPE* consts defined above |
| */ |
| /* [noscript] void initWithFuncCallback (in nsTimerCallbackFunc aCallback, in voidPtr aClosure, in unsigned long aDelay, in unsigned long aType); */ |
| NS_IMETHOD InitWithFuncCallback(nsTimerCallbackFunc aCallback, void * aClosure, PRUint32 aDelay, PRUint32 aType) = 0; |
| |
| /** |
| * Initialize a timer to fire after the given millisecond interval. |
| * This version takes a function to call and a closure to pass to |
| * that function. |
| * |
| * @param aFunc nsITimerCallback interface to call when timer expires |
| * @param aDelay The millisecond interval |
| * @param aType Timer type per TYPE* consts defined above |
| */ |
| /* void initWithCallback (in nsITimerCallback aCallback, in unsigned long aDelay, in unsigned long aType); */ |
| NS_SCRIPTABLE NS_IMETHOD InitWithCallback(nsITimerCallback *aCallback, PRUint32 aDelay, PRUint32 aType) = 0; |
| |
| /** |
| * Cancel the timer. This method works on all types, not just on repeating |
| * timers -- you might want to cancel a TYPE_ONE_SHOT timer, and even reuse |
| * it by re-initializing it (to avoid object destruction and creation costs |
| * by conserving one timer instance). |
| */ |
| /* void cancel (); */ |
| NS_SCRIPTABLE NS_IMETHOD Cancel(void) = 0; |
| |
| /** |
| * The millisecond delay of the timeout |
| */ |
| /* attribute unsigned long delay; */ |
| NS_SCRIPTABLE NS_IMETHOD GetDelay(PRUint32 *aDelay) = 0; |
| NS_SCRIPTABLE NS_IMETHOD SetDelay(PRUint32 aDelay) = 0; |
| |
| /** |
| * The timer type : one shot or repeating |
| */ |
| /* attribute unsigned long type; */ |
| NS_SCRIPTABLE NS_IMETHOD GetType(PRUint32 *aType) = 0; |
| NS_SCRIPTABLE NS_IMETHOD SetType(PRUint32 aType) = 0; |
| |
| /** |
| * The opaque pointer pass to initWithFuncCallback. |
| */ |
| /* [noscript] readonly attribute voidPtr closure; */ |
| NS_IMETHOD GetClosure(void * *aClosure) = 0; |
| |
| /** |
| * The nsITimerCallback object passed to initWithCallback. |
| */ |
| /* readonly attribute nsITimerCallback callback; */ |
| NS_SCRIPTABLE NS_IMETHOD GetCallback(nsITimerCallback * *aCallback) = 0; |
| |
| }; |
| |
| NS_DEFINE_STATIC_IID_ACCESSOR(nsITimer, NS_ITIMER_IID) |
| |
| /* Use this macro when declaring classes that implement this interface. */ |
| #define NS_DECL_NSITIMER \ |
| NS_SCRIPTABLE NS_IMETHOD Init(nsIObserver *aObserver, PRUint32 aDelay, PRUint32 aType); \ |
| NS_IMETHOD InitWithFuncCallback(nsTimerCallbackFunc aCallback, void * aClosure, PRUint32 aDelay, PRUint32 aType); \ |
| NS_SCRIPTABLE NS_IMETHOD InitWithCallback(nsITimerCallback *aCallback, PRUint32 aDelay, PRUint32 aType); \ |
| NS_SCRIPTABLE NS_IMETHOD Cancel(void); \ |
| NS_SCRIPTABLE NS_IMETHOD GetDelay(PRUint32 *aDelay); \ |
| NS_SCRIPTABLE NS_IMETHOD SetDelay(PRUint32 aDelay); \ |
| NS_SCRIPTABLE NS_IMETHOD GetType(PRUint32 *aType); \ |
| NS_SCRIPTABLE NS_IMETHOD SetType(PRUint32 aType); \ |
| NS_IMETHOD GetClosure(void * *aClosure); \ |
| NS_SCRIPTABLE NS_IMETHOD GetCallback(nsITimerCallback * *aCallback); |
| |
| /* Use this macro to declare functions that forward the behavior of this interface to another object. */ |
| #define NS_FORWARD_NSITIMER(_to) \ |
| NS_SCRIPTABLE NS_IMETHOD Init(nsIObserver *aObserver, PRUint32 aDelay, PRUint32 aType) { return _to Init(aObserver, aDelay, aType); } \ |
| NS_IMETHOD InitWithFuncCallback(nsTimerCallbackFunc aCallback, void * aClosure, PRUint32 aDelay, PRUint32 aType) { return _to InitWithFuncCallback(aCallback, aClosure, aDelay, aType); } \ |
| NS_SCRIPTABLE NS_IMETHOD InitWithCallback(nsITimerCallback *aCallback, PRUint32 aDelay, PRUint32 aType) { return _to InitWithCallback(aCallback, aDelay, aType); } \ |
| NS_SCRIPTABLE NS_IMETHOD Cancel(void) { return _to Cancel(); } \ |
| NS_SCRIPTABLE NS_IMETHOD GetDelay(PRUint32 *aDelay) { return _to GetDelay(aDelay); } \ |
| NS_SCRIPTABLE NS_IMETHOD SetDelay(PRUint32 aDelay) { return _to SetDelay(aDelay); } \ |
| NS_SCRIPTABLE NS_IMETHOD GetType(PRUint32 *aType) { return _to GetType(aType); } \ |
| NS_SCRIPTABLE NS_IMETHOD SetType(PRUint32 aType) { return _to SetType(aType); } \ |
| NS_IMETHOD GetClosure(void * *aClosure) { return _to GetClosure(aClosure); } \ |
| NS_SCRIPTABLE NS_IMETHOD GetCallback(nsITimerCallback * *aCallback) { return _to GetCallback(aCallback); } |
| |
| /* Use this macro to declare functions that forward the behavior of this interface to another object in a safe way. */ |
| #define NS_FORWARD_SAFE_NSITIMER(_to) \ |
| NS_SCRIPTABLE NS_IMETHOD Init(nsIObserver *aObserver, PRUint32 aDelay, PRUint32 aType) { return !_to ? NS_ERROR_NULL_POINTER : _to->Init(aObserver, aDelay, aType); } \ |
| NS_IMETHOD InitWithFuncCallback(nsTimerCallbackFunc aCallback, void * aClosure, PRUint32 aDelay, PRUint32 aType) { return !_to ? NS_ERROR_NULL_POINTER : _to->InitWithFuncCallback(aCallback, aClosure, aDelay, aType); } \ |
| NS_SCRIPTABLE NS_IMETHOD InitWithCallback(nsITimerCallback *aCallback, PRUint32 aDelay, PRUint32 aType) { return !_to ? NS_ERROR_NULL_POINTER : _to->InitWithCallback(aCallback, aDelay, aType); } \ |
| NS_SCRIPTABLE NS_IMETHOD Cancel(void) { return !_to ? NS_ERROR_NULL_POINTER : _to->Cancel(); } \ |
| NS_SCRIPTABLE NS_IMETHOD GetDelay(PRUint32 *aDelay) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetDelay(aDelay); } \ |
| NS_SCRIPTABLE NS_IMETHOD SetDelay(PRUint32 aDelay) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetDelay(aDelay); } \ |
| NS_SCRIPTABLE NS_IMETHOD GetType(PRUint32 *aType) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetType(aType); } \ |
| NS_SCRIPTABLE NS_IMETHOD SetType(PRUint32 aType) { return !_to ? NS_ERROR_NULL_POINTER : _to->SetType(aType); } \ |
| NS_IMETHOD GetClosure(void * *aClosure) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetClosure(aClosure); } \ |
| NS_SCRIPTABLE NS_IMETHOD GetCallback(nsITimerCallback * *aCallback) { return !_to ? NS_ERROR_NULL_POINTER : _to->GetCallback(aCallback); } |
| |
| #if 0 |
| /* Use the code below as a template for the implementation class for this interface. */ |
| |
| /* Header file */ |
| class nsTimer : public nsITimer |
| { |
| public: |
| NS_DECL_ISUPPORTS |
| NS_DECL_NSITIMER |
| |
| nsTimer(); |
| |
| private: |
| ~nsTimer(); |
| |
| protected: |
| /* additional members */ |
| }; |
| |
| /* Implementation file */ |
| NS_IMPL_ISUPPORTS1(nsTimer, nsITimer) |
| |
| nsTimer::nsTimer() |
| { |
| /* member initializers and constructor code */ |
| } |
| |
| nsTimer::~nsTimer() |
| { |
| /* destructor code */ |
| } |
| |
| /* void init (in nsIObserver aObserver, in unsigned long aDelay, in unsigned long aType); */ |
| NS_IMETHODIMP nsTimer::Init(nsIObserver *aObserver, PRUint32 aDelay, PRUint32 aType) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* [noscript] void initWithFuncCallback (in nsTimerCallbackFunc aCallback, in voidPtr aClosure, in unsigned long aDelay, in unsigned long aType); */ |
| NS_IMETHODIMP nsTimer::InitWithFuncCallback(nsTimerCallbackFunc aCallback, void * aClosure, PRUint32 aDelay, PRUint32 aType) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* void initWithCallback (in nsITimerCallback aCallback, in unsigned long aDelay, in unsigned long aType); */ |
| NS_IMETHODIMP nsTimer::InitWithCallback(nsITimerCallback *aCallback, PRUint32 aDelay, PRUint32 aType) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* void cancel (); */ |
| NS_IMETHODIMP nsTimer::Cancel() |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* attribute unsigned long delay; */ |
| NS_IMETHODIMP nsTimer::GetDelay(PRUint32 *aDelay) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| NS_IMETHODIMP nsTimer::SetDelay(PRUint32 aDelay) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* attribute unsigned long type; */ |
| NS_IMETHODIMP nsTimer::GetType(PRUint32 *aType) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| NS_IMETHODIMP nsTimer::SetType(PRUint32 aType) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* [noscript] readonly attribute voidPtr closure; */ |
| NS_IMETHODIMP nsTimer::GetClosure(void * *aClosure) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* readonly attribute nsITimerCallback callback; */ |
| NS_IMETHODIMP nsTimer::GetCallback(nsITimerCallback * *aCallback) |
| { |
| return NS_ERROR_NOT_IMPLEMENTED; |
| } |
| |
| /* End of implementation class template. */ |
| #endif |
| |
| #define NS_TIMER_CONTRACTID "@mozilla.org/timer;1" |
| #define NS_TIMER_CALLBACK_TOPIC "timer-callback" |
| |
| #endif /* __gen_nsITimer_h__ */ |