gecko/layout/xul/base/src/nsRepeatService.h

84 lines
2.8 KiB
C++

/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* ***** 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.org code.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1998
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
*
* Alternatively, the contents of this file may be used under the terms of
* either of 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 ***** */
//
// nsRepeatService
//
#ifndef nsRepeatService_h__
#define nsRepeatService_h__
#include "nsCOMPtr.h"
#include "nsITimer.h"
class nsITimer;
class nsRepeatService : public nsITimerCallback
{
public:
typedef void (* Callback)(void* aData);
NS_DECL_NSITIMERCALLBACK
// Start dispatching timer events to the callback. There is no memory
// management of aData here; it is the caller's responsibility to call
// Stop() before aData's memory is released.
void Start(Callback aCallback, void* aData);
// Stop dispatching timer events to the callback. If the repeat service
// is not currently configured with the given callback and data, this
// is just ignored.
void Stop(Callback aCallback, void* aData);
static nsRepeatService* GetInstance();
static void Shutdown();
NS_DECL_ISUPPORTS
virtual ~nsRepeatService();
protected:
nsRepeatService();
private:
Callback mCallback;
void* mCallbackData;
nsCOMPtr<nsITimer> mRepeatTimer;
static nsRepeatService* gInstance;
}; // class nsRepeatService
#endif