Bug 1225701 - Update comments in AccessibleCaret files. r=mtseng
authorTing-Yu Lin <tlin@mozilla.com>
Wed, 18 Nov 2015 11:44:00 +0800
changeset 273078 bc9e3945f94e3fc92b493346a3d7222dc8a04ab7
parent 273077 23e1d8fdd1f0609a31701e5d7d76012313b171c4
child 273079 ccb27d336e71839d10d08f9bd850da4c7da382c7
push id29693
push usercbook@mozilla.com
push dateWed, 18 Nov 2015 13:50:33 +0000
treeherdermozilla-central@1d6155d7e6c9 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersmtseng
bugs1225701
milestone45.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1225701 - Update comments in AccessibleCaret files. r=mtseng DONTBUILD NPOTB
layout/base/AccessibleCaret.h
layout/base/AccessibleCaretEventHub.h
layout/base/AccessibleCaretManager.h
--- a/layout/base/AccessibleCaret.h
+++ b/layout/base/AccessibleCaret.h
@@ -32,16 +32,18 @@ namespace mozilla {
 //
 // All the rect or point are relative to root frame except being specified
 // explicitly.
 //
 // None of the methods in AccessibleCaret will flush layout or style. To ensure
 // that SetPosition() works correctly, the caller must make sure the layout is
 // up to date.
 //
+// Please see the wiki page for more information.
+// https://wiki.mozilla.org/Copy_n_Paste
 class AccessibleCaret
 {
 public:
   explicit AccessibleCaret(nsIPresShell* aPresShell);
   virtual ~AccessibleCaret();
 
   // This enumeration representing the visibility and visual style of an
   // AccessibleCaret.
--- a/layout/base/AccessibleCaretEventHub.h
+++ b/layout/base/AccessibleCaretEventHub.h
@@ -42,24 +42,29 @@ class WidgetTouchEvent;
 // We separate AccessibleCaretEventHub from AccessibleCaretManager to make the
 // state transitions in AccessibleCaretEventHub testable. We put (nearly) all
 // the operations involving PresShell, Selection, and AccessibleCaret
 // manipulation in AccessibleCaretManager so that we can mock methods in
 // AccessibleCaretManager in gtest. We test the correctness of the state
 // transitions by giving events, callbacks, and the return values by mocked
 // methods of AccessibleCaretEventHub. See TestAccessibleCaretEventHub.cpp.
 //
-// Besides dealing with real events, AccessibleCaretEventHub also synthesizes
-// fake events such as scroll-end or long-tap providing APZ is not in use.
+// Besides dealing with real events, AccessibleCaretEventHub could also
+// synthesize fake long-tap events and inject those events to itself on the
+// platform lacks eMouseLongTap. Turn on this preference
+// "layout.accessiblecaret.use_long_tap_injector" for the fake long-tap events.
 //
 // State transition diagram:
 // http://hg.mozilla.org/mozilla-central/raw-file/default/layout/base/doc/AccessibleCaretEventHubStates.png
 // Source code of the diagram:
 // http://hg.mozilla.org/mozilla-central/file/default/layout/base/doc/AccessibleCaretEventHubStates.dot
 //
+// Please see the wiki page for more information.
+// https://wiki.mozilla.org/Copy_n_Paste
+//
 class AccessibleCaretEventHub : public nsIReflowObserver,
                                 public nsIScrollObserver,
                                 public nsISelectionListener,
                                 public nsSupportsWeakReference
 {
 public:
   explicit AccessibleCaretEventHub(nsIPresShell* aPresShell);
   void Init();
--- a/layout/base/AccessibleCaretManager.h
+++ b/layout/base/AccessibleCaretManager.h
@@ -36,16 +36,19 @@ class Selection;
 // relies on AccessibleCaretEventHub to call its public methods to do the work.
 // All codes needed to interact with PresShell, Selection, and AccessibleCaret
 // should be written in AccessibleCaretManager.
 //
 // None the public methods in AccessibleCaretManager will flush layout or style
 // prior to performing its task. The caller must ensure the layout is up to
 // date.
 //
+// Please see the wiki page for more information.
+// https://wiki.mozilla.org/Copy_n_Paste
+//
 class AccessibleCaretManager
 {
 public:
   explicit AccessibleCaretManager(nsIPresShell* aPresShell);
   virtual ~AccessibleCaretManager();
 
   // The aPoint in the following public methods should be relative to root
   // frame.