gntcolors.h

   1 /**
   2  * @file gntcolors.h Colors API
   3  * @ingroup gnt
   4  */
   5 /*
   6  * GNT - The GLib Ncurses Toolkit
   7  *
   8  * GNT is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This library is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26
  27 #ifndef GNT_COLORS_H
  28 #define GNT_COLORS_H
  29
  30 #include <glib.h>
  31
  32 /**
  33  * Different classes of colors.
  34  */
  35 typedef enum
  36 {
  37         GNT_COLOR_NORMAL = 1,
  38         GNT_COLOR_HIGHLIGHT,            /* eg. when a button is selected */
  39         GNT_COLOR_DISABLED,             /* eg. when a button is disabled */
  40         GNT_COLOR_HIGHLIGHT_D,  /* eg. when a button is selected, but some other window is in focus */
  41         GNT_COLOR_TEXT_NORMAL,
  42         GNT_COLOR_TEXT_INACTIVE,        /* when the entry is out of focus */
  43         GNT_COLOR_MNEMONIC,
  44         GNT_COLOR_MNEMONIC_D,
  45         GNT_COLOR_SHADOW,
  46         GNT_COLOR_TITLE,
  47         GNT_COLOR_TITLE_D,
  48         GNT_COLOR_URGENT,       /* this is for the 'urgent' windows */
  49         GNT_COLORS
  50 } GntColorType;
  51
  52 enum
  53 {
  54         GNT_COLOR_BLACK = 0,
  55         GNT_COLOR_RED,
  56         GNT_COLOR_GREEN,
  57         GNT_COLOR_BLUE,
  58         GNT_COLOR_WHITE,
  59         GNT_COLOR_GRAY,
  60         GNT_COLOR_DARK_GRAY,
  61         GNT_TOTAL_COLORS
  62 };
  63
  64 /**
  65  * Initialize the colors.
  66  */
  67 void gnt_init_colors(void);
  68
  69 /**
  70  * Uninitialize the colors.
  71  */
  72 void gnt_uninit_colors(void);
  73
  74 #if GLIB_CHECK_VERSION(2,6,0)
  75 /**
  76  * Parse color information from a file.
  77  *
  78  * @param kfile  The file containing color information.
  79  */
  80 void gnt_colors_parse(GKeyFile *kfile);
  81
  82 /**
  83  * Parse color-pair information from a file.
  84  *
  85  * @param kfile The file containing the color-pair information.
  86  */
  87 void gnt_color_pairs_parse(GKeyFile *kfile);
  88
  89 /**
  90  * Parse a string color
  91  *
  92  * @param kfile The string value
  93  *
  94  * @return A color
  95  *
  96  * @since 2.4.0
  97  */
  98 int gnt_colors_get_color(char *key);
  99 #endif
 100
 101 /**
 102  * Return the appropriate character attribute for a specified color.
 103  * If the terminal doesn't have color support, this returns A_STANDOUT
 104  * when deemed appropriate.
 105  *
 106  * @param color   The color code.
 107  *
 108  * @return  A character attribute.
 109  *
 110  * @since 2.3.0
 111  */
 112 int gnt_color_pair(int color);
 113
 114 /**
 115  * Adds a color definition
 116  *
 117  * @param fg   Foreground
 118  * @param bg   Background
 119  *
 120  * @return  A color pair
 121  *
 122  * @since 2.4.0
 123  */
 124 int gnt_color_add_pair(int fg, int bg);
 125 #endif