From 95f07fd405cd72822faef1a0e0bffe953a8856df Mon Sep 17 00:00:00 2001
From: Johannes Schickel
Date: Sun, 24 Nov 2013 00:20:29 +0100
Subject: GUI: Document EditableWidget::getEditRect.

---
 gui/widgets/editable.h | 5 +++++
 1 file changed, 5 insertions(+)

(limited to 'gui')

diff --git a/gui/widgets/editable.h b/gui/widgets/editable.h
index 4a18d5e689..63a1942311 100644
--- a/gui/widgets/editable.h
+++ b/gui/widgets/editable.h
@@ -78,6 +78,11 @@ protected:
 	virtual void startEditMode() = 0;
 	virtual void endEditMode() = 0;
 	virtual void abortEditMode() = 0;
+	/**
+	 * The area where text input is being made. This should exactly match the
+	 * rect with which the actual edit string is drawn otherwise nasty
+	 * graphics glitches when redrawing the caret can occur.
+	 */
 	virtual Common::Rect getEditRect() const = 0;
 	virtual int getCaretOffset() const;
 	void drawCaret(bool erase);
-- 
cgit v1.2.3