From 2b5dae761ba1727cb483f4bae334a1b25f222e18 Mon Sep 17 00:00:00 2001
From: Simon Howard
Date: Sat, 7 Mar 2009 00:24:45 +0000
Subject: Add documentation for high-level textscreen functions.

Subversion-branch: /trunk/chocolate-doom
Subversion-revision: 1449
---
 textscreen/txt_window.h | 95 ++++++++++++++++++++++++++++++++++++++++++++++---
 1 file changed, 91 insertions(+), 4 deletions(-)

(limited to 'textscreen/txt_window.h')

diff --git a/textscreen/txt_window.h b/textscreen/txt_window.h
index 3659ed29..38c7a128 100644
--- a/textscreen/txt_window.h
+++ b/textscreen/txt_window.h
@@ -22,6 +22,25 @@
 #ifndef TXT_WINDOW_H
 #define TXT_WINDOW_H
 
+/**
+ * A window.
+ *
+ * A window contains widgets, and may also be treated as a table
+ * containing a single column.
+ *
+ * Windows can be created using @ref TXT_NewWindow and closed using
+ * @ref TXT_CloseWindow.  When a window is closed, it emits the
+ * "closed" signal.
+ *
+ * In addition to the widgets within a window, windows also have
+ * a "tray" area at their bottom containing window action widgets.
+ * These widgets allow keyboard shortcuts to trigger common actions.
+ * Each window has three slots for keyboard shortcuts. By default,
+ * the left slot contains an action to close the window when the
+ * escape button is pressed, while the right slot contains an
+ * action to activate the currently-selected widget.
+ */
+
 typedef struct txt_window_s txt_window_t;
 
 #include "txt_widget.h" 
@@ -68,18 +87,86 @@ struct txt_window_s
     unsigned int window_w, window_h;
 };
 
+/**
+ * Open a new window.
+ *
+ * @param title        Title to display in the titlebar of the new window.
+ * @return             Pointer to a new @ref txt_window_t structure
+ *                     representing the new window.
+ */
+
 txt_window_t *TXT_NewWindow(char *title);
+
+/**
+ * Close a window.
+ *
+ * @param window       Tine window to close.
+ */
+
 void TXT_CloseWindow(txt_window_t *window);
-void TXT_SetWindowPosition(txt_window_t *window, 
+
+/**
+ * Set the position of a window on the screen.
+ *
+ * The window is specified as coordinates relative to a predefined
+ * position on the screen (eg. center of the screen, top left of the
+ * screen, etc).
+ *
+ * @param window       The window.
+ * @param horiz_align  Horizontal position on the screen to which the
+ *                     coordinates are relative (left side, right side
+ *                     or center).
+ * @param vert_align   Vertical position on the screen to which the
+ *                     coordinates are relative (top, bottom or center).
+ * @param x            X coordinate (horizonal axis) for window position.
+ * @param y            Y coordinate (vertical axis) for window position.
+ */
+
+void TXT_SetWindowPosition(txt_window_t *window,
                            txt_horiz_align_t horiz_align,
                            txt_vert_align_t vert_align,
                            int x, int y);
+
+/**
+ * Set a window action for a given window.
+ *
+ * Each window can have up to three window actions, which provide
+ * keyboard shortcuts that can be used within a given window.
+ *
+ * @param window      The window.
+ * @param position    The window action slot to set (left, center or right).
+ * @param action      The window action widget.  If this is NULL, any
+ *                    current window action in the given slot is removed.
+ */
+
 void TXT_SetWindowAction(txt_window_t *window, txt_horiz_align_t position, 
                          txt_window_action_t *action);
-void TXT_SetKeyListener(txt_window_t *window, 
-                        TxtWindowKeyPress key_listener, 
+
+/**
+ * Set a callback function to be invoked whenever a key is pressed within
+ * a window.
+ *
+ * @param window        The window.
+ * @param key_listener  Callback function.
+ * @param user_data     User-specified pointer to pass to the callback
+ *                      function.
+ */
+
+void TXT_SetKeyListener(txt_window_t *window,
+                        TxtWindowKeyPress key_listener,
                         void *user_data);
-void TXT_SetMouseListener(txt_window_t *window, 
+
+/**
+ * Set a callback function to be invoked whenever a mouse button is pressed
+ * within a window.
+ *
+ * @param window          The window.
+ * @param mouse_listener  Callback function.
+ * @param user_data       User-specified pointer to pass to the callback
+ *                        function.
+ */
+
+void TXT_SetMouseListener(txt_window_t *window,
                           TxtWindowMousePress mouse_listener,
                           void *user_data);
 
-- 
cgit v1.2.3