Colors.h

00001 #ifndef PIRCBOT_COLORS_H
00002 #define PIRCBOT_COLORS_H
00003 
00004 /*
00005  * pircbotcpp, C++ port of the pircbot Java version
00006  * A IRC C++ software development kit. An Object 
00007  * Oriented client framework which lets you 
00008  * write quick and easy C++ IRC bots
00009  *
00010  * Copyright (C) 2006 Frank Hassanabad 
00011  * http://pircbotcpp.sourceforge.net/
00012  *
00013  * Java version 
00014  * Copyright Paul James Mutton, 2001-2004, http://www.jibble.org/
00015  *
00016  * This library is free software; you can redistribute it and/or
00017  * modify it under the terms of the GNU General Public
00018  * License as published by the Free Software Foundation; either
00019  * version 2.1 of the License, or (at your option) any later version.
00020  *
00021  * This library is distributed in the hope that it will be useful,
00022  * but WITHOUT ANY WARRANTY; without even the implied warranty of
00023  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00024  * General Public License for more details.
00025  *
00026  * You should have received a copy of the GNU General Public
00027  * License along with this library; if not, write to the Free Software
00028  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
00029  */
00030 
00031 //pircbot includes
00032 //To get the PIRCBOT_EXPORT macro
00033 #include <pircbot/exports.h>
00034 #include <pircbot/Exceptions.h>
00035 
00036 /* Disable Windows VC 7.x warning about 
00037  * it ignoring the throw specification
00038  */
00039 #ifdef _WIN32
00040 #    pragma warning ( push )
00041 #    pragma warning( disable : 4290 )
00042 #endif
00043 
00044 
00045 namespace pircbot
00046 {
00047 namespace impl
00048 {
00049 
00097 class PIRCBOT_EXPORT Colors {
00098 
00099     public:
00100 
00111         static const char *getNormal() 
00112             throw(Exception &);
00113 
00123         static const char *getBold() 
00124             throw(Exception &);
00125 
00135         static const char *getUnderLine() 
00136             throw(Exception &);
00137 
00148         static const char *getReverse() 
00149             throw(Exception &);
00150 
00160         static const char *getWhite() 
00161             throw(Exception &);
00162     
00172         static const char *getBlack() 
00173             throw(Exception &);
00174 
00184         static const char *getDarkBlue() 
00185             throw(Exception &);
00186     
00196         static const char *getDarkGreen() 
00197             throw(Exception &);
00198     
00208         static const char *getRed() 
00209             throw(Exception &);
00210     
00220         static const char *getBrown() 
00221             throw(Exception &);
00222 
00232         static const char *getPurple() 
00233             throw(Exception &);
00234 
00244         static const char *getOlive() 
00245             throw(Exception &);
00246 
00256         static const char *getYellow() 
00257             throw(Exception &);
00258 
00268         static const char *getGreen() 
00269             throw(Exception &);
00270     
00280         static const char *getTeal() 
00281             throw(Exception &);
00282 
00292         static const char *getCyan() 
00293             throw(Exception &);
00294 
00304         static const char *getBlue() 
00305             throw(Exception &);
00306 
00316         static const char *getMagenta() 
00317             throw(Exception &);
00318 
00328         static const char *getDarkGray() 
00329             throw(Exception &);
00330 
00340         static const char *getLightGray() 
00341             throw(Exception &);
00342 
00361         static const char *removeColors(const char *line) 
00362             throw(Exception &);
00363 
00364 
00383         static const char *removeFormatting(const char *line)
00384             throw(Exception &);
00385 
00403         static void releaseMemoryOfCharArray(const char *line)
00404             throw(Exception &);
00405         
00406     private:
00407 
00411         Colors();
00412 };
00413 
00414 } //end of impl namespace 
00415 
00416 //expose Colors to the pircbot namespace
00417 using pircbot::impl::Colors;
00418 
00419 } //end of pircbot namespace
00420 
00421 
00422 #ifdef _WIN32
00423 #    pragma warning( disable : 4290 )
00424 #endif
00425 
00426 #endif
00427 

Generated on Sun Sep 3 16:43:08 2006 for pircbotcpp by  doxygen 1.4.5