comparison finch/libgnt/gntcolors.h @ 20751:fe77cc691f78

Some doxygen stuff.
author Sadrul Habib Chowdhury <imadil@gmail.com>
date Tue, 02 Oct 2007 04:22:26 +0000
parents 44b4e8bd759b
children 9187d331aebe
comparison
equal deleted inserted replaced
20750:0ee0cad488b4 20751:fe77cc691f78
27 #ifndef GNT_COLORS_H 27 #ifndef GNT_COLORS_H
28 #define GNT_COLORS_H 28 #define GNT_COLORS_H
29 29
30 #include <glib.h> 30 #include <glib.h>
31 31
32 /**
33 * Different classes of colors.
34 */
32 typedef enum 35 typedef enum
33 { 36 {
34 GNT_COLOR_NORMAL = 1, 37 GNT_COLOR_NORMAL = 1,
35 GNT_COLOR_HIGHLIGHT, /* eg. when a button is selected */ 38 GNT_COLOR_HIGHLIGHT, /* eg. when a button is selected */
36 GNT_COLOR_DISABLED, /* eg. when a button is disabled */ 39 GNT_COLOR_DISABLED, /* eg. when a button is disabled */
56 GNT_COLOR_GRAY, 59 GNT_COLOR_GRAY,
57 GNT_COLOR_DARK_GRAY, 60 GNT_COLOR_DARK_GRAY,
58 GNT_TOTAL_COLORS 61 GNT_TOTAL_COLORS
59 }; 62 };
60 63
61 /* populate some default colors */
62 /** 64 /**
63 * 65 * Initialize the colors.
64 */ 66 */
65 void gnt_init_colors(void); 67 void gnt_init_colors(void);
66 68
67 /** 69 /**
68 * 70 * Uninitialize the colors.
69 */ 71 */
70 void gnt_uninit_colors(void); 72 void gnt_uninit_colors(void);
71 73
72 #if GLIB_CHECK_VERSION(2,6,0) 74 #if GLIB_CHECK_VERSION(2,6,0)
73 /** 75 /**
74 * 76 * Parse color information from a file.
75 * @param kfile 77 *
78 * @param kfile The file containing color information.
76 */ 79 */
77 void gnt_colors_parse(GKeyFile *kfile); 80 void gnt_colors_parse(GKeyFile *kfile);
78 81
79 /** 82 /**
80 * 83 * Parse color-pair information from a file.
81 * @param kfile 84 *
85 * @param kfile The file containing the color-pair information.
82 */ 86 */
83 void gnt_color_pairs_parse(GKeyFile *kfile); 87 void gnt_color_pairs_parse(GKeyFile *kfile);
84 88
85 #endif 89 #endif
86 90