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

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


/**
 * #GtkToolItems are widgets that can appear on a toolbar. To
 * create a toolbar item that contain something else than a button, use
 * gtk_tool_item_new(). Use gtk_container_add() to add a child
 * widget to the tool item.
 * 
 * For toolbar items that contain buttons, see the #GtkToolButton,
 * #GtkToggleToolButton and #GtkRadioToolButton classes.
 * 
 * See the #GtkToolbar class for a description of the toolbar widget, and
 * #GtkToolShell for a description of the tool shell interface.
 */
public class ToolItem : Bin, ActivatableIF
{
	/** the main Gtk struct */
	protected GtkToolItem* gtkToolItem;

	/** Get the main Gtk struct */
	public GtkToolItem* getToolItemStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkToolItem;
	}

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

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

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

	// add the Activatable capabilities
	mixin ActivatableT!(GtkToolItem);


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

	/**
	 * Creates a new #GtkToolItem
	 *
	 * Returns: the new #GtkToolItem
	 *
	 * Since: 2.4
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto p = gtk_tool_item_new();

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

		this(cast(GtkToolItem*) p);
	}

	/**
	 * Returns the ellipsize mode used for @tool_item. Custom subclasses of
	 * #GtkToolItem should call this function to find out how text should
	 * be ellipsized.
	 *
	 * Returns: a #PangoEllipsizeMode indicating how text in @tool_item
	 *     should be ellipsized.
	 *
	 * Since: 2.20
	 */
	public PangoEllipsizeMode getEllipsizeMode()
	{
		return gtk_tool_item_get_ellipsize_mode(gtkToolItem);
	}

	/**
	 * Returns whether @tool_item is allocated extra space.
	 * See gtk_tool_item_set_expand().
	 *
	 * Returns: %TRUE if @tool_item is allocated extra space.
	 *
	 * Since: 2.4
	 */
	public bool getExpand()
	{
		return gtk_tool_item_get_expand(gtkToolItem) != 0;
	}

	/**
	 * Returns whether @tool_item is the same size as other homogeneous
	 * items. See gtk_tool_item_set_homogeneous().
	 *
	 * Returns: %TRUE if the item is the same size as other homogeneous
	 *     items.
	 *
	 * Since: 2.4
	 */
	public bool getHomogeneous()
	{
		return gtk_tool_item_get_homogeneous(gtkToolItem) != 0;
	}

	/**
	 * Returns the icon size used for @tool_item. Custom subclasses of
	 * #GtkToolItem should call this function to find out what size icons
	 * they should use.
	 *
	 * Returns: a #GtkIconSize indicating the icon size
	 *     used for @tool_item
	 *
	 * Since: 2.4
	 */
	public GtkIconSize getIconSize()
	{
		return gtk_tool_item_get_icon_size(gtkToolItem);
	}

	/**
	 * Returns whether @tool_item is considered important. See
	 * gtk_tool_item_set_is_important()
	 *
	 * Returns: %TRUE if @tool_item is considered important.
	 *
	 * Since: 2.4
	 */
	public bool getIsImportant()
	{
		return gtk_tool_item_get_is_important(gtkToolItem) != 0;
	}

	/**
	 * Returns the orientation used for @tool_item. Custom subclasses of
	 * #GtkToolItem should call this function to find out what size icons
	 * they should use.
	 *
	 * Returns: a #GtkOrientation indicating the orientation
	 *     used for @tool_item
	 *
	 * Since: 2.4
	 */
	public GtkOrientation getOrientation()
	{
		return gtk_tool_item_get_orientation(gtkToolItem);
	}

	/**
	 * If @menu_item_id matches the string passed to
	 * gtk_tool_item_set_proxy_menu_item() return the corresponding #GtkMenuItem.
	 *
	 * Custom subclasses of #GtkToolItem should use this function to
	 * update their menu item when the #GtkToolItem changes. That the
	 * @menu_item_ids must match ensures that a #GtkToolItem
	 * will not inadvertently change a menu item that they did not create.
	 *
	 * Params:
	 *     menuItemId = a string used to identify the menu item
	 *
	 * Returns: The #GtkMenuItem passed to
	 *     gtk_tool_item_set_proxy_menu_item(), if the @menu_item_ids
	 *     match.
	 *
	 * Since: 2.4
	 */
	public Widget getProxyMenuItem(string menuItemId)
	{
		auto p = gtk_tool_item_get_proxy_menu_item(gtkToolItem, Str.toStringz(menuItemId));

		if(p is null)
		{
			return null;
		}

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

	/**
	 * Returns the relief style of @tool_item. See gtk_button_set_relief().
	 * Custom subclasses of #GtkToolItem should call this function in the handler
	 * of the #GtkToolItem::toolbar_reconfigured signal to find out the
	 * relief style of buttons.
	 *
	 * Returns: a #GtkReliefStyle indicating the relief style used
	 *     for @tool_item.
	 *
	 * Since: 2.4
	 */
	public GtkReliefStyle getReliefStyle()
	{
		return gtk_tool_item_get_relief_style(gtkToolItem);
	}

	/**
	 * Returns the text alignment used for @tool_item. Custom subclasses of
	 * #GtkToolItem should call this function to find out how text should
	 * be aligned.
	 *
	 * Returns: a #gfloat indicating the horizontal text alignment
	 *     used for @tool_item
	 *
	 * Since: 2.20
	 */
	public float getTextAlignment()
	{
		return gtk_tool_item_get_text_alignment(gtkToolItem);
	}

	/**
	 * Returns the text orientation used for @tool_item. Custom subclasses of
	 * #GtkToolItem should call this function to find out how text should
	 * be orientated.
	 *
	 * Returns: a #GtkOrientation indicating the text orientation
	 *     used for @tool_item
	 *
	 * Since: 2.20
	 */
	public GtkOrientation getTextOrientation()
	{
		return gtk_tool_item_get_text_orientation(gtkToolItem);
	}

	/**
	 * Returns the size group used for labels in @tool_item.
	 * Custom subclasses of #GtkToolItem should call this function
	 * and use the size group for labels.
	 *
	 * Returns: a #GtkSizeGroup
	 *
	 * Since: 2.20
	 */
	public SizeGroup getTextSizeGroup()
	{
		auto p = gtk_tool_item_get_text_size_group(gtkToolItem);

		if(p is null)
		{
			return null;
		}

		return ObjectG.getDObject!(SizeGroup)(cast(GtkSizeGroup*) p);
	}

	/**
	 * Returns the toolbar style used for @tool_item. Custom subclasses of
	 * #GtkToolItem should call this function in the handler of the
	 * GtkToolItem::toolbar_reconfigured signal to find out in what style
	 * the toolbar is displayed and change themselves accordingly
	 *
	 * Possibilities are:
	 * - %GTK_TOOLBAR_BOTH, meaning the tool item should show
	 * both an icon and a label, stacked vertically
	 * - %GTK_TOOLBAR_ICONS, meaning the toolbar shows only icons
	 * - %GTK_TOOLBAR_TEXT, meaning the tool item should only show text
	 * - %GTK_TOOLBAR_BOTH_HORIZ, meaning the tool item should show
	 * both an icon and a label, arranged horizontally
	 *
	 * Returns: A #GtkToolbarStyle indicating the toolbar style used
	 *     for @tool_item.
	 *
	 * Since: 2.4
	 */
	public GtkToolbarStyle getToolbarStyle()
	{
		return gtk_tool_item_get_toolbar_style(gtkToolItem);
	}

	/**
	 * Returns whether @tool_item has a drag window. See
	 * gtk_tool_item_set_use_drag_window().
	 *
	 * Returns: %TRUE if @tool_item uses a drag window.
	 *
	 * Since: 2.4
	 */
	public bool getUseDragWindow()
	{
		return gtk_tool_item_get_use_drag_window(gtkToolItem) != 0;
	}

	/**
	 * Returns whether the @tool_item is visible on toolbars that are
	 * docked horizontally.
	 *
	 * Returns: %TRUE if @tool_item is visible on toolbars that are
	 *     docked horizontally.
	 *
	 * Since: 2.4
	 */
	public bool getVisibleHorizontal()
	{
		return gtk_tool_item_get_visible_horizontal(gtkToolItem) != 0;
	}

	/**
	 * Returns whether @tool_item is visible when the toolbar is docked vertically.
	 * See gtk_tool_item_set_visible_vertical().
	 *
	 * Returns: Whether @tool_item is visible when the toolbar is docked vertically
	 *
	 * Since: 2.4
	 */
	public bool getVisibleVertical()
	{
		return gtk_tool_item_get_visible_vertical(gtkToolItem) != 0;
	}

	/**
	 * Calling this function signals to the toolbar that the
	 * overflow menu item for @tool_item has changed. If the
	 * overflow menu is visible when this function it called,
	 * the menu will be rebuilt.
	 *
	 * The function must be called when the tool item changes what it
	 * will do in response to the #GtkToolItem::create-menu-proxy signal.
	 *
	 * Since: 2.6
	 */
	public void rebuildMenu()
	{
		gtk_tool_item_rebuild_menu(gtkToolItem);
	}

	/**
	 * Returns the #GtkMenuItem that was last set by
	 * gtk_tool_item_set_proxy_menu_item(), ie. the #GtkMenuItem
	 * that is going to appear in the overflow menu.
	 *
	 * Returns: The #GtkMenuItem that is going to appear in the
	 *     overflow menu for @tool_item.
	 *
	 * Since: 2.4
	 */
	public Widget retrieveProxyMenuItem()
	{
		auto p = gtk_tool_item_retrieve_proxy_menu_item(gtkToolItem);

		if(p is null)
		{
			return null;
		}

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

	/**
	 * Sets whether @tool_item is allocated extra space when there
	 * is more room on the toolbar then needed for the items. The
	 * effect is that the item gets bigger when the toolbar gets bigger
	 * and smaller when the toolbar gets smaller.
	 *
	 * Params:
	 *     expand = Whether @tool_item is allocated extra space
	 *
	 * Since: 2.4
	 */
	public void setExpand(bool expand)
	{
		gtk_tool_item_set_expand(gtkToolItem, expand);
	}

	/**
	 * Sets whether @tool_item is to be allocated the same size as other
	 * homogeneous items. The effect is that all homogeneous items will have
	 * the same width as the widest of the items.
	 *
	 * Params:
	 *     homogeneous = whether @tool_item is the same size as other homogeneous items
	 *
	 * Since: 2.4
	 */
	public void setHomogeneous(bool homogeneous)
	{
		gtk_tool_item_set_homogeneous(gtkToolItem, homogeneous);
	}

	/**
	 * Sets whether @tool_item should be considered important. The #GtkToolButton
	 * class uses this property to determine whether to show or hide its label
	 * when the toolbar style is %GTK_TOOLBAR_BOTH_HORIZ. The result is that
	 * only tool buttons with the “is_important” property set have labels, an
	 * effect known as “priority text”
	 *
	 * Params:
	 *     isImportant = whether the tool item should be considered important
	 *
	 * Since: 2.4
	 */
	public void setIsImportant(bool isImportant)
	{
		gtk_tool_item_set_is_important(gtkToolItem, isImportant);
	}

	/**
	 * Sets the #GtkMenuItem used in the toolbar overflow menu. The
	 * @menu_item_id is used to identify the caller of this function and
	 * should also be used with gtk_tool_item_get_proxy_menu_item().
	 *
	 * See also #GtkToolItem::create-menu-proxy.
	 *
	 * Params:
	 *     menuItemId = a string used to identify @menu_item
	 *     menuItem = a #GtkMenuItem to use in the overflow menu, or %NULL
	 *
	 * Since: 2.4
	 */
	public void setProxyMenuItem(string menuItemId, Widget menuItem)
	{
		gtk_tool_item_set_proxy_menu_item(gtkToolItem, Str.toStringz(menuItemId), (menuItem is null) ? null : menuItem.getWidgetStruct());
	}

	/**
	 * Sets the markup text to be displayed as tooltip on the item.
	 * See gtk_widget_set_tooltip_markup().
	 *
	 * Params:
	 *     markup = markup text to be used as tooltip for @tool_item
	 *
	 * Since: 2.12
	 */
	public override void setTooltipMarkup(string markup)
	{
		gtk_tool_item_set_tooltip_markup(gtkToolItem, Str.toStringz(markup));
	}

	/**
	 * Sets the text to be displayed as tooltip on the item.
	 * See gtk_widget_set_tooltip_text().
	 *
	 * Params:
	 *     text = text to be used as tooltip for @tool_item
	 *
	 * Since: 2.12
	 */
	public override void setTooltipText(string text)
	{
		gtk_tool_item_set_tooltip_text(gtkToolItem, Str.toStringz(text));
	}

	/**
	 * Sets whether @tool_item has a drag window. When %TRUE the
	 * toolitem can be used as a drag source through gtk_drag_source_set().
	 * When @tool_item has a drag window it will intercept all events,
	 * even those that would otherwise be sent to a child of @tool_item.
	 *
	 * Params:
	 *     useDragWindow = Whether @tool_item has a drag window.
	 *
	 * Since: 2.4
	 */
	public void setUseDragWindow(bool useDragWindow)
	{
		gtk_tool_item_set_use_drag_window(gtkToolItem, useDragWindow);
	}

	/**
	 * Sets whether @tool_item is visible when the toolbar is docked horizontally.
	 *
	 * Params:
	 *     visibleHorizontal = Whether @tool_item is visible when in horizontal mode
	 *
	 * Since: 2.4
	 */
	public void setVisibleHorizontal(bool visibleHorizontal)
	{
		gtk_tool_item_set_visible_horizontal(gtkToolItem, visibleHorizontal);
	}

	/**
	 * Sets whether @tool_item is visible when the toolbar is docked
	 * vertically. Some tool items, such as text entries, are too wide to be
	 * useful on a vertically docked toolbar. If @visible_vertical is %FALSE
	 * @tool_item will not appear on toolbars that are docked vertically.
	 *
	 * Params:
	 *     visibleVertical = whether @tool_item is visible when the toolbar
	 *         is in vertical mode
	 *
	 * Since: 2.4
	 */
	public void setVisibleVertical(bool visibleVertical)
	{
		gtk_tool_item_set_visible_vertical(gtkToolItem, visibleVertical);
	}

	/**
	 * Emits the signal #GtkToolItem::toolbar_reconfigured on @tool_item.
	 * #GtkToolbar and other #GtkToolShell implementations use this function
	 * to notify children, when some aspect of their configuration changes.
	 *
	 * Since: 2.14
	 */
	public void toolbarReconfigured()
	{
		gtk_tool_item_toolbar_reconfigured(gtkToolItem);
	}

	protected class OnCreateMenuProxyDelegateWrapper
	{
		bool delegate(ToolItem) dlg;
		gulong handlerId;

		this(bool delegate(ToolItem) dlg)
		{
			this.dlg = dlg;
			onCreateMenuProxyListeners ~= this;
		}

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

	/**
	 * This signal is emitted when the toolbar needs information from @tool_item
	 * about whether the item should appear in the toolbar overflow menu. In
	 * response the tool item should either
	 *
	 * - call gtk_tool_item_set_proxy_menu_item() with a %NULL
	 * pointer and return %TRUE to indicate that the item should not appear
	 * in the overflow menu
	 *
	 * - call gtk_tool_item_set_proxy_menu_item() with a new menu
	 * item and return %TRUE, or
	 *
	 * - return %FALSE to indicate that the signal was not handled by the item.
	 * This means that the item will not appear in the overflow menu unless
	 * a later handler installs a menu item.
	 *
	 * The toolbar may cache the result of this signal. When the tool item changes
	 * how it will respond to this signal it must call gtk_tool_item_rebuild_menu()
	 * to invalidate the cache and ensure that the toolbar rebuilds its overflow
	 * menu.
	 *
	 * Returns: %TRUE if the signal was handled, %FALSE if not
	 */
	gulong addOnCreateMenuProxy(bool delegate(ToolItem) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		auto wrapper = new OnCreateMenuProxyDelegateWrapper(dlg);
		wrapper.handlerId = Signals.connectData(
			this,
			"create-menu-proxy",
			cast(GCallback)&callBackCreateMenuProxy,
			cast(void*)wrapper,
			cast(GClosureNotify)&callBackCreateMenuProxyDestroy,
			connectFlags);
		return wrapper.handlerId;
	}

	extern(C) static int callBackCreateMenuProxy(GtkToolItem* toolitemStruct, OnCreateMenuProxyDelegateWrapper wrapper)
	{
		return wrapper.dlg(wrapper.outer);
	}

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

	protected class OnToolbarReconfiguredDelegateWrapper
	{
		void delegate(ToolItem) dlg;
		gulong handlerId;

		this(void delegate(ToolItem) dlg)
		{
			this.dlg = dlg;
			onToolbarReconfiguredListeners ~= this;
		}

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

	/**
	 * This signal is emitted when some property of the toolbar that the
	 * item is a child of changes. For custom subclasses of #GtkToolItem,
	 * the default handler of this signal use the functions
	 * - gtk_tool_shell_get_orientation()
	 * - gtk_tool_shell_get_style()
	 * - gtk_tool_shell_get_icon_size()
	 * - gtk_tool_shell_get_relief_style()
	 * to find out what the toolbar should look like and change
	 * themselves accordingly.
	 */
	gulong addOnToolbarReconfigured(void delegate(ToolItem) dlg, ConnectFlags connectFlags=cast(ConnectFlags)0)
	{
		auto wrapper = new OnToolbarReconfiguredDelegateWrapper(dlg);
		wrapper.handlerId = Signals.connectData(
			this,
			"toolbar-reconfigured",
			cast(GCallback)&callBackToolbarReconfigured,
			cast(void*)wrapper,
			cast(GClosureNotify)&callBackToolbarReconfiguredDestroy,
			connectFlags);
		return wrapper.handlerId;
	}

	extern(C) static void callBackToolbarReconfigured(GtkToolItem* toolitemStruct, OnToolbarReconfiguredDelegateWrapper wrapper)
	{
		wrapper.dlg(wrapper.outer);
	}

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