dazzle.ProgressMenuButton source code

1 /*
2  * This file is part of d-dazzle.
3  *
4  * d-dazzle is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 3
7  * of the License, or (at your option) any later version, with
8  * some exceptions, please read the COPYING file.
9  *
10  * d-dazzle is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public License
16  * along with d-dazzle; if not, write to the Free Software
17  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
18  */
19 module dazzle.ProgressMenuButton;
20 
21 private import dazzle.c.functions;
22 public  import dazzle.c.types;
23 private import glib.ConstructionException;
24 private import gobject.ObjectG;
25 private import gtk.ActionableIF;
26 private import gtk.ActionableT;
27 private import gtk.ActivatableIF;
28 private import gtk.ActivatableT;
29 private import gtk.BuildableIF;
30 private import gtk.BuildableT;
31 private import gtk.MenuButton;
32 private import gtk.Widget;
33 
34 
35 /** */
36 public class ProgressMenuButton : MenuButton
37 {
38 	/** the main Gtk struct */
39 	protected DzlProgressMenuButton* dzlProgressMenuButton;
40 
41 	/** Get the main Gtk struct */
42 	public DzlProgressMenuButton* getProgressMenuButtonStruct(bool transferOwnership = false)
43 	{
44 		if (transferOwnership)
45 			ownedRef = false;
46 		return dzlProgressMenuButton;
47 	}
48 
49 	/** the main Gtk struct as a void* */
50 	protected override void* getStruct()
51 	{
52 		return cast(void*)dzlProgressMenuButton;
53 	}
54 
55 	/**
56 	 * Sets our main struct and passes it to the parent class.
57 	 */
58 	public this (DzlProgressMenuButton* dzlProgressMenuButton, bool ownedRef = false)
59 	{
60 		this.dzlProgressMenuButton = dzlProgressMenuButton;
61 		super(cast(GtkMenuButton*)dzlProgressMenuButton, ownedRef);
62 	}
63 
64 
65 	/** */
66 	public static GType getType()
67 	{
68 		return dzl_progress_menu_button_get_type();
69 	}
70 
71 	/** */
72 	public this()
73 	{
74 		auto p = dzl_progress_menu_button_new();
75 
76 		if(p is null)
77 		{
78 			throw new ConstructionException("null returned by new");
79 		}
80 
81 		this(cast(DzlProgressMenuButton*) p);
82 	}
83 
84 	/** */
85 	public double getProgress()
86 	{
87 		return dzl_progress_menu_button_get_progress(dzlProgressMenuButton);
88 	}
89 
90 	/** */
91 	public bool getShowProgress()
92 	{
93 		return dzl_progress_menu_button_get_show_progress(dzlProgressMenuButton) != 0;
94 	}
95 
96 	/** */
97 	public bool getShowTheatric()
98 	{
99 		return dzl_progress_menu_button_get_show_theatric(dzlProgressMenuButton) != 0;
100 	}
101 
102 	/**
103 	 * To avoid suprious animations from the button, you must call this function any
104 	 * time you want to allow animations to continue. This is because animations are
105 	 * automatically started upon reaching a progress of 1.0.
106 	 *
107 	 * If you are performing operations in the background, calling this function
108 	 * every time you add an operation is a good strategry.
109 	 */
110 	public void resetTheatrics()
111 	{
112 		dzl_progress_menu_button_reset_theatrics(dzlProgressMenuButton);
113 	}
114 
115 	/** */
116 	public void setProgress(double progress)
117 	{
118 		dzl_progress_menu_button_set_progress(dzlProgressMenuButton, progress);
119 	}
120 
121 	/** */
122 	public void setShowProgress(bool showProgress)
123 	{
124 		dzl_progress_menu_button_set_show_progress(dzlProgressMenuButton, showProgress);
125 	}
126 
127 	/** */
128 	public void setShowTheatric(bool showTheatic)
129 	{
130 		dzl_progress_menu_button_set_show_theatric(dzlProgressMenuButton, showTheatic);
131 	}
132 }