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

public  import glib.Str;
public  import glib.Variant;
public  import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;


/**
 * This interface provides a convenient way of associating widgets with
 * actions on a #GtkApplicationWindow or #GtkApplication.
 * 
 * It primarily consists of two properties: #GtkActionable:action-name
 * and #GtkActionable:action-target. There are also some convenience APIs
 * for setting these properties.
 * 
 * The action will be looked up in action groups that are found among
 * the widgets ancestors. Most commonly, these will be the actions with
 * the “win.” or “app.” prefix that are associated with the #GtkApplicationWindow
 * or #GtkApplication, but other action groups that are added with
 * gtk_widget_insert_action_group() will be consulted as well.
 */
public template ActionableT(TStruct)
{
	/** Get the main Gtk struct */
	public GtkActionable* getActionableStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return cast(GtkActionable*)getStruct();
	}


	/**
	 * Gets the action name for @actionable.
	 *
	 * See gtk_actionable_set_action_name() for more information.
	 *
	 * Returns: the action name, or %NULL if none is set
	 *
	 * Since: 3.4
	 */
	public string getActionName()
	{
		return Str.toString(gtk_actionable_get_action_name(getActionableStruct()));
	}

	/**
	 * Gets the current target value of @actionable.
	 *
	 * See gtk_actionable_set_action_target_value() for more information.
	 *
	 * Returns: the current target value
	 *
	 * Since: 3.4
	 */
	public Variant getActionTargetValue()
	{
		auto p = gtk_actionable_get_action_target_value(getActionableStruct());

		if(p is null)
		{
			return null;
		}

		return new Variant(cast(GVariant*) p);
	}

	/**
	 * Specifies the name of the action with which this widget should be
	 * associated.  If @action_name is %NULL then the widget will be
	 * unassociated from any previous action.
	 *
	 * Usually this function is used when the widget is located (or will be
	 * located) within the hierarchy of a #GtkApplicationWindow.
	 *
	 * Names are of the form “win.save” or “app.quit” for actions on the
	 * containing #GtkApplicationWindow or its associated #GtkApplication,
	 * respectively.  This is the same form used for actions in the #GMenu
	 * associated with the window.
	 *
	 * Params:
	 *     actionName = an action name, or %NULL
	 *
	 * Since: 3.4
	 */
	public void setActionName(string actionName)
	{
		gtk_actionable_set_action_name(getActionableStruct(), Str.toStringz(actionName));
	}

	/**
	 * Sets the target value of an actionable widget.
	 *
	 * If @target_value is %NULL then the target value is unset.
	 *
	 * The target value has two purposes.  First, it is used as the
	 * parameter to activation of the action associated with the
	 * #GtkActionable widget. Second, it is used to determine if the widget
	 * should be rendered as “active” — the widget is active if the state
	 * is equal to the given target.
	 *
	 * Consider the example of associating a set of buttons with a #GAction
	 * with string state in a typical “radio button” situation.  Each button
	 * will be associated with the same action, but with a different target
	 * value for that action.  Clicking on a particular button will activate
	 * the action with the target of that button, which will typically cause
	 * the action’s state to change to that value.  Since the action’s state
	 * is now equal to the target value of the button, the button will now
	 * be rendered as active (and the other buttons, with different targets,
	 * rendered inactive).
	 *
	 * Params:
	 *     targetValue = a #GVariant to set as the target value, or %NULL
	 *
	 * Since: 3.4
	 */
	public void setActionTargetValue(Variant targetValue)
	{
		gtk_actionable_set_action_target_value(getActionableStruct(), (targetValue is null) ? null : targetValue.getVariantStruct());
	}

	/**
	 * Sets the action-name and associated string target value of an
	 * actionable widget.
	 *
	 * @detailed_action_name is a string in the format accepted by
	 * g_action_parse_detailed_name().
	 *
	 * (Note that prior to version 3.22.25,
	 * this function is only usable for actions with a simple "s" target, and
	 * @detailed_action_name must be of the form `"action::target"` where
	 * `action` is the action name and `target` is the string to use
	 * as the target.)
	 *
	 * Params:
	 *     detailedActionName = the detailed action name
	 *
	 * Since: 3.4
	 */
	public void setDetailedActionName(string detailedActionName)
	{
		gtk_actionable_set_detailed_action_name(getActionableStruct(), Str.toStringz(detailedActionName));
	}
}