/*
 * 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

/*
 * Conversion parameters:
 * inFile  = GtkActionable.html
 * outPack = gtk
 * outFile = ActionableT
 * strct   = GtkActionable
 * realStrct=
 * ctorStrct=
 * clss    = ActionableT
 * interf  = ActionableIF
 * class Code: No
 * interface Code: No
 * template for:
 * 	- TStruct
 * extend  = 
 * implements:
 * prefixes:
 * 	- gtk_actionable_
 * omit structs:
 * omit prefixes:
 * omit code:
 * omit signals:
 * imports:
 * 	- glib.Str
 * 	- glib.Variant
 * structWrap:
 * 	- GVariant* -> Variant
 * module aliases:
 * local aliases:
 * overrides:
 */

module gtk.ActionableT;

public  import gtkc.gtktypes;

public import gtkc.gtk;
public import glib.ConstructionException;
public import gobject.ObjectG;

public import glib.Str;
public import glib.Variant;



/**
 * This interface provides a convenient way of associating widgets with
 * actions on a GtkApplicationWindow or GtkApplication.
 *
 * It primarily consists of two properties: "action-name"
 * and "action-target". There are also some convenience APIs
 * for setting these properties.
 *
 * This interface is presently only meaningful if used on a widget that
 * is (or will be) located inside of a GtkApplicationWindow and can
 * only be used to associate the widget with actions on that window, or
 * its associated GtkApplication.
 */
public template ActionableT(TStruct)
{
	
	/** the main Gtk struct */
	protected GtkActionable* gtkActionable;
	
	
	/** Get the main Gtk struct */
	public GtkActionable* getActionableTStruct()
	{
		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()
	{
		// const gchar * gtk_actionable_get_action_name (GtkActionable *actionable);
		return Str.toString(gtk_actionable_get_action_name(getActionableTStruct()));
	}
	
	/**
	 * 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)
	{
		// void gtk_actionable_set_action_name (GtkActionable *actionable,  const gchar *action_name);
		gtk_actionable_set_action_name(getActionableTStruct(), Str.toStringz(actionName));
	}
	
	/**
	 * Gets the current target value of actionabe.
	 * See gtk_actionable_set_action_target_value() for more information.
	 * Returns: the current target value. [transfer none] Since 3.4
	 */
	public Variant getActionTargetValue()
	{
		// GVariant * gtk_actionable_get_action_target_value  (GtkActionable *actionable);
		auto p = gtk_actionable_get_action_target_value(getActionableTStruct());
		
		if(p is null)
		{
			return null;
		}
		
		return ObjectG.getDObject!(Variant)(cast(GVariant*) p);
	}
	
	/**
	 * 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)
	{
		// void gtk_actionable_set_action_target_value  (GtkActionable *actionable,  GVariant *target_value);
		gtk_actionable_set_action_target_value(getActionableTStruct(), (targetValue is null) ? null : targetValue.getVariantStruct());
	}
	
	/**
	 * Sets the action-name and associated string target value of an
	 * actionable widget.
	 * This allows for the effect of both gtk_actionable_set_action_name()
	 * and gtk_actionable_set_action_target_value() in the common case that
	 * the target is string-valued.
	 * detailed_action_name is a string 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)
	{
		// void gtk_actionable_set_detailed_action_name  (GtkActionable *actionable,  const gchar *detailed_action_name);
		gtk_actionable_set_detailed_action_name(getActionableTStruct(), Str.toStringz(detailedActionName));
	}
}