aniani/elinks
1
0
Fork 0
mirror of https://github.com/rkd77/elinks.git synced 2024-12-04 14:46:47 -05:00
Code

Doxify bfu/style

Browse Source 
Also fixes an old misleading comment noticed by kon.
This commit is contained in:
Jonas Fonseca 2007-07-31 14:38:52 +02:00
parent b831ee64aa
commit fd9f1f8f6d
2 changed files with 20 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
src/bfu/style.c
View File

@ -1,4 +1,5 @@
/* BFU display helpers. */
/** BFU style/color cache
* @file */
#ifdef HAVE_CONFIG_H
#include "config.h"

20
src/bfu/style.h
View File

@ -4,11 +4,27 @@
struct color_pair;
struct terminal;
/* Get the colors of the bfu element. If @color is 0 a style suitable for
* mono terminals is returned else a style for a color terminal. */
/** Get suitable BFU color for the specific terminal
*
* Get a color pair (foreground- and background color) for a specific
* BFU widget "style". Depending on the terminal settings a color
* suitable for either mono terminals or color terminals is returned.
* The returned color is derived by looking up the specified stylename
* under the option tree of "ui.colors.color" or the "ui.colors.mono",
* and using the values of the "text" and "background" color options as
* the values of the color pair.
*
* @param term Terminal for which the color will be used.
* @param stylename The name of the BFU color.
* @return A color pair matching the stylename or NULL.
*/
struct color_pair *
get_bfu_color(struct terminal *term, unsigned char *stylename);
/** Cleanup after the BFU style cache
*
* Free all resources used by the BFU style cache.
*/
void done_bfu_colors(void);
#endif