Elm entry: Add a warning to the textblock_get docs.

Thanks to Jihoon Kim for spotting this potential pitfall.

SVN revision: 65288
This commit is contained in:
Tom Hacohen 2011-11-16 09:09:32 +00:00
parent c6d30ee9da
commit 329ae9f1f7
1 changed files with 6 additions and 0 deletions

View File

@ -11122,6 +11122,12 @@ extern "C" {
* functions; The former will either not work at all, or break the correct
* functionality.
*
* IMPORTANT: Many functions may change (i.e delete and create a new one)
* the internal textblock object. Do NOT cache the returned object, and try
* not to mix calls on this object with regular elm_entry calls (which may
* change the internal textblock object). This applies to all cursors
* returned from textblock calls, and all the other derivative values.
*
* @param obj The entry object
* @return The textblock object.
*/