diff options
author | Simon Howard | 2009-03-12 22:20:07 +0000 |
---|---|---|
committer | Simon Howard | 2009-03-12 22:20:07 +0000 |
commit | 6e2c404f64f39e059848bc66b707dfe979f044ff (patch) | |
tree | cd0aba502696ceef12bd311d4576fd46c4dd5c02 /textscreen/txt_separator.h | |
parent | 20cb00076d39bcb8a5c2e82912af8200c97034cb (diff) | |
parent | 535c64b336ce59b4e18819544cd2a1129ae97c61 (diff) | |
download | chocolate-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_separator.h')
-rw-r--r-- | textscreen/txt_separator.h | 23 |
1 files changed, 23 insertions, 0 deletions
diff --git a/textscreen/txt_separator.h b/textscreen/txt_separator.h index c8691171..2f2331da 100644 --- a/textscreen/txt_separator.h +++ b/textscreen/txt_separator.h @@ -22,6 +22,21 @@ #ifndef TXT_SEPARATOR_H #define TXT_SEPARATOR_H +/** + * @file txt_separator.h + * + * Horizontal separator widget. + */ + +/** + * Horizontal separator. + * + * A horizontal separator appears as a horizontal line divider across + * the length of the window in which it is added. An optional label + * allows the separator to be used as a section divider for grouping + * related controls. + */ + typedef struct txt_separator_s txt_separator_t; #include "txt_widget.h" @@ -34,6 +49,14 @@ struct txt_separator_s extern txt_widget_class_t txt_separator_class; +/** + * Create a new horizontal separator widget. + * + * @param label Label to display on the separator. If this is + * set to NULL, no label is displayed. + * @return The new separator widget. + */ + txt_separator_t *TXT_NewSeparator(char *label); #endif /* #ifndef TXT_SEPARATOR_H */ |