libgtkd-3-dev 3.7.5-2build1 / usr / include / d / gtkd-3 / atk / Relation.d

/*
 * This file is part of gtkD.
 *
 * gtkD 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, with
 * some exceptions, please read the COPYING file.
 *
 * gtkD 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 gtkD; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
 */

// generated automatically - do not change
// find conversion definition on APILookup.txt
// implement new conversion functionalities on the wrap.utils pakage


module atk.Relation;

private import atk.ObjectAtk;
private import atk.c.functions;
public  import atk.c.types;
private import glib.ConstructionException;
private import glib.PtrArray;
private import glib.Str;
private import gobject.ObjectG;
public  import gtkc.atktypes;


/**
 * An AtkRelation describes a relation between an object and one or
 * more other objects. The actual relations that an object has with
 * other objects are defined as an AtkRelationSet, which is a set of
 * AtkRelations.
 */
public class Relation : ObjectG
{
	/** the main Gtk struct */
	protected AtkRelation* atkRelation;

	/** Get the main Gtk struct */
	public AtkRelation* getRelationStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return atkRelation;
	}

	/** the main Gtk struct as a void* */
	protected override void* getStruct()
	{
		return cast(void*)atkRelation;
	}

	protected override void setStruct(GObject* obj)
	{
		atkRelation = cast(AtkRelation*)obj;
		super.setStruct(obj);
	}

	/**
	 * Sets our main struct and passes it to the parent class.
	 */
	public this (AtkRelation* atkRelation, bool ownedRef = false)
	{
		this.atkRelation = atkRelation;
		super(cast(GObject*)atkRelation, ownedRef);
	}


	/** */
	public static GType getType()
	{
		return atk_relation_get_type();
	}

	/**
	 * Create a new relation for the specified key and the specified list
	 * of targets.  See also atk_object_add_relationship().
	 *
	 * Params:
	 *     targets = an array of pointers to
	 *         #AtkObjects
	 *     relationship = an #AtkRelationType with which to create the new
	 *         #AtkRelation
	 *
	 * Returns: a pointer to a new #AtkRelation
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(ObjectAtk[] targets, AtkRelationType relationship)
	{
		AtkObject*[] targetsArray = new AtkObject*[targets.length];
		for ( int i = 0; i < targets.length; i++ )
		{
			targetsArray[i] = targets[i].getObjectAtkStruct();
		}

		auto p = atk_relation_new(targetsArray.ptr, cast(int)targets.length, relationship);

		if(p is null)
		{
			throw new ConstructionException("null returned by new");
		}

		this(cast(AtkRelation*) p, true);
	}

	/**
	 * Adds the specified AtkObject to the target for the relation, if it is
	 * not already present.  See also atk_object_add_relationship().
	 *
	 * Params:
	 *     target = an #AtkObject
	 *
	 * Since: 1.9
	 */
	public void addTarget(ObjectAtk target)
	{
		atk_relation_add_target(atkRelation, (target is null) ? null : target.getObjectAtkStruct());
	}

	/**
	 * Gets the type of @relation
	 *
	 * Returns: the type of @relation
	 */
	public AtkRelationType getRelationType()
	{
		return atk_relation_get_relation_type(atkRelation);
	}

	/**
	 * Gets the target list of @relation
	 *
	 * Returns: the target list of @relation
	 */
	public PtrArray getTarget()
	{
		auto p = atk_relation_get_target(atkRelation);

		if(p is null)
		{
			return null;
		}

		return new PtrArray(cast(GPtrArray*) p);
	}

	/**
	 * Remove the specified AtkObject from the target for the relation.
	 *
	 * Params:
	 *     target = an #AtkObject
	 *
	 * Returns: TRUE if the removal is successful.
	 */
	public bool removeTarget(ObjectAtk target)
	{
		return atk_relation_remove_target(atkRelation, (target is null) ? null : target.getObjectAtkStruct()) != 0;
	}

	/**
	 * Get the #AtkRelationType type corresponding to a relation name.
	 *
	 * Params:
	 *     name = a string which is the (non-localized) name of an ATK relation type.
	 *
	 * Returns: the #AtkRelationType enumerated type corresponding to the specified name,
	 *     or #ATK_RELATION_NULL if no matching relation type is found.
	 */
	public static AtkRelationType typeForName(string name)
	{
		return atk_relation_type_for_name(Str.toStringz(name));
	}

	/**
	 * Gets the description string describing the #AtkRelationType @type.
	 *
	 * Params:
	 *     type = The #AtkRelationType whose name is required
	 *
	 * Returns: the string describing the AtkRelationType
	 */
	public static string typeGetName(AtkRelationType type)
	{
		return Str.toString(atk_relation_type_get_name(type));
	}

	/**
	 * Associate @name with a new #AtkRelationType
	 *
	 * Params:
	 *     name = a name string
	 *
	 * Returns: an #AtkRelationType associated with @name
	 */
	public static AtkRelationType typeRegister(string name)
	{
		return atk_relation_type_register(Str.toStringz(name));
	}
}