userpalette.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * Copyright (C) 2008 Douglas Boffey <[email protected]>
 * Copyright (C) 2009 The Mana World Development Team
 * Copyright (C) 2009-2010 The Mana Developers
 * Copyright (C) 2011-2019 The ManaPlus Developers
 * Copyright (C) 2019-2021 Andrei Karas
 *
 * This file is part of The ManaPlus Client.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef GUI_USERPALETTE_H
#define GUI_USERPALETTE_H
 
#include "logger.h"
 
#include "enums/gui/usercolorid.h"
 
#include "gui/palette.h"
 
#include "gui/models/listmodel.h"
 
class UserPalette final : public Palette, public ListModel
{
 public:
 UserPalette();
 
 A_DELETE_COPY(UserPalette)
 
 
 ~UserPalette() override final;
 
 inline const Color &getCommittedColor(const UserColorIdT type)
 const A_WARN_UNUSED
 {
 return mColors[CAST_SIZE(type)].committedColor;
 }
 
 inline const Color &getTestColor(const UserColorIdT type)
 const A_WARN_UNUSED
 { return mColors[CAST_SIZE(type)].testColor; }
 
 inline void setTestColor(const UserColorIdT type,
 const Color &color)
 { mColors[CAST_SIZE(type)].testColor = color; }
 
 void setColor(const UserColorIdT type,
 const int r,
 const int g,
 const int b);
 
 void setGradient(const UserColorIdT type,
 const GradientTypeT grad);
 
 void setGradientDelay(const UserColorIdT type,
 const int delay)
 { mColors[CAST_SIZE(type)].delay = delay; }
 
 inline int getNumberOfElements() override final A_WARN_UNUSED
 { return CAST_S32(mColors.size()); }
 
 std::string getElementAt(int i) override final A_WARN_UNUSED;
 
 inline void commit()
 { commit(false); }
 
 void rollback();
 
 int getColorTypeAt(const int i) A_WARN_UNUSED;
 
 inline const Color &getColor(UserColorIdT type,
 const unsigned int alpha)
 A_WARN_UNUSED
 {
 if (CAST_SIZE(type) >= mColors.size())
 {
 logger->log("incorrect color request type: %d from %u",
 CAST_S32(type),
 CAST_U32(mColors.size()));
 type = UserColorId::BEING;
 }
 Color* col = &mColors[CAST_SIZE(type)].color;
 col->a = alpha;
 return *col;
 }
 
 int getIdByChar(const signed char c, bool &valid) const A_WARN_UNUSED;
 
 inline GradientTypeT getGradientType(const UserColorIdT type)
 const A_WARN_UNUSED
 { return mColors[CAST_SIZE(type)].grad; }
 
 inline int getGradientDelay(const UserColorIdT type)
 const A_WARN_UNUSED
 { return mColors[CAST_SIZE(type)].delay; }
 
 inline const Color &getColorWithAlpha(const UserColorIdT type)
 A_WARN_UNUSED
 {
 Color *const col = &mColors[CAST_SIZE(type)].color;
 col->a = CAST_U32(
 mColors[CAST_SIZE(type)].delay);
 return *col;
 }
 
 private:
 void setColorAt(int i, int r, int g, int b);
 
 void commit(const bool commitNonStatic);
 
 static std::string getConfigName(const std::string &typeName)
 A_WARN_UNUSED;
 
 void addColor(const UserColorIdT type,
 const unsigned rgb,
 GradientTypeT grad,
 const std::string &text,
 int delay);
 
 void addLabel(const UserColorIdT type,
 const std::string &text);
};
 
extern UserPalette *userPalette;
 
#endif // GUI_USERPALETTE_H