Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit e908851a authored by Treehugger Robot's avatar Treehugger Robot Committed by Gerrit Code Review
Browse files

Merge "Fix an off-by-one bug in EditableInputConnection#endBatchEdit() return value"

parents 62981001 1fdc14b8
Loading
Loading
Loading
Loading
+18 −13
Original line number Diff line number Diff line
@@ -770,20 +770,25 @@ public interface InputConnection {
    boolean beginBatchEdit();

    /**
     * Tell the editor that you are done with a batch edit previously
     * initiated with {@link #beginBatchEdit}. This ends the latest
     * batch only.
     *
     * <p><strong>IME authors:</strong> make sure you call this
     * exactly once for each call to {@link #beginBatchEdit}.</p>
     *
     * <p><strong>Editor authors:</strong> please be careful about
     * batch edit nesting. Updates still to be held back until the end
     * of the last batch edit.</p>
     * Tell the editor that you are done with a batch edit previously initiated with
     * {@link #beginBatchEdit()}. This ends the latest batch only.
     *
     * <p><strong>IME authors:</strong> make sure you call this exactly once for each call to
     * {@link #beginBatchEdit()}.</p>
     *
     * <p><strong>Editor authors:</strong> please be careful about batch edit nesting. Updates still
     * to be held back until the end of the last batch edit.  In case you are delegating this API
     * call to the one obtained from
     * {@link android.widget.EditText#onCreateInputConnection(EditorInfo)}, there was an off-by-one
     * that had returned {@code true} when its nested batch edit count becomes {@code 0} as a result
     * of invoking this API.  This bug is fixed in {@link android.os.Build.VERSION_CODES#TIRAMISU}.
     * </p>
     *
     * @return true if there is still a batch edit in progress after closing
     * the latest one (in other words, if the nesting count is > 0), false
     * otherwise or if the input connection is no longer valid.
     * @return For editor authors, you must return {@code true} if a batch edit is still in progress
     *         after closing the latest one (in other words, if the nesting count is still a
     *         positive number). Return {@code false} otherwise.  For IME authors, you will
     *         always receive {@code true} as long as the request was sent to the editor, and
     *         receive {@code false} only if the input connection is no longer valid.
     */
    boolean endBatchEdit();

+1 −1
Original line number Diff line number Diff line
@@ -92,7 +92,7 @@ public class EditableInputConnection extends BaseInputConnection
                // contribution to mTextView's nested batch edit count is zero.
                mTextView.endBatchEdit();
                mBatchEditNesting--;
                return true;
                return mBatchEditNesting > 0;
            }
        }
        return false;