Bug 1048752. Part 5: Reorder API declarations. r=tn

To make it more clear what's going on, make CaretBlinkCallback protected
and reorder the public methods to put the state-changing "API" methods first.

--HG--
extra : rebase_source : fddf0ea4b9269b2d431d0b75c40f99a9140138a1

layout/base/nsCaret.h

@@ -34,9 +34,22 @@ class nsCaret : public nsISelectionListener
     nsresult Init(nsIPresShell *inPresShell);
     void Terminate();
 
-    nsISelection*    GetCaretDOMSelection();
     nsresult SetCaretDOMSelection(nsISelection *inDOMSel);
-
+    nsISelection* GetCaretDOMSelection();
+    /**
+     * Sets whether the caret should only be visible in nodes that are not
+     * user-modify: read-only, or whether it should be visible in all nodes.
+     *
+     * @param aIgnoreUserModify true to have the cursor visible in all nodes,
+     *                          false to have it visible in all nodes except
+     *                          those with user-modify: read-only
+     */
+    void SetIgnoreUserModify(bool aIgnoreUserModify);
+    void CheckCaretDrawingState();
+    /** SetCaretVisible will set the visibility of the caret
+     *  @param inMakeVisible true to show the caret, false to hide it
+     */
+    void SetCaretVisible(bool intMakeVisible);
     /** GetCaretVisible will get the visibility of the caret
      *  This function is virtual so that it can be used by nsCaretAccessible
      *  without linking
@@ -44,17 +57,36 @@ class nsCaret : public nsISelectionListener
      *  @return NS_OK
      */
     virtual nsresult GetCaretVisible(bool *outMakeVisible);
-
-    /** SetCaretVisible will set the visibility of the caret
-     *  @param inMakeVisible true to show the caret, false to hide it
-     */
-    void    SetCaretVisible(bool intMakeVisible);
-
     /** SetCaretReadOnly set the appearance of the caret
      *  @param inMakeReadonly true to show the caret in a 'read only' state,
      *         false to show the caret in normal, editing state
      */
     void SetCaretReadOnly(bool inMakeReadonly);
+    /**
+     * @param aVisibility true if the caret should be visible even when the
+     * selection is not collapsed.
+     */
+    void SetVisibilityDuringSelection(bool aVisibility);
+
+    /** EraseCaret
+     *  this will erase the caret if its drawn and reset drawn status
+     */
+    void EraseCaret();
+    /** UpdateCaretPosition
+     *  Update the caret's current frame and rect, but don't draw yet. This is
+     *  useful for flickerless moving of the caret (e.g., when the frame the
+     *  caret is in reflows and is moved).
+     */
+    void UpdateCaretPosition();
+    /** DrawAtPosition
+     *
+     *  Draw the caret explicitly, at the specified node and offset.
+     *  To avoid drawing glitches, you should call EraseCaret()
+     *  after each call to DrawAtPosition().
+     *
+     *  Note: This call breaks the caret's ability to blink at all.
+     **/
+    nsresult DrawAtPosition(nsIDOMNode* aNode, int32_t aOffset);
 
     /**
      * Gets the position and size of the caret that would be drawn for
@@ -67,24 +99,6 @@ class nsCaret : public nsISelectionListener
     virtual nsIFrame* GetGeometry(nsISelection* aSelection,
                                   nsRect* aRect,
                                   nscoord* aBidiIndicatorSize = nullptr);
-
-    /** EraseCaret
-     *  this will erase the caret if its drawn and reset drawn status
-     */
-    void    EraseCaret();
-
-    void    SetVisibilityDuringSelection(bool aVisibility);
-
-    /** DrawAtPosition
-     *
-     *  Draw the caret explicitly, at the specified node and offset.
-     *  To avoid drawing glitches, you should call EraseCaret()
-     *  after each call to DrawAtPosition().
-     *
-     *  Note: This call breaks the caret's ability to blink at all.
-     **/
-    nsresult    DrawAtPosition(nsIDOMNode* aNode, int32_t aOffset);
-
     /** GetCaretFrame
      *  Get the current frame that the caret should be drawn in. If the caret is
      *  not currently visible (i.e., it is between blinks), then this will
@@ -93,7 +107,6 @@ class nsCaret : public nsISelectionListener
      *  @param aOffset is result of the caret offset in the content.
      */
     nsIFrame* GetCaretFrame(int32_t *aOffset = nullptr);
-
     /** GetCaretRect
      *  Get the current caret rect. Only call this when GetCaretFrame returns
      *  non-null.
@@ -105,13 +118,6 @@ class nsCaret : public nsISelectionListener
       return r;
     }
 
-    /** UpdateCaretPosition
-     *  Update the caret's current frame and rect, but don't draw yet. This is
-     *  useful for flickerless moving of the caret (e.g., when the frame the
-     *  caret is in reflows and is moved).
-     */
-    void      UpdateCaretPosition();
-
     /** PaintCaret
      *  Actually paint the caret onto the given rendering context.
      */
@@ -119,22 +125,10 @@ class nsCaret : public nsISelectionListener
                     nsRenderingContext *aCtx,
                     nsIFrame *aForFrame,
                     const nsPoint &aOffset);
-    /**
-     * Sets whether the caret should only be visible in nodes that are not
-     * user-modify: read-only, or whether it should be visible in all nodes.
-     *
-     * @param aIgnoreUserModify true to have the cursor visible in all nodes,
-     *                          false to have it visible in all nodes except
-     *                          those with user-modify: read-only
-     */
-
-    void SetIgnoreUserModify(bool aIgnoreUserModify);
 
     //nsISelectionListener interface
     NS_DECL_NSISELECTIONLISTENER
 
-    static void   CaretBlinkCallback(nsITimer *aTimer, void *aClosure);
-
     static nsresult GetCaretFrameForNodeOffset(nsFrameSelection* aFrameSelection,
                                                nsIContent* aContentNode,
                                                int32_t aOffset,
@@ -143,11 +137,10 @@ class nsCaret : public nsISelectionListener
                                                nsIFrame** aReturnFrame,
                                                int32_t* aReturnOffset);
 
-    void CheckCaretDrawingState();
-
     size_t SizeOfIncludingThis(mozilla::MallocSizeOf aMallocSizeOf) const;
 
 protected:
+    static void   CaretBlinkCallback(nsITimer *aTimer, void *aClosure);
 
     void          KillTimer();
     nsresult      PrimeTimer();