Documentation about spartanengine HOT 3 OPEN

/**
 * @file UI\BaseWindow.hpp
 *
 * BaseWindow class declaration
 *
 */

#pragma once
#include "framework.hpp"
#include "object.hpp"		// parent class
#include "ObjectPtr.hpp"	// member, parameter
#include "menu.hpp"		// parameter
#include "MenuItem.hpp"		// forward declared

/**
 * @brief user interface classes and functions
*/
namespace wsl::ui
{
	/**
	* BaseWindow is an abstract base class from which all window type classes inherit
	* it defines basic message processing functions, common data and functions.
	*/
	class UI_API BaseWindow :
		virtual public Object
	{
		//
		// Setters and getters
		//
	public:

		/** Set window title */
		virtual bool SetCaption(PCWSTR caption) noexcept;

		/**
		* Set window MINMAXINFO struct
		* This structure is used to define window sizing limits
		*/
		inline virtual void SetMinMaxInfo(const MINMAXINFO& info) noexcept;

		/**
		* Query current MINMAXINFO from the window
		* This structure is used to define window sizing limits
		*/
		inline virtual void GetMinMaxInfo(MINMAXINFO& info) const noexcept;

		/**
		* @brief Handler for WM_CLOSE
		* A window with a window menu (WS_SYSMENU) receives a WM_CLOSE message when the user clicks Close.
		* By default, the DefWindowProcW function calls the DestroyWindow function to destroy the window.
		* The DestroyWindow function sends WM_DESTROY and WM_NCDESTROY messages to the window
		* If an application processes this message, it should return zero.
		* @return If the function succeeds, the return value is true.
		*/
		inline virtual bool OnClose();

		/**
		* @brief Handler for WM_DESTROY
		* sent before the child windows are destroyed.
		* It is sent to the window procedure of the window being destroyed after the window is removed from the screen.
		* This message is sent first to the window being destroyed and then to the child windows (if any)
		* If an application processes this message, it should return zero.
		*/
		[[nodiscard]] inline virtual LRESULT OnDestroy() const NOEXCEPT;

		//
		// Members
		//
	protected:
		/** Window style flags */
		DWORD mWindowStyle;

		/** Extended window style flags */
		DWORD mWindowExStyle;

		/**
		* @brief Window title for derived component.
		* Only CreateDialogTemplate requires std::wstring,
		* all other functions expect PCWSTR
		*/
		PCWSTR mCaption;

		/** Window handle of derived component */
		HWND mhWnd;
}