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

private import glib.ConstructionException;
private import gobject.ObjectG;
private import gtk.ActivatableIF;
private import gtk.ActivatableT;
private import gtk.Menu;
private import gtk.RecentChooserIF;
private import gtk.RecentChooserT;
private import gtk.RecentManager;
private import gtk.Widget;
private import gtk.c.functions;
public  import gtk.c.types;
public  import gtkc.gtktypes;


/**
 * #GtkRecentChooserMenu is a widget suitable for displaying recently used files
 * inside a menu.  It can be used to set a sub-menu of a #GtkMenuItem using
 * gtk_menu_item_set_submenu(), or as the menu of a #GtkMenuToolButton.
 * 
 * Note that #GtkRecentChooserMenu does not have any methods of its own. Instead,
 * you should use the functions that work on a #GtkRecentChooser.
 * 
 * Note also that #GtkRecentChooserMenu does not support multiple filters, as it
 * has no way to let the user choose between them as the #GtkRecentChooserWidget
 * and #GtkRecentChooserDialog widgets do. Thus using gtk_recent_chooser_add_filter()
 * on a #GtkRecentChooserMenu widget will yield the same effects as using
 * gtk_recent_chooser_set_filter(), replacing any currently set filter
 * with the supplied filter; gtk_recent_chooser_remove_filter() will remove
 * any currently set #GtkRecentFilter object and will unset the current filter;
 * gtk_recent_chooser_list_filters() will return a list containing a single
 * #GtkRecentFilter object.
 * 
 * Recently used files are supported since GTK+ 2.10.
 */
public class RecentChooserMenu : Menu, ActivatableIF, RecentChooserIF
{
	/** the main Gtk struct */
	protected GtkRecentChooserMenu* gtkRecentChooserMenu;

	/** Get the main Gtk struct */
	public GtkRecentChooserMenu* getRecentChooserMenuStruct(bool transferOwnership = false)
	{
		if (transferOwnership)
			ownedRef = false;
		return gtkRecentChooserMenu;
	}

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

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

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

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

	// add the RecentChooser capabilities
	mixin RecentChooserT!(GtkRecentChooserMenu);


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

	/**
	 * Creates a new #GtkRecentChooserMenu widget.
	 *
	 * This kind of widget shows the list of recently used resources as
	 * a menu, each item as a menu item.  Each item inside the menu might
	 * have an icon, representing its MIME type, and a number, for mnemonic
	 * access.
	 *
	 * This widget implements the #GtkRecentChooser interface.
	 *
	 * This widget creates its own #GtkRecentManager object.  See the
	 * gtk_recent_chooser_menu_new_for_manager() function to know how to create
	 * a #GtkRecentChooserMenu widget bound to another #GtkRecentManager object.
	 *
	 * Returns: a new #GtkRecentChooserMenu
	 *
	 * Since: 2.10
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this()
	{
		auto p = gtk_recent_chooser_menu_new();

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

		this(cast(GtkRecentChooserMenu*) p);
	}

	/**
	 * Creates a new #GtkRecentChooserMenu widget using @manager as
	 * the underlying recently used resources manager.
	 *
	 * This is useful if you have implemented your own recent manager,
	 * or if you have a customized instance of a #GtkRecentManager
	 * object or if you wish to share a common #GtkRecentManager object
	 * among multiple #GtkRecentChooser widgets.
	 *
	 * Params:
	 *     manager = a #GtkRecentManager
	 *
	 * Returns: a new #GtkRecentChooserMenu, bound to @manager.
	 *
	 * Since: 2.10
	 *
	 * Throws: ConstructionException GTK+ fails to create the object.
	 */
	public this(RecentManager manager)
	{
		auto p = gtk_recent_chooser_menu_new_for_manager((manager is null) ? null : manager.getRecentManagerStruct());

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

		this(cast(GtkRecentChooserMenu*) p);
	}

	/**
	 * Returns the value set by gtk_recent_chooser_menu_set_show_numbers().
	 *
	 * Returns: %TRUE if numbers should be shown.
	 *
	 * Since: 2.10
	 */
	public bool getShowNumbers()
	{
		return gtk_recent_chooser_menu_get_show_numbers(gtkRecentChooserMenu) != 0;
	}

	/**
	 * Sets whether a number should be added to the items of @menu.  The
	 * numbers are shown to provide a unique character for a mnemonic to
	 * be used inside ten menu item’s label.  Only the first the items
	 * get a number to avoid clashes.
	 *
	 * Params:
	 *     showNumbers = whether to show numbers
	 *
	 * Since: 2.10
	 */
	public void setShowNumbers(bool showNumbers)
	{
		gtk_recent_chooser_menu_set_show_numbers(gtkRecentChooserMenu, showNumbers);
	}
}