/*
 * 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 gtk.TreeExpander;

private import glib.ConstructionException;
private import gobject.ObjectG;
private import gtk.TreeListRow;
private import gtk.Widget;
private import gtk.c.functions;
public  import gtk.c.types;


/**
 * `GtkTreeExpander` is a widget that provides an expander for a list.
 * 
 * It is typically placed as a bottommost child into a `GtkListView`
 * to allow users to expand and collapse children in a list with a
 * [class@Gtk.TreeListModel]. `GtkTreeExpander` provides the common UI
 * elements, gestures and keybindings for this purpose.
 * 
 * On top of this, the "listitem.expand", "listitem.collapse" and
 * "listitem.toggle-expand" actions are provided to allow adding custom
 * UI for managing expanded state.
 * 
 * The `GtkTreeListModel` must be set to not be passthrough. Then it
 * will provide [class@Gtk.TreeListRow] items which can be set via
 * [method@Gtk.TreeExpander.set_list_row] on the expander.
 * The expander will then watch that row item automatically.
 * [method@Gtk.TreeExpander.set_child] sets the widget that displays
 * the actual row contents.
 * 
 * # CSS nodes
 * 
 * ```
 * treeexpander
 * ├── [indent]*
 * ├── [expander]
 * ╰── <child>
 * ```
 * 
 * `GtkTreeExpander` has zero or one CSS nodes with the name "expander" that
 * should display the expander icon. The node will be `:checked` when it
 * is expanded. If the node is not expandable, an "indent" node will be
 * displayed instead.
 * 
 * For every level of depth, another "indent" node is prepended.
 * 
 * # Accessibility
 * 
 * `GtkTreeExpander` uses the %GTK_ACCESSIBLE_ROLE_GROUP role. The expander icon
 * is represented as a %GTK_ACCESSIBLE_ROLE_BUTTON, labelled by the expander's
 * child, and toggling it will change the %GTK_ACCESSIBLE_STATE_EXPANDED state.
 */
public class TreeExpander : Widget
{
	/** the main Gtk struct */
	protected GtkTreeExpander* gtkTreeExpander;

	/** Get the main Gtk struct */
	public GtkTreeExpander* getTreeExpanderStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkTreeExpander;
	}

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

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


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

	/**
	 * Creates a new `GtkTreeExpander`
	 *
	 * Returns: a new `GtkTreeExpander`
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto __p = gtk_tree_expander_new();

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

		this(cast(GtkTreeExpander*) __p);
	}

	/**
	 * Gets the child widget displayed by @self.
	 *
	 * Returns: The child displayed by @self
	 */
	public Widget getChild()
	{
		auto __p = gtk_tree_expander_get_child(gtkTreeExpander);

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(Widget)(cast(GtkWidget*) __p);
	}

	/**
	 * Forwards the item set on the `GtkTreeListRow` that @self is managing.
	 *
	 * This call is essentially equivalent to calling:
	 *
	 * ```c
	 * gtk_tree_list_row_get_item (gtk_tree_expander_get_list_row (@self));
	 * ```
	 *
	 * Returns: The item of the row
	 */
	public ObjectG getItem()
	{
		auto __p = gtk_tree_expander_get_item(gtkTreeExpander);

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(ObjectG)(cast(GObject*) __p, true);
	}

	/**
	 * Gets the list row managed by @self.
	 *
	 * Returns: The list row displayed by @self
	 */
	public TreeListRow getListRow()
	{
		auto __p = gtk_tree_expander_get_list_row(gtkTreeExpander);

		if(__p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(TreeListRow)(cast(GtkTreeListRow*) __p);
	}

	/**
	 * Sets the content widget to display.
	 *
	 * Params:
	 *     child = a `GtkWidget`, or %NULL
	 */
	public void setChild(Widget child)
	{
		gtk_tree_expander_set_child(gtkTreeExpander, (child is null) ? null : child.getWidgetStruct());
	}

	/**
	 * Sets the tree list row that this expander should manage.
	 *
	 * Params:
	 *     listRow = a `GtkTreeListRow`, or %NULL
	 */
	public void setListRow(TreeListRow listRow)
	{
		gtk_tree_expander_set_list_row(gtkTreeExpander, (listRow is null) ? null : listRow.getTreeListRowStruct());
	}
}