src/LColor.h

   1 // -*- C++ -*-
   2 /* This file is part of
   3  * ======================================================
   4  *
   5  *           LyX, The Document Processor
   6  *
   7  *          Copyright 1998-2001 The LyX Team
   8  *
   9  *======================================================*/
  10
  11 #ifndef LCOLOR_H
  12 #define LCOLOR_H
  13
  14 #ifdef __GNUG__
  15 #pragma interface
  16 #endif
  17
  18 #include <map>
  19
  20 #include "LString.h"
  21
  22 /**
  23   This is a stateless class.
  24
  25   It has one basic purposes:
  26   To serve as a color-namespace container (the Color enum).
  27
  28
  29   */
  30 /**
  31  * \class LColor
  32  *
  33  * A class holding color definitions and associated names for
  34  * LaTeX, X11, the GUI, and LyX internally.
  35  *
  36  * A color can be one of the following kinds:
  37  *
  38  * - A real, predefined color, such as black, white, red or green.
  39  * - A logical color, such as no color, inherit, math
  40  */
  41
  42 class LColor // : public boost::noncopyable {
  43 // made copyable for same reasons as LyXRC was made copyable. See there for
  44 // explanation.
  45 {
  46 public:
  47         /// Names of colors, including all logical colors
  48         enum color {
  49                 /// No particular color---clear or default
  50                 none,
  51                 /// The different text colors
  52                 black,
  53                 ///
  54                 white,
  55                 ///
  56                 red,
  57                 ///
  58                 green,
  59                 ///
  60                 blue,
  61                 ///
  62                 cyan,
  63                 ///
  64                 magenta,
  65                 ///
  66                 yellow,
  67
  68                 // Needed interface colors
  69
  70                 /// Cursor color
  71                 cursor,
  72                 /// Background color
  73                 background,
  74                 /// Foreground color
  75                 foreground,
  76                 /// Background color of selected text
  77                 selection,
  78                 /// Text color in LaTeX mode
  79                 latex,
  80
  81                 /// Text color for notes
  82                 note,
  83                 /// Background color of notes
  84                 notebg,
  85
  86
  87                 /// Color for the depth bars in the margin
  88                 depthbar,
  89                 /// Color for marking foreign language words
  90                 language,
  91
  92                 /// Text color for command insets
  93                 command,
  94                 /// Background color for command insets
  95                 commandbg,
  96                 /// Frame color for command insets
  97                 commandframe,
  98
  99                 /// Special chars text color
 100                 special,
 101
 102                 /// Graphics inset background color
 103                 graphicsbg,
 104                 /// Math inset text color
 105                 math,
 106                 /// Math inset background color
 107                 mathbg,
 108                 /// Macro math inset background color
 109                 mathmacrobg,
 110                 /// Math inset frame color
 111                 mathframe,
 112                 /// Math cursor color
 113                 mathcursor,
 114                 /// Math line color
 115                 mathline,
 116
 117                 /// caption frame color
 118                 captionframe,
 119
 120                 /// collapsable insets text
 121                 collapsable,
 122                 /// collapsable insets frame
 123                 collapsableframe,
 124
 125                 /// Inset marker background color
 126                 insetbg,
 127                 /// Inset marker frame color
 128                 insetframe,
 129
 130                 /// Error box text color
 131                 error,
 132                 /// EOL marker color
 133                 eolmarker,
 134                 /// Added space colour
 135                 added_space,
 136                 /// Appendix line color
 137                 appendixline,
 138                 /// Top and bottom line color
 139                 topline,
 140                 /// Table line color
 141                 tabularline,
 142                 /// Table line color
 143                 tabularonoffline,
 144                 /// Bottom area color
 145                 bottomarea,
 146                 /// Page break color
 147                 pagebreak,
 148
 149                 // FIXME: why are the next four separate ??
 150                 /// Color used for top of boxes
 151                 top,
 152                 /// Color used for bottom of boxes
 153                 bottom,
 154                 /// Color used for left side of boxes
 155                 left,
 156                 /// Color used for right side of boxes
 157                 right,
 158                 /// Color used for bottom background
 159                 buttonbg,
 160
 161                 // Logical attributes
 162
 163                 /// Color is inherited
 164                 inherit,
 165                 /// For ignoring updates of a color
 166                 ignore
 167         };
 168
 169         ///
 170         LColor();
 171         /// set the given LyX color to the color defined by the X11 name given
 172         void setColor(LColor::color col, string const & x11name);
 173         /// set the given LyX color to the color defined by the X11 name given
 174         bool setColor(string const & lyxname, string const & x11name);
 175
 176         /// Get GUI name of color
 177         string const getGUIName(LColor::color c) const;
 178
 179         /// Get X11 name of color
 180         string const getX11Name(LColor::color c) const;
 181
 182         /// Get LaTeX name of color
 183         string const getLaTeXName(LColor::color c) const;
 184
 185         /// Get LyX name of color
 186         string const getLyXName(LColor::color c) const;
 187
 188         /// get the color from the GUI name
 189         LColor::color getFromGUIName(string const & guiname) const;
 190         /// get the color from the LyX name
 191         LColor::color getFromLyXName(string const & lyxname) const;
 192 private:
 193         ///
 194         struct information {
 195                 /// the name as it appears in the GUI
 196                 string guiname;
 197                 /// the name used in LaTeX
 198                 string latexname;
 199                 /// the name for X11
 200                 string x11name;
 201                 /// the name for LyX
 202                 string lyxname;
 203         };
 204
 205         /// initialise a color entry
 206         void fill(LColor::color col, string const & gui,
 207                   string const & latex, string const & x11,
 208                   string const & lyx);
 209
 210         ///
 211         typedef std::map<LColor::color, information> InfoTab;
 212         /// the table of color information
 213         InfoTab infotab;
 214 };
 215
 216 /// the current color definitions
 217 extern LColor lcolor;
 218 /// the system color definitions
 219 extern LColor system_lcolor;
 220
 221 #endif