summaryrefslogtreecommitdiff
path: root/textscreen/txt_strut.h
diff options
context:
space:
mode:
authorSimon Howard2009-07-13 00:52:26 +0000
committerSimon Howard2009-07-13 00:52:26 +0000
commit480a31094b7621dd7d65ec05a6e36964dca99b66 (patch)
tree11b218d674e828c12981d819b8f2396b680436df /textscreen/txt_strut.h
parent37db69b86bc5052901e250578e9c3920886d79ff (diff)
parente66653a8a67f3613344ae4ea30b37403d6ff17cf (diff)
downloadchocolate-doom-480a31094b7621dd7d65ec05a6e36964dca99b66.tar.gz
chocolate-doom-480a31094b7621dd7d65ec05a6e36964dca99b66.tar.bz2
chocolate-doom-480a31094b7621dd7d65ec05a6e36964dca99b66.zip
Merge from trunk.
Subversion-branch: /branches/opl-branch Subversion-revision: 1624
Diffstat (limited to 'textscreen/txt_strut.h')
-rw-r--r--textscreen/txt_strut.h26
1 files changed, 21 insertions, 5 deletions
diff --git a/textscreen/txt_strut.h b/textscreen/txt_strut.h
index 7d9e7650..3dc8db9a 100644
--- a/textscreen/txt_strut.h
+++ b/textscreen/txt_strut.h
@@ -22,15 +22,24 @@
#ifndef TXT_STRUT_H
#define TXT_STRUT_H
+/**
+ * @file txt_strut.h
+ *
+ * Strut widget.
+ */
+
+/**
+ * Strut widget.
+ *
+ * A strut is a widget that takes up a fixed amount of space. It can
+ * be visualised as a transparent box. Struts are used to provide
+ * spacing between widgets.
+ */
+
typedef struct txt_strut_s txt_strut_t;
#include "txt_widget.h"
-//
-// A strut is used to force a table to a minimum width/height. It is not
-// visible but it takes up space.
-//
-
struct txt_strut_s
{
txt_widget_t widget;
@@ -38,6 +47,13 @@ struct txt_strut_s
int height;
};
+/**
+ * Create a new strut.
+ *
+ * @param width Width of the strut, in characters.
+ * @param height Height of the strut, in characters.
+ */
+
txt_strut_t *TXT_NewStrut(int width, int height);
#endif /* #ifndef TXT_STRUT_H */