File: nsAutoRollup.h

package info (click to toggle)
firefox 147.0.2-1
  • links: PTS, VCS
  • area: main
  • in suites: sid
  • size: 4,683,484 kB
  • sloc: cpp: 7,607,246; javascript: 6,533,185; ansic: 3,775,227; python: 1,415,393; xml: 634,561; asm: 438,951; java: 186,241; sh: 62,752; makefile: 18,079; objc: 13,092; perl: 12,808; yacc: 4,583; cs: 3,846; pascal: 3,448; lex: 1,720; ruby: 1,003; php: 436; lisp: 258; awk: 247; sql: 66; sed: 54; csh: 10; exp: 6
file content (54 lines) | stat: -rw-r--r-- 2,032 bytes parent folder | download | duplicates (29)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/* -*- Mode: C++; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
/* 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/. */
#ifndef nsAutoRollup_h__
#define nsAutoRollup_h__

#include "mozilla/Attributes.h"  // for MOZ_RAII
#include "mozilla/StaticPtr.h"   // for StaticRefPtr
#include "nsIContent.h"

namespace mozilla {
namespace widget {

// A situation can occur when a mouse event occurs over a menu label while the
// menu popup is already open. The expected behaviour is to close the popup.
// This happens by calling nsIRollupListener::Rollup before the mouse event is
// processed. However, in cases where the mouse event is not consumed, this
// event will then get targeted at the menu label causing the menu to open
// again. To prevent this, we store in sLastRollup a reference to the popup
// that was closed during the Rollup call, and prevent this popup from
// reopening while processing the mouse event.
// sLastRollup can only be set while an nsAutoRollup is in scope;
// when it goes out of scope sLastRollup is cleared automatically.
// As sLastRollup is static, it can be retrieved by calling
// nsAutoRollup::GetLastRollup.
class MOZ_RAII nsAutoRollup {
 public:
  nsAutoRollup();
  ~nsAutoRollup();

  // Convenience constructor that creates a nsAutoRollup and also sets
  // the last rollup.
  explicit nsAutoRollup(nsIContent* aRollup);

  static void SetLastRollup(nsIContent* aLastRollup);
  // Return the popup that was last rolled up, or null if there isn't one.
  static nsIContent* GetLastRollup();

 private:
  // Whether sLastRollup was clear when this nsAutoRollup
  // was created.
  bool mWasClear;

  // The number of nsAutoRollup instances active.
  static uint32_t sCount;
  // The last rolled up popup.
  static StaticRefPtr<nsIContent> sLastRollup;
};

}  // namespace widget
}  // namespace mozilla

#endif  // nsAutoRollup_h__