RmlUi/Source/Core/PluginRegistry.h

/*
 * This source file is part of RmlUi, the HTML/CSS Interface Middleware
 *
 * For the latest information, see http://github.com/mikke89/RmlUi
 *
 * Copyright (c) 2008-2010 CodePoint Ltd, Shift Technology Ltd
 * Copyright (c) 2019-2023 The RmlUi Team, and contributors
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 *
 */

#ifndef RMLUI_CORE_PLUGINREGISTRY_H
#define RMLUI_CORE_PLUGINREGISTRY_H

#include "../../Include/RmlUi/Core/Types.h"

namespace Rml {

class Context;
class Element;
class ElementDocument;
class Plugin;

/**
    @author Peter Curry
 */

class PluginRegistry {
public:
	static void RegisterPlugin(Plugin* plugin);
	static void UnregisterPlugin(Plugin* plugin);

	/// Calls OnInitialise() on all plugins.
	static void NotifyInitialise();
	/// Calls OnShutdown() on all plugins.
	static void NotifyShutdown();

	/// Calls OnContextCreate() on all plugins.
	static void NotifyContextCreate(Context* context);
	/// Calls OnContextDestroy() on all plugins.
	static void NotifyContextDestroy(Context* context);

	/// Calls OnDocumentOpen() on all plugins.
	static void NotifyDocumentOpen(Context* context, const String& document_path);
	/// Calls OnDocumentLoad() on all plugins.
	static void NotifyDocumentLoad(ElementDocument* document);
	/// Calls OnDocumentUnload() on all plugins.
	static void NotifyDocumentUnload(ElementDocument* document);

	/// Calls OnElementCreate() on all plugins.
	static void NotifyElementCreate(Element* element);
	/// Calls OnElementDestroy() on all plugins.
	static void NotifyElementDestroy(Element* element);

private:
	PluginRegistry() = delete;
};

} // namespace Rml
#endif