summaryrefslogtreecommitdiff
path: root/textscreen/txt_scrollpane.h
diff options
context:
space:
mode:
authorSimon Howard2009-03-12 22:20:07 +0000
committerSimon Howard2009-03-12 22:20:07 +0000
commit6e2c404f64f39e059848bc66b707dfe979f044ff (patch)
treecd0aba502696ceef12bd311d4576fd46c4dd5c02 /textscreen/txt_scrollpane.h
parent20cb00076d39bcb8a5c2e82912af8200c97034cb (diff)
parent535c64b336ce59b4e18819544cd2a1129ae97c61 (diff)
downloadchocolate-doom-6e2c404f64f39e059848bc66b707dfe979f044ff.tar.gz
chocolate-doom-6e2c404f64f39e059848bc66b707dfe979f044ff.tar.bz2
chocolate-doom-6e2c404f64f39e059848bc66b707dfe979f044ff.zip
Update from trunk.
Subversion-branch: /branches/raven-branch Subversion-revision: 1467
Diffstat (limited to 'textscreen/txt_scrollpane.h')
-rw-r--r--textscreen/txt_scrollpane.h24
1 files changed, 24 insertions, 0 deletions
diff --git a/textscreen/txt_scrollpane.h b/textscreen/txt_scrollpane.h
index 661542a3..94f81dc1 100644
--- a/textscreen/txt_scrollpane.h
+++ b/textscreen/txt_scrollpane.h
@@ -22,6 +22,20 @@
#ifndef TXT_SCROLLPANE_H
#define TXT_SCROLLPANE_H
+/**
+ * @file txt_scrollpane.h
+ *
+ * Scrollable pane widget.
+ */
+
+/**
+ * Scrollable pane widget.
+ *
+ * A scrollable pane widget is a widget that contains another widget
+ * that is larger than it. Scroll bars appear on the side to allow
+ * different areas of the contained widget to be seen.
+ */
+
typedef struct txt_scrollpane_s txt_scrollpane_t;
#include "txt_widget.h"
@@ -35,6 +49,16 @@ struct txt_scrollpane_s
txt_widget_t *child;
};
+/**
+ * Create a new scroll pane widget.
+ *
+ * @param w Width of the scroll pane, in characters.
+ * @param h Height of the scroll pane, in lines.
+ * @param target The target widget that the scroll pane will
+ * contain.
+ * @return Pointer to the new scroll pane widget.
+ */
+
txt_scrollpane_t *TXT_NewScrollPane(int w, int h, TXT_UNCAST_ARG(target));
#endif /* #ifndef TXT_SCROLLPANE_H */