From: izydorst <izydorst@b7a2c559-68d2-44c3-8de9-860c34a00d81>
Date: Sun, 17 Aug 2003 14:49:46 +0000 (+0000)
Subject: added info about MessageBox function
X-Git-Tag: V2.12.0~1390
X-Git-Url: https://git.sur5r.net/?a=commitdiff_plain;h=03c049794f9fe49d070dcd26240d04af7d5f0310;p=cc65

added info about MessageBox function


git-svn-id: svn://svn.cc65.org/cc65/trunk@2349 b7a2c559-68d2-44c3-8de9-860c34a00d81
---

diff --git a/doc/geos.sgml b/doc/geos.sgml
index bce9033ff..0508fe08f 100644
--- a/doc/geos.sgml
+++ b/doc/geos.sgml
@@ -536,6 +536,20 @@ empty (<tt/NULL/ at the start), then all files with given filetype will be shown
 At present this file selector handles only first 16 files of given type and supports only one
 (current) drive.
 
+<sect3>MessageBox
+<p>
+<tt/char MessageBox (char mode, const char *format, ...)/
+<p>
+This function is a more general one. It works very much like <tt/printf/ in a
+box. The only difference is <tt/mode/ parameter which allows for placing
+default icons (see <tt/gdlgbox.h/ for list of possible <tt/MB_/ values).
+Any too wide text will be clipped to the size of the default window. If mode
+parameter is invalid or equal to <tt/MB_EMPTY/ then the window will be closed
+after a click. Otherwise the user must choose an icon.
+<p>
+Note: use it if you really need (or if you will use it in many places) as
+it adds quite amount of code to your program.
+
 <sect1>Mouse, Sprites and Cursors
 <p>
 You will find here functions related to sprite and mouse drawing and handling.