2021-05-06 10:22:37 +02:00
|
|
|
/* Copyright (C) 2021 Wildfire Games.
|
2009-04-18 19:00:33 +02:00
|
|
|
* This file is part of 0 A.D.
|
|
|
|
*
|
|
|
|
* 0 A.D. 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
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* 0 A.D. 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 0 A.D. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
*/
|
|
|
|
|
2019-08-29 11:07:29 +02:00
|
|
|
#ifndef INCLUDED_CGUISETTINGS
|
|
|
|
#define INCLUDED_CGUISETTINGS
|
2003-11-06 01:21:45 +01:00
|
|
|
|
2021-05-12 15:48:55 +02:00
|
|
|
#include "ps/CStr.h"
|
|
|
|
#include "scriptinterface/ScriptForward.h"
|
|
|
|
|
2003-11-06 01:21:45 +01:00
|
|
|
|
2021-05-06 10:22:37 +02:00
|
|
|
class IGUIObject;
|
|
|
|
|
2019-08-29 11:07:29 +02:00
|
|
|
/**
|
|
|
|
* This setting interface allows GUI objects to call setting function functions without having to know the setting type.
|
|
|
|
* This is fact is used for setting the value from a JS value or XML value (string) and when deleting the setting,
|
|
|
|
* when the type of the setting value is not known in advance.
|
|
|
|
*/
|
2019-08-04 04:20:08 +02:00
|
|
|
class IGUISetting
|
|
|
|
{
|
|
|
|
public:
|
Use NONCOPYABLE for most GUI classes and structs to have the compiler indicate unintended copies, refs 3028551b91 / D2163.
That is CChartData, CGUIList, CGUISeries, COListColumn, GUITooltip,
SGUIMessage, SSpriteCall, STextCall, SFeedback, IGUISetting,
CGUISetting, GUI, IGUIObject, IGUIScrollBar.
Drop copying GetSetting and SetSetting template functions for CGUIList,
CGUISeries, CClientArea, CGUIString.
Stop copying COListColumn.
Drop copying GUI<CClientArea>::GetSetting call in
IGUIObject::UpdateCachedSize() and four copying
GUI<CGUIString>::GetSetting calls in SetupText() functions.
Delete unused GUIRenderer IGLState class from 849f50a500 obsolete since
1f5b8f1c9a.
Differential Revision: https://code.wildfiregames.com/D2164
This was SVN commit r22638.
2019-08-10 02:04:17 +02:00
|
|
|
NONCOPYABLE(IGUISetting);
|
2021-05-06 10:22:37 +02:00
|
|
|
IGUISetting(const CStr& name, IGUIObject* owner);
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Parses the given string and assigns to the setting value. Used for parsing XML attributes.
|
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
bool FromString(const CStrW& value, const bool sendMessage);
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Parses the given JS::Value using ScriptInterface::FromJSVal and assigns it to the setting data.
|
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
bool FromJSVal(const ScriptRequest& rq, JS::HandleValue value, const bool sendMessage);
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Converts the setting data to a JS::Value using ScriptInterface::ToJSVal.
|
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
virtual void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue value) = 0;
|
2019-08-04 04:20:08 +02:00
|
|
|
|
2021-05-06 10:22:37 +02:00
|
|
|
protected:
|
|
|
|
IGUISetting(IGUISetting&& o);
|
|
|
|
virtual ~IGUISetting() = default;
|
2019-08-04 04:20:08 +02:00
|
|
|
|
2021-05-06 10:22:37 +02:00
|
|
|
virtual bool DoFromString(const CStrW& value) = 0;
|
|
|
|
virtual bool DoFromJSVal(const ScriptRequest& rq, JS::HandleValue value) = 0;
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
2021-05-06 10:22:37 +02:00
|
|
|
* Triggers the IGUIObject logic when a setting changes.
|
|
|
|
* This should be called by derived classes when something externally visible changes,
|
|
|
|
* unless overloaded to provide similar behaviour.
|
2019-08-04 04:20:08 +02:00
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
virtual void OnSettingChange(const CStr& setting, bool sendMessage);
|
2019-08-04 04:20:08 +02:00
|
|
|
|
2019-08-26 14:25:07 +02:00
|
|
|
/**
|
2021-05-06 10:22:37 +02:00
|
|
|
* Return the name of the setting, from JS.
|
2019-08-26 14:25:07 +02:00
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
virtual CStr GetName() const = 0;
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The object that stores this setting.
|
|
|
|
*/
|
|
|
|
IGUIObject& m_pObject;
|
2021-05-06 10:22:37 +02:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Wraps a T. Makes sure the appropriate setting functions are called when modifying T,
|
|
|
|
* and likewise makes sure that JS/xml settings affect T appropriately,
|
|
|
|
* while being as transparent as possible to use from C++ code.
|
|
|
|
*/
|
|
|
|
template<typename T>
|
|
|
|
class CGUISimpleSetting : public IGUISetting
|
|
|
|
{
|
|
|
|
public:
|
|
|
|
template<typename... Args>
|
|
|
|
CGUISimpleSetting(IGUIObject* pObject, const CStr& Name, Args&&... args)
|
|
|
|
: IGUISetting(Name, pObject), m_Name(Name), m_Setting(args...)
|
|
|
|
{}
|
|
|
|
NONCOPYABLE(CGUISimpleSetting);
|
|
|
|
MOVABLE(CGUISimpleSetting);
|
|
|
|
|
|
|
|
operator const T&() const { return m_Setting; }
|
|
|
|
const T& operator*() const { return m_Setting; }
|
|
|
|
const T* operator->() const { return &m_Setting; }
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
2021-05-06 10:22:37 +02:00
|
|
|
* 'Uglified' getter when you want direct access without triggering messages.
|
2019-08-04 04:20:08 +02:00
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
T& GetMutable() { return m_Setting; }
|
2019-08-04 04:20:08 +02:00
|
|
|
|
|
|
|
/**
|
2021-05-06 10:22:37 +02:00
|
|
|
* 'Uglified' operator=, so that SendMessage is explicit.
|
2019-08-04 04:20:08 +02:00
|
|
|
*/
|
2021-05-06 10:22:37 +02:00
|
|
|
void Set(T value, bool sendMessage)
|
|
|
|
{
|
|
|
|
m_Setting = std::move(value);
|
|
|
|
OnSettingChange(m_Name, sendMessage);
|
|
|
|
}
|
|
|
|
|
|
|
|
protected:
|
|
|
|
CStr GetName() const override
|
|
|
|
{
|
|
|
|
return m_Name;
|
|
|
|
}
|
|
|
|
|
|
|
|
bool DoFromString(const CStrW& value) override;
|
|
|
|
bool DoFromJSVal(const ScriptRequest& rq, JS::HandleValue value) override;
|
|
|
|
void ToJSVal(const ScriptRequest& rq, JS::MutableHandleValue value) override;
|
|
|
|
|
|
|
|
const CStr m_Name;
|
|
|
|
T m_Setting;
|
2019-08-04 04:20:08 +02:00
|
|
|
};
|
2003-11-24 18:13:37 +01:00
|
|
|
|
2019-08-29 11:07:29 +02:00
|
|
|
#endif // INCLUDED_CGUISETTINGS
|