Add a new midend function to reset the tile size to the puzzle's

[sgt-puzzles.git] / devel.but

diff --git a/devel.but b/devel.but
index d2bf2e4dc2fa0de6d2d8232dbfcb6e6811d87e7e..30642ead581af087647a923dec958eda3147099e 100644 (file)
--- a/devel.but
+++ b/devel.but
@@ -2812,6 +2812,22 @@ that \e{and} set the \c{user_size} flag, though!
 The midend relies on the frontend calling \cw{midend_new_game()}
 (\k{midend-new-game}) before calling \cw{midend_size()}.
 
+\H{midend-reset-tilesize} \cw{midend_reset_tilesize()}
+
+\c void midend_reset_tilesize(midend *me);
+
+This function resets the midend's preferred tile size to that of the
+standard puzzle.
+
+As discussed in \k{midend-size}, puzzle resizes are typically
+'sticky', in that once the user has dragged the puzzle to a different
+window size, the resulting tile size will be remembered and used when
+the puzzle configuration changes. If you \e{don't} want that, e.g. if
+you want to provide a command to explicitly reset the puzzle size back
+to its default, then you can call this just before calling
+\cw{midend_size()} (which, in turn, you would probably call with
+\c{user_size} set to \cw{FALSE}).
+
 \H{midend-new-game} \cw{midend_new_game()}
 
 \c void midend_new_game(midend *me);