Bug 1016184 part 1 - Correct documentation in nsCaret.h. r=ehsan

This commit is contained in:
Ting-Yu Lin 2014-07-14 23:18:00 +02:00
parent 73b88d19fd
commit 5d656ae7f4

View File

@ -46,8 +46,8 @@ class nsCaret : public nsISelectionListener
/** GetCaretVisible will get the visibility of the caret /** GetCaretVisible will get the visibility of the caret
* This function is virtual so that it can be used by nsCaretAccessible * This function is virtual so that it can be used by nsCaretAccessible
* without linking * without linking
* @param inMakeVisible true it is shown, false it is hidden * @param outMakeVisible true if it is shown, false if it is hidden
* @return false if and only if inMakeVisible is null, otherwise true * @return NS_OK
*/ */
virtual nsresult GetCaretVisible(bool *outMakeVisible); virtual nsresult GetCaretVisible(bool *outMakeVisible);
@ -58,13 +58,13 @@ class nsCaret : public nsISelectionListener
/** SetCaretReadOnly set the appearance of the caret /** SetCaretReadOnly set the appearance of the caret
* @param inMakeReadonly true to show the caret in a 'read only' state, * @param inMakeReadonly true to show the caret in a 'read only' state,
* false to show the caret in normal, editing state * false to show the caret in normal, editing state
*/ */
void SetCaretReadOnly(bool inMakeReadonly); void SetCaretReadOnly(bool inMakeReadonly);
/** GetCaretReadOnly get the appearance of the caret /** GetCaretReadOnly get the appearance of the caret
* @return true if the caret is in 'read only' state, otherwise, * @return true if the caret is in 'read only' state, otherwise,
* returns false * returns false
*/ */
bool GetCaretReadOnly() bool GetCaretReadOnly()
{ {
@ -232,13 +232,13 @@ protected:
uint32_t mBlinkRate; // time for one cyle (on then off), in milliseconds uint32_t mBlinkRate; // time for one cyle (on then off), in milliseconds
nscoord mCaretWidthCSSPx; // caret width in CSS pixels nscoord mCaretWidthCSSPx; // caret width in CSS pixels
float mCaretAspectRatio; // caret width/height aspect ratio float mCaretAspectRatio; // caret width/height aspect ratio
bool mVisible; // is the caret blinking bool mVisible; // is the caret blinking
bool mDrawn; // Denotes when the caret is physically drawn on the screen. bool mDrawn; // Denotes when the caret is physically drawn on the screen.
bool mPendingDraw; // True when the last on-state draw was suppressed. bool mPendingDraw; // True when the last on-state draw was suppressed.
bool mReadOnly; // it the caret in readonly state (draws differently) bool mReadOnly; // it the caret in readonly state (draws differently)
bool mShowDuringSelection; // show when text is selected bool mShowDuringSelection; // show when text is selected
bool mIgnoreUserModify; bool mIgnoreUserModify;