Bug 1284825 part.1 Clean up nsMenuBarListener.h and make each specific event handler protected r?enndeakin draft
authorMasayuki Nakano <masayuki@d-toybox.com>
Mon, 11 Jul 2016 16:22:37 +0900
changeset 453912 7d826deb76e8e7c1c62d539c0d404902f9375f20
parent 453911 7d4efe769b54f35f41aa64429ef6a76aaecf3320
child 453913 0f3d5a3daa88c9dfba82abbbdd5a718bfc05dafa
push id39762
push usermasayuki@d-toybox.com
push dateMon, 26 Dec 2016 10:38:02 +0000
reviewersenndeakin
bugs1284825
milestone53.0a1
Bug 1284825 part.1 Clean up nsMenuBarListener.h and make each specific event handler protected r?enndeakin MozReview-Commit-ID: 1h9npIXCKiI
layout/xul/nsMenuBarListener.h
--- a/layout/xul/nsMenuBarListener.h
+++ b/layout/xul/nsMenuBarListener.h
@@ -1,74 +1,88 @@
 /* -*- 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 nsMenuBarListener_h__
-#define nsMenuBarListener_h__
+#ifndef nsMenuBarListener_h
+#define nsMenuBarListener_h
 
 #include "mozilla/Attributes.h"
 #include "mozilla/EventForwards.h"
 #include "nsIDOMEventListener.h"
 
 // X.h defines KeyPress
 #ifdef KeyPress
 #undef KeyPress
 #endif
 
 class nsMenuBarFrame;
 class nsIDOMKeyEvent;
 
-/** editor Implementation of the DragListener interface
+/**
+ * EventListener implementation for menubar.
  */
 class nsMenuBarListener final : public nsIDOMEventListener
 {
 public:
-  /** default constructor
-   */
   explicit nsMenuBarListener(nsMenuBarFrame* aMenuBar);
 
+  NS_DECL_ISUPPORTS
+
+  /**
+   * nsIDOMEventListener interface method.
+   */
+  NS_IMETHOD HandleEvent(nsIDOMEvent* aEvent) override;
+
+  /**
+   * When mMenuBarFrame is being destroyed, this should be called.
+   */
+  void OnDestroyMenuBarFrame();
+
   static void InitializeStatics();
-   
-  NS_IMETHOD HandleEvent(nsIDOMEvent* aEvent) override;
-  
+
+  /**
+   * GetMenuAccessKey() returns keyCode value of a modifier key which is
+   * used for accesskey.  Returns 0 if the platform doesn't support access key.
+   */
+  static nsresult GetMenuAccessKey(int32_t* aAccessKey);
+
+  /**
+   * IsAccessKeyPressed() returns true if the modifier state of aEvent matches
+   * the modifier state of access key.
+   */
+  static bool IsAccessKeyPressed(nsIDOMKeyEvent* aEvent);
+
+protected:
+  virtual ~nsMenuBarListener();
+
   nsresult KeyUp(nsIDOMEvent* aMouseEvent);
   nsresult KeyDown(nsIDOMEvent* aMouseEvent);
   nsresult KeyPress(nsIDOMEvent* aMouseEvent);
   nsresult Blur(nsIDOMEvent* aEvent);
   nsresult MouseDown(nsIDOMEvent* aMouseEvent);
   nsresult Fullscreen(nsIDOMEvent* aEvent);
 
-  static nsresult GetMenuAccessKey(int32_t* aAccessKey);
-  
-  NS_DECL_ISUPPORTS
-
-  static bool IsAccessKeyPressed(nsIDOMKeyEvent* event);
-
-  void OnDestroyMenuBarFrame();
-
-protected:
-  /** default destructor
-   */
-  virtual ~nsMenuBarListener();
-
   static void InitAccessKey();
 
   static mozilla::Modifiers GetModifiersForAccessKey(nsIDOMKeyEvent* event);
 
   // This should only be called by the nsMenuBarListener during event dispatch,
   // thus ensuring that this doesn't get destroyed during the process.
   void ToggleMenuActiveState();
 
   bool Destroyed() const { return !mMenuBarFrame; }
 
-  nsMenuBarFrame* mMenuBarFrame; // The menu bar object.
+  // The menu bar object.
+  nsMenuBarFrame* mMenuBarFrame;
   // Whether or not the ALT key is currently down.
   bool mAccessKeyDown;
   // Whether or not the ALT key down is canceled by other action.
   bool mAccessKeyDownCanceled;
-  static bool mAccessKeyFocuses; // Does the access key by itself focus the menubar?
-  static int32_t mAccessKey;     // See nsIDOMKeyEvent.h for sample values
-  static mozilla::Modifiers mAccessKeyMask;// Modifier mask for the access key
+  // Does the access key by itself focus the menubar?
+  static bool mAccessKeyFocuses;
+  // See nsIDOMKeyEvent.h for sample values.
+  static int32_t mAccessKey;
+  // Modifier mask for the access key.
+  static mozilla::Modifiers mAccessKeyMask;
 };
 
-
-#endif
+#endif // #ifndef nsMenuBarListener_h