notgne2/tuxpaint-pencil-sharpener
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improving commentary for text_label_tool_enter()

Browse source
This commit is contained in:
Bill Kendrick 2024-12-25 10:15:14 -08:00
parent 79bc5b2df4
commit 9103b783ce
1 changed files with 12 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

15
src/tuxpaint.c
View file

@ -32912,14 +32912,23 @@ void maybe_redraw_eraser_xor(void)
/**
* Record an undo buffer snapshot, blit the current line of Text or Label
* tool text onto the * canvas, play the "carriage return" sound effect,
* and mark the image as unsaved.
* tool text onto the canvas, play the "carriage return" sound effect,
* position the cursor down a line (or to the very bottom of the canvas),
* and mark the current drawing as "unsaved".
*
* This happens when the user presses the [Enter]/[Return] key on
* a physical keyboard, clicks it in the on-screen keyboard, or
* a carriage return is part of some pasted clipboard text.
*
* FIXME: Params
* If the cursor would surpass the bottom of the screen
* (based on `font_height`), then this function returns true/1,
* indicating the situation; this is used when the carriage return
* occurs due to clipboard text being pasted, so that process can
* be aborted.
*
* @param int font_height -- [line] height of the current font
* @return int -- whether or not the cursor would be too far
* down the canvas' height
*/
static int text_label_tool_enter(int font_height)
{