/*
 * Licensed under the GNU Lesser General Public License Version 3
 *
 * This library is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, either version 3 of the license, or
 * (at your option) any later version.
 *
 * This software 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 Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
 */

// generated automatically - do not change


module gobject.TypeInterface;

private import gi.gobject;
public  import gi.gobjecttypes;
private import gobject.ObjectG;
private import gobject.TypeClass;
private import gobject.TypePlugin;
private import gobject.TypePluginIF;


/**
 * An opaque structure used as the base of all interface types.
 */
public class TypeInterface
{
	/** the main GObject struct */
	protected GTypeInterface* gTypeInterface;

	/** Get the main GObject struct */
	public GTypeInterface* getTypeInterfaceStruct()
	{
		return gTypeInterface;
	}

	/** the main GObject struct as a void* */
	protected void* getStruct()
	{
		return cast(void*)gTypeInterface;
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (GTypeInterface* gTypeInterface)
	{
		this.gTypeInterface = gTypeInterface;
	}


	/**
	 * Returns the corresponding #GTypeInterface structure of the parent type
	 * of the instance type to which @g_iface belongs. This is useful when
	 * deriving the implementation of an interface from the parent type and
	 * then possibly overriding some methods.
	 *
	 * Return: the
	 *     corresponding #GTypeInterface structure of the parent type of the
	 *     instance type to which @g_iface belongs, or %NULL if the parent
	 *     type doesn't conform to the interface
	 */
	public TypeInterface peekParent()
	{
		auto p = g_type_interface_peek_parent(gTypeInterface);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(TypeInterface)(cast(GTypeInterface*) p);
	}

	/**
	 * Adds @prerequisite_type to the list of prerequisites of @interface_type.
	 * This means that any type implementing @interface_type must also implement
	 * @prerequisite_type. Prerequisites can be thought of as an alternative to
	 * interface derivation (which GType doesn't support). An interface can have
	 * at most one instantiatable prerequisite type.
	 *
	 * Params:
	 *     interfaceType = #GType value of an interface type
	 *     prerequisiteType = #GType value of an interface or instantiatable type
	 */
	public static void addPrerequisite(GType interfaceType, GType prerequisiteType)
	{
		g_type_interface_add_prerequisite(interfaceType, prerequisiteType);
	}

	/**
	 * Returns the #GTypePlugin structure for the dynamic interface
	 * @interface_type which has been added to @instance_type, or %NULL
	 * if @interface_type has not been added to @instance_type or does
	 * not have a #GTypePlugin structure. See g_type_add_interface_dynamic().
	 *
	 * Params:
	 *     instanceType = #GType of an instantiatable type
	 *     interfaceType = #GType of an interface type
	 *
	 * Return: the #GTypePlugin for the dynamic
	 *     interface @interface_type of @instance_type
	 */
	public static TypePluginIF getPlugin(GType instanceType, GType interfaceType)
	{
		auto p = g_type_interface_get_plugin(instanceType, interfaceType);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(TypePlugin, TypePluginIF)(cast(GTypePlugin*) p);
	}

	/**
	 * Returns the #GTypeInterface structure of an interface to which the
	 * passed in class conforms.
	 *
	 * Params:
	 *     instanceClass = a #GTypeClass structure
	 *     ifaceType = an interface ID which this class conforms to
	 *
	 * Return: the #GTypeInterface
	 *     structure of @iface_type if implemented by @instance_class, %NULL
	 *     otherwise
	 */
	public static TypeInterface peek(TypeClass instanceClass, GType ifaceType)
	{
		auto p = g_type_interface_peek((instanceClass is null) ? null : instanceClass.getTypeClassStruct(), ifaceType);
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(TypeInterface)(cast(GTypeInterface*) p);
	}

	/**
	 * Returns the prerequisites of an interfaces type.
	 *
	 * Params:
	 *     interfaceType = an interface type
	 *
	 * Return: a
	 *     newly-allocated zero-terminated array of #GType containing
	 *     the prerequisites of @interface_type
	 *
	 * Since: 2.2
	 */
	public static GType[] prerequisites(GType interfaceType)
	{
		uint nPrerequisites;
		
		auto p = g_type_interface_prerequisites(interfaceType, &nPrerequisites);
		
		return p[0 .. nPrerequisites];
	}
}
