libgtkd-3-dev 3.7.5-2build1 / usr / include / d / gtkd-3 / gtk / HandleBox.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 gtk.HandleBox;

private import glib.ConstructionException;
private import gobject.ObjectG;
private import gobject.Signals;
private import gtk.Bin;
private import gtk.Widget;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;
private import std.algorithm;


/**
 * The #GtkHandleBox widget allows a portion of a window to be "torn
 * off". It is a bin widget which displays its child and a handle that
 * the user can drag to tear off a separate window (the “float
 * window”) containing the child widget. A thin
 * “ghost” is drawn in the original location of the
 * handlebox. By dragging the separate window back to its original
 * location, it can be reattached.
 * 
 * When reattaching, the ghost and float window, must be aligned
 * along one of the edges, the “snap edge”.
 * This either can be specified by the application programmer
 * explicitly, or GTK+ will pick a reasonable default based
 * on the handle position.
 * 
 * To make detaching and reattaching the handlebox as minimally confusing
 * as possible to the user, it is important to set the snap edge so that
 * the snap edge does not move when the handlebox is deattached. For
 * instance, if the handlebox is packed at the bottom of a VBox, then
 * when the handlebox is detached, the bottom edge of the handlebox's
 * allocation will remain fixed as the height of the handlebox shrinks,
 * so the snap edge should be set to %GTK_POS_BOTTOM.
 * 
 * > #GtkHandleBox has been deprecated. It is very specialized, lacks features
 * > to make it useful and most importantly does not fit well into modern
 * > application design. Do not use it. There is no replacement.
 */
public class HandleBox : Bin
{
	/** the main Gtk struct */
	protected GtkHandleBox* gtkHandleBox;

	/** Get the main Gtk struct */
	public GtkHandleBox* getHandleBoxStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkHandleBox;
	}

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

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

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


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

	/**
	 * Create a new handle box.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Returns: a new #GtkHandleBox.
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto p = gtk_handle_box_new();

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

		this(cast(GtkHandleBox*) p);
	}

	/**
	 * Whether the handlebox’s child is currently detached.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Returns: %TRUE if the child is currently detached, otherwise %FALSE
	 *
	 * Since: 2.14
	 */
	public bool getChildDetached()
	{
		return gtk_handle_box_get_child_detached(gtkHandleBox) != 0;
	}

	/**
	 * Gets the handle position of the handle box. See
	 * gtk_handle_box_set_handle_position().
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Returns: the current handle position.
	 */
	public GtkPositionType getHandlePosition()
	{
		return gtk_handle_box_get_handle_position(gtkHandleBox);
	}

	/**
	 * Gets the type of shadow drawn around the handle box. See
	 * gtk_handle_box_set_shadow_type().
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Returns: the type of shadow currently drawn around the handle box.
	 */
	public GtkShadowType getShadowType()
	{
		return gtk_handle_box_get_shadow_type(gtkHandleBox);
	}

	/**
	 * Gets the edge used for determining reattachment of the handle box.
	 * See gtk_handle_box_set_snap_edge().
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Returns: the edge used for determining reattachment, or
	 *     (GtkPositionType)-1 if this is determined (as per default)
	 *     from the handle position.
	 */
	public GtkPositionType getSnapEdge()
	{
		return gtk_handle_box_get_snap_edge(gtkHandleBox);
	}

	/**
	 * Sets the side of the handlebox where the handle is drawn.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Params:
	 *     position = the side of the handlebox where the handle should be drawn.
	 */
	public void setHandlePosition(GtkPositionType position)
	{
		gtk_handle_box_set_handle_position(gtkHandleBox, position);
	}

	/**
	 * Sets the type of shadow to be drawn around the border
	 * of the handle box.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Params:
	 *     type = the shadow type.
	 */
	public void setShadowType(GtkShadowType type)
	{
		gtk_handle_box_set_shadow_type(gtkHandleBox, type);
	}

	/**
	 * Sets the snap edge of a handlebox. The snap edge is
	 * the edge of the detached child that must be aligned
	 * with the corresponding edge of the “ghost” left
	 * behind when the child was detached to reattach
	 * the torn-off window. Usually, the snap edge should
	 * be chosen so that it stays in the same place on
	 * the screen when the handlebox is torn off.
	 *
	 * If the snap edge is not set, then an appropriate value
	 * will be guessed from the handle position. If the
	 * handle position is %GTK_POS_RIGHT or %GTK_POS_LEFT,
	 * then the snap edge will be %GTK_POS_TOP, otherwise
	 * it will be %GTK_POS_LEFT.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Params:
	 *     edge = the snap edge, or -1 to unset the value; in which
	 *         case GTK+ will try to guess an appropriate value
	 *         in the future.
	 */
	public void setSnapEdge(GtkPositionType edge)
	{
		gtk_handle_box_set_snap_edge(gtkHandleBox, edge);
	}

	protected class OnChildAttachedDelegateWrapper
	{
		void delegate(Widget, HandleBox) dlg;
		gulong handlerId;

		this(void delegate(Widget, HandleBox) dlg)
		{
			this.dlg = dlg;
			onChildAttachedListeners ~= this;
		}

		void remove(OnChildAttachedDelegateWrapper source)
		{
			foreach(index, wrapper; onChildAttachedListeners)
			{
				if (wrapper.handlerId == source.handlerId)
				{
					onChildAttachedListeners[index] = null;
					onChildAttachedListeners = std.algorithm.remove(onChildAttachedListeners, index);
					break;
				}
			}
		}
	}
	OnChildAttachedDelegateWrapper[] onChildAttachedListeners;

	/**
	 * This signal is emitted when the contents of the
	 * handlebox are reattached to the main window.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Params:
	 *     widget = the child widget of the handlebox.
	 *         (this argument provides no extra information
	 *         and is here only for backwards-compatibility)
	 */
	gulong addOnChildAttached(void delegate(Widget, HandleBox) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		auto wrapper = new OnChildAttachedDelegateWrapper(dlg);
		wrapper.handlerId = Signals.connectData(
			this,
			"child-attached",
			cast(GCallback)&callBackChildAttached,
			cast(void*)wrapper,
			cast(GClosureNotify)&callBackChildAttachedDestroy,
			connectFlags);
		return wrapper.handlerId;
	}

	extern(C) static void callBackChildAttached(GtkHandleBox* handleboxStruct, GtkWidget* widget, OnChildAttachedDelegateWrapper wrapper)
	{
		wrapper.dlg(ObjectG.getDObject!(Widget)(widget), wrapper.outer);
	}

	extern(C) static void callBackChildAttachedDestroy(OnChildAttachedDelegateWrapper wrapper, GClosure* closure)
	{
		wrapper.remove(wrapper);
	}

	protected class OnChildDetachedDelegateWrapper
	{
		void delegate(Widget, HandleBox) dlg;
		gulong handlerId;

		this(void delegate(Widget, HandleBox) dlg)
		{
			this.dlg = dlg;
			onChildDetachedListeners ~= this;
		}

		void remove(OnChildDetachedDelegateWrapper source)
		{
			foreach(index, wrapper; onChildDetachedListeners)
			{
				if (wrapper.handlerId == source.handlerId)
				{
					onChildDetachedListeners[index] = null;
					onChildDetachedListeners = std.algorithm.remove(onChildDetachedListeners, index);
					break;
				}
			}
		}
	}
	OnChildDetachedDelegateWrapper[] onChildDetachedListeners;

	/**
	 * This signal is emitted when the contents of the
	 * handlebox are detached from the main window.
	 *
	 * Deprecated: #GtkHandleBox has been deprecated.
	 *
	 * Params:
	 *     widget = the child widget of the handlebox.
	 *         (this argument provides no extra information
	 *         and is here only for backwards-compatibility)
	 */
	gulong addOnChildDetached(void delegate(Widget, HandleBox) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		auto wrapper = new OnChildDetachedDelegateWrapper(dlg);
		wrapper.handlerId = Signals.connectData(
			this,
			"child-detached",
			cast(GCallback)&callBackChildDetached,
			cast(void*)wrapper,
			cast(GClosureNotify)&callBackChildDetachedDestroy,
			connectFlags);
		return wrapper.handlerId;
	}

	extern(C) static void callBackChildDetached(GtkHandleBox* handleboxStruct, GtkWidget* widget, OnChildDetachedDelegateWrapper wrapper)
	{
		wrapper.dlg(ObjectG.getDObject!(Widget)(widget), wrapper.outer);
	}

	extern(C) static void callBackChildDetachedDestroy(OnChildDetachedDelegateWrapper wrapper, GClosure* closure)
	{
		wrapper.remove(wrapper);
	}
}