phoenix-firestorm/indra/llui/lluicolortable.h

110 lines
3.2 KiB
C++

/**
* @file lluicolortable.h
* @brief brief LLUIColorTable class header file
*
* $LicenseInfo:firstyear=2009&license=viewergpl$
*
* Copyright (c) 2009, Linden Research, Inc.
*
* Second Life Viewer Source Code
* The source code in this file ("Source Code") is provided by Linden Lab
* to you under the terms of the GNU General Public License, version 2.0
* ("GPL"), unless you have obtained a separate licensing agreement
* ("Other License"), formally executed by you and Linden Lab. Terms of
* the GPL can be found in doc/GPL-license.txt in this distribution, or
* online at http://secondlifegrid.net/programs/open_source/licensing/gplv2
*
* There are special exceptions to the terms and conditions of the GPL as
* it is applied to this Source Code. View the full text of the exception
* in the file doc/FLOSS-exception.txt in this software distribution, or
* online at
* http://secondlifegrid.net/programs/open_source/licensing/flossexception
*
* By copying, modifying or distributing this software, you acknowledge
* that you have read and understood your obligations described above,
* and agree to abide by those obligations.
*
* ALL LINDEN LAB SOURCE CODE IS PROVIDED "AS IS." LINDEN LAB MAKES NO
* WARRANTIES, EXPRESS, IMPLIED OR OTHERWISE, REGARDING ITS ACCURACY,
* COMPLETENESS OR PERFORMANCE.
* $/LicenseInfo$
*/
#ifndef LL_LLUICOLORTABLE_H_
#define LL_LLUICOLORTABLE_H_
#include <map>
#include "llinitparam.h"
#include "llsingleton.h"
#include "v4color.h"
class LLUIColor;
class LLUIColorTable : public LLSingleton<LLUIColorTable>
{
LOG_CLASS(LLUIColorTable);
// consider using sorted vector, can be much faster
typedef std::map<std::string, LLUIColor> string_color_map_t;
public:
struct ColorParams : LLInitParam::Choice<ColorParams>
{
Alternative<LLColor4> value;
Alternative<std::string> reference;
ColorParams();
};
struct ColorEntryParams : LLInitParam::Block<ColorEntryParams>
{
Mandatory<std::string> name;
Mandatory<ColorParams> color;
ColorEntryParams();
};
struct Params : LLInitParam::Block<Params>
{
Multiple<ColorEntryParams> color_entries;
Params();
};
// define colors by passing in a param block that can be generated via XUI file or manually
void insertFromParams(const Params& p);
// reset all colors to default magenta color
void clear();
// color lookup
LLUIColor getColor(const std::string& name, const LLColor4& default_color = LLColor4::magenta) const;
// if the color is in the table, it's value is changed, otherwise it is added
void setColor(const std::string& name, const LLColor4& color);
// returns true if color_name exists in the table
bool colorExists(const std::string& color_name) const;
// loads colors from settings files
bool loadFromSettings();
// saves colors specified by the user to the users skin directory
void saveUserSettings() const;
private:
bool loadFromFilename(const std::string& filename, string_color_map_t& table);
void insertFromParams(const Params& p, string_color_map_t& table);
void clearTable(string_color_map_t& table);
void setColor(const std::string& name, const LLColor4& color, string_color_map_t& table);
string_color_map_t mLoadedColors;
string_color_map_t mUserSetColors;
};
#endif // LL_LLUICOLORTABLE_H