setupitem.h

Go to the documentation of this file.

/*
 * The ManaPlus Client
 * 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_WIDGETS_SETUPITEM_H
#define GUI_WIDGETS_SETUPITEM_H
 
#include "enums/simpletypes/donotalign.h"
#include "enums/simpletypes/mainconfig.h"
#include "enums/simpletypes/onthefly.h"
#include "enums/simpletypes/usebase64.h"
#include "enums/simpletypes/separator.h"
 
#include "gui/widgets/widget2.h"
 
#include "listeners/actionlistener.h"
 
#include <list>
 
class Button;
class CheckBox;
class Configuration;
class DropDown;
class EditDialog;
class HorizontContainer;
class IntTextField;
class Label;
class ListModel;
class SetupTabScroll;
class Slider;
class SliderList;
class TextField;
 
class SetupItem notfinal : public ActionListener,
 public Widget2
{
 public:
 enum
 {
 VBOOL = 0,
 VSTR,
 VINT,
 VNONE
 };
 
 A_DELETE_COPY(SetupItem)
 
 ~SetupItem() override;
 
 void load();
 
 virtual void save();
 
 virtual void fromWidget() = 0;
 
 virtual void toWidget() = 0;
 
 void setWidget(Widget *widget)
 { mWidget = widget; }
 
 Widget *getWidget() const noexcept2 A_WARN_UNUSED
 { return mWidget; }
 
 Configuration *getConfig() const RETURNS_NONNULL A_WARN_UNUSED;
 
 virtual std::string getActionEventId() const A_WARN_UNUSED;
 
 void action(const ActionEvent &event) override;
 
 virtual void doAction();
 
 virtual void apply(const std::string &eventName);
 
 virtual void cancel(const std::string &eventName);
 
 virtual void externalUpdated(const std::string &eventName);
 
 virtual void externalUnloaded(const std::string &eventName);
 
 MainConfig isMainConfig() const noexcept2 A_WARN_UNUSED
 { return mMainConfig; }
 
 void fixFirstItemSize(Widget *const widget);
 
 virtual void rereadValue();
 
 void setValue(const std::string &str) noexcept2
 { mValue = str; }
 
 std::string getValue() const noexcept2
 { return mValue; }
 
 std::string getEventName() const noexcept2
 { return mEventName; }
 
 protected:
 SetupItem(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const MainConfig mainConfig);
 
 SetupItem(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const std::string &def,
 const MainConfig mainConfig);
 
 std::string mText;
 
 std::string mDescription;
 
 std::string mKeyName;
 
 SetupTabScroll *mParent;
 
 std::string mEventName;
 
 std::string mValue;
 
 std::string mDefault;
 
 Widget *mWidget;
 
 std::list<Widget*> mTempWidgets;
 
 int mValueType;
 
 MainConfig mMainConfig;
 
 bool mUseDefault;
};
 
class SetupItemCheckBox final : public SetupItem
{
 public:
 SetupItemCheckBox(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const MainConfig mainConfig);
 
 SetupItemCheckBox(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const std::string &restrict def,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemCheckBox)
 
 ~SetupItemCheckBox() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 protected:
 CheckBox *mCheckBox;
};
 
class SetupItemTextField final : public SetupItem
{
 public:
 SetupItemTextField(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const MainConfig mainConfig,
 const UseBase64 useBase64);
 
 SetupItemTextField(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const std::string &restrict def,
 const MainConfig mainConfig,
 const UseBase64 useBase64);
 
 A_DELETE_COPY(SetupItemTextField)
 
 ~SetupItemTextField() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 void action(const ActionEvent &event) override final;
 
 void apply(const std::string &eventName) override final;
 
 void cancel(const std::string &eventName A_UNUSED) override final;
 
 void externalUpdated(const std::string &eventName A_UNUSED)
 override final;
 
 void rereadValue() override final;
 
 void save() override final;
 
 void setUseBase64(const UseBase64 b)
 { mUseBase64 = b; }
 
 protected:
 HorizontContainer *mHorizont;
 Label *mLabel;
 TextField *mTextField;
 Button *mButton;
 EditDialog *mEditDialog;
 UseBase64 mUseBase64;
};
 
class SetupItemIntTextField final : public SetupItem
{
 public:
 SetupItemIntTextField(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const int min, const int max,
 const MainConfig mainConfig);
 
 SetupItemIntTextField(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const int min, const int max,
 const std::string &restrict def,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemIntTextField)
 
 ~SetupItemIntTextField() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 void action(const ActionEvent &event) override final;
 
 void apply(const std::string &eventName) override final;
 
 protected:
 HorizontContainer *mHorizont;
 Label *mLabel;
 IntTextField *mTextField;
 Button *mButton;
 EditDialog *mEditDialog;
 int mMin;
 int mMax;
};
 
class SetupItemLabel final : public SetupItem
{
 public:
 SetupItemLabel(const std::string &restrict text,
 const std::string &restrict description,
 SetupTabScroll *restrict const parent,
 const Separator separator);
 
 A_DELETE_COPY(SetupItemLabel)
 
 ~SetupItemLabel() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 void action(const ActionEvent &event) override final;
 
 void apply(const std::string &eventName) override final;
 
 protected:
 Label *mLabel;
 Separator mIsSeparator;
};
 
class SetupItemDropDown final : public SetupItem
{
 public:
 SetupItemDropDown(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int width,
 const MainConfig mainConfig);
 
 SetupItemDropDown(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int width,
 const std::string &restrict def,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemDropDown)
 
 ~SetupItemDropDown() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 int selectionByValue();
 
 protected:
 HorizontContainer *mHorizont;
 Label *mLabel;
 ListModel *mModel;
 DropDown *mDropDown;
 int mWidth;
};
 
class SetupItemDropDownStr final : public SetupItem
{
 public:
 SetupItemDropDownStr(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int width,
 const MainConfig mainConfig);
 
 SetupItemDropDownStr(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int width,
 const std::string &restrict def,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemDropDownStr)
 
 ~SetupItemDropDownStr() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 int selectionByValue();
 
 protected:
 HorizontContainer *mHorizont;
 Label *mLabel;
 ListModel *mModel;
 DropDown *mDropDown;
 int mWidth;
};
 
class SetupItemSlider final : public SetupItem
{
 public:
 SetupItemSlider(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const double min,
 const double max,
 const double step,
 const int width,
 const OnTheFly onTheFly,
 const MainConfig mainConfig);
 
 SetupItemSlider(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const double min,
 const double max,
 const double step,
 const std::string &restrict def,
 const int width,
 const OnTheFly onTheFly,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemSlider)
 
 ~SetupItemSlider() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 void action(const ActionEvent &event) override final;
 
 void apply(const std::string &eventName) override final;
 
 void updateLabel();
 
 protected:
 HorizontContainer *mHorizont;
 Label *mLabel;
 Slider *mSlider;
 double mMin;
 double mMax;
 double mStep;
 int mWidth;
 OnTheFly mOnTheFly;
};
 
typedef STD_VECTOR<std::string> SetupItemNames;
typedef SetupItemNames::iterator SetupItemNamesIter;
typedef SetupItemNames::const_iterator SetupItemNamesConstIter;
 
class SetupItemSlider2 final : public SetupItem
{
 public:
 SetupItemSlider2(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const int min, const int max, const int step,
 SetupItemNames *restrict const values,
 const OnTheFly onTheFly,
 const MainConfig mainConfig,
 const DoNotAlign doNotAlign);
 
 SetupItemSlider2(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 const int min, const int max, const int step,
 SetupItemNames *restrict const values,
 const std::string &restrict def,
 const OnTheFly onTheFly,
 const MainConfig mainConfig,
 const DoNotAlign doNotAlign);
 
 A_DELETE_COPY(SetupItemSlider2)
 
 ~SetupItemSlider2() override final;
 
 void createControls();
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 void action(const ActionEvent &event) override final;
 
 void apply(const std::string &eventName) override final;
 
 void setInvertValue(const int v);
 
 protected:
 void updateLabel();
 
 int getMaxWidth();
 
 HorizontContainer *mHorizont;
 Label *mLabel;
 Label *mLabel2;
 Slider *mSlider;
 SetupItemNames *mValues;
 int mMin;
 int mMax;
 int mStep;
 int mInvertValue;
 bool mInvert;
 OnTheFly mOnTheFly;
 DoNotAlign mDoNotAlign;
};
 
class SetupItemSliderList notfinal : public SetupItem
{
 public:
 A_DELETE_COPY(SetupItemSliderList)
 
 ~SetupItemSliderList() override;
 
 void createControls();
 
 void fromWidget() override;
 
 void toWidget() override;
 
 void action(const ActionEvent &event) override;
 
 void apply(const std::string &eventName) override final;
 
 virtual void addMoreControls() = 0;
 
 protected:
 SetupItemSliderList(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int width,
 const OnTheFly onTheFly,
 const MainConfig mainConfig);
 
 SetupItemSliderList(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const std::string &restrict def,
 const int width,
 const OnTheFly onTheFly,
 const MainConfig mainConfig);
 
 HorizontContainer *mHorizont;
 Label *mLabel;
 SliderList *mSlider;
 ListModel *mModel;
 int mWidth;
 OnTheFly mOnTheFly;
};
 
class SetupItemSound final : public SetupItemSliderList
{
 public:
 SetupItemSound(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int width,
 const OnTheFly onTheFly,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemSound)
 
 void action(const ActionEvent &event) override final;
 
 void addMoreControls() override final;
 
 protected:
 Button *mButton;
};
 
class SetupItemSliderInt final : public SetupItemSliderList
{
 public:
 SetupItemSliderInt(const std::string &restrict text,
 const std::string &restrict description,
 const std::string &restrict keyName,
 SetupTabScroll *restrict const parent,
 const std::string &restrict eventName,
 ListModel *restrict const model,
 const int min,
 const int width,
 const OnTheFly onTheFly,
 const MainConfig mainConfig);
 
 A_DELETE_COPY(SetupItemSliderInt)
 
 void addMoreControls() override final;
 
 void fromWidget() override final;
 
 void toWidget() override final;
 
 protected:
 int mMin;
};
 
#endif // GUI_WIDGETS_SETUPITEM_H