0ad/source/gui/Scripting/JSInterface_CGUISize.h

/* Copyright (C) 2025 Wildfire Games.
 * 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/>.
 */

#ifndef INCLUDED_JSI_CGUISIZE
#define INCLUDED_JSI_CGUISIZE

class ScriptInterface;
namespace JSI_CGUISize
{
	void RegisterScriptClass(ScriptInterface& scriptInterface);
}

#endif // INCLUDED_JSI_GUISIZE
Allow setting CGUISize properties directly Previously, modifying individual CGUISize properties (left, top, right, bottom) via JavaScript had no effect unless the entire size object was copied, modified, and reassigned—resulting in verbose and error-prone code. This update introduces proper JavaScript property accessors, enabling direct reading and writing of CGUISize members. The result is a more intuitive and scriptable API. Key Changes: - Implemented JavaScript get/set accessors for each CGUISize property, directly interacting with the native object. - Retained support for string assignments to CGUISize - Maintained the GUISize JS object for backward compatibility, also marked as deprecated. - Improved CGUISimpleSetting<CGUISize> to allow partial updates via direct property access. - allow assigning size from object with pixel and percent values You can now assign size using an object with properties like: size = { left: number, right: number, top: number, bottom: number, rleft: number, rright: number, rtop: number, rbottom: number } - One or more properties can be specified, the missing properties with fill as zero. - Assignment triggers an immediate update event. Delayed Setting Notifications: - Introduced a mechanism for delayed setting notifications, currently only used in CGUISimpleSetting<CGUISize>, to avoid redundant recalculations. - Ensured that getComputedSize triggers any pending delayed notifications before returning the size. This change significantly enhances the developer experience and brings the behavior in line with typical expectations for direct property manipulation in JavaScript. 2025-06-04 14:22:34 -07:00			`/* Copyright (C) 2025 Wildfire Games.`
			`* 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/>.`
			`*/`

			`#ifndef INCLUDED_JSI_CGUISIZE`
			`#define INCLUDED_JSI_CGUISIZE`

			`class ScriptInterface;`
			`namespace JSI_CGUISize`
			`{`
			`void RegisterScriptClass(ScriptInterface& scriptInterface);`
			`}`

			`#endif // INCLUDED_JSI_GUISIZE`