gecko-dev/layout/xul/nsRepeatService.h
Daniel Holbert 680815cd6e Bug 1412346 part 5: (automated patch) Switch a bunch of C++ files in layout to use our standard mode lines. r=jfkthame
This patch was generated automatically by the "modeline.py" script, available
here: https://github.com/amccreight/moz-source-tools/blob/master/modeline.py

For every file that is modified in this patch, the changes are as follows:
 (1) The patch changes the file to use the exact C++ mode lines from the
     Mozilla coding style guide, available here:
https://developer.mozilla.org/en-US/docs/Mozilla/Developer_guide/Coding_Style#Mode_Line

 (2) The patch deletes any blank lines between the mode line & the MPL
     boilerplate comment.

 (3) If the file previously had the mode lines and MPL boilerplate in a
     single contiguous C++ comment, then the patch splits them into
     separate C++ comments, to match the boilerplate in the coding style.

MozReview-Commit-ID: EuRsDue63tK

--HG--
extra : rebase_source : 3356d4b80ff6213935192e87cdbc9103fec6084c
2017-10-27 10:33:53 -07:00

69 lines
1.9 KiB
C++

/* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
//
// nsRepeatService
//
#ifndef nsRepeatService_h__
#define nsRepeatService_h__
#include "nsCOMPtr.h"
#include "nsITimer.h"
#define INITAL_REPEAT_DELAY 250
#ifdef XP_MACOSX
#define REPEAT_DELAY 25
#else
#define REPEAT_DELAY 50
#endif
class nsIDocument;
class nsITimer;
class nsRepeatService final
{
public:
typedef void (* Callback)(void* aData);
~nsRepeatService();
// 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.
//
// aCallbackName is the label of the callback, used to pass to
// InitWithNamedCallbackFunc.
//
// aDocument is used to get the event target in Start(). We need an event
// target to init mRepeatTimer.
void Start(Callback aCallback, void* aCallbackData,
nsIDocument* aDocument, const nsACString& aCallbackName,
uint32_t aInitialDelay = INITAL_REPEAT_DELAY);
// 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();
protected:
nsRepeatService();
private:
// helper function to initialize callback function to mRepeatTimer
void InitTimerCallback(uint32_t aInitialDelay);
Callback mCallback;
void* mCallbackData;
nsCString mCallbackName;
nsCOMPtr<nsITimer> mRepeatTimer;
}; // class nsRepeatService
#endif