File: IconSize.d

package info (click to toggle)
gtk-d 3.10.0-5
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 20,204 kB
  • sloc: javascript: 565; sh: 71; makefile: 23
file content (154 lines) | stat: -rw-r--r-- 4,915 bytes parent folder | download | duplicates (5)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/*
 * 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.IconSize;

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


/** */
public struct IconSize
{

	/**
	 * Looks up the icon size associated with @name.
	 *
	 * Deprecated: Use #GtkIconTheme instead.
	 *
	 * Params:
	 *     name = the name to look up.
	 *
	 * Returns: the icon size (#GtkIconSize)
	 */
	public static GtkIconSize fromName(string name)
	{
		return gtk_icon_size_from_name(Str.toStringz(name));
	}

	/**
	 * Gets the canonical name of the given icon size. The returned string
	 * is statically allocated and should not be freed.
	 *
	 * Deprecated: Use #GtkIconTheme instead.
	 *
	 * Params:
	 *     size = a #GtkIconSize.
	 *
	 * Returns: the name of the given icon size.
	 */
	public static string getName(GtkIconSize size)
	{
		return Str.toString(gtk_icon_size_get_name(size));
	}

	/**
	 * Obtains the pixel size of a semantic icon size @size:
	 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc.  This function
	 * isn’t normally needed, gtk_icon_theme_load_icon() is the usual
	 * way to get an icon for rendering, then just look at the size of
	 * the rendered pixbuf. The rendered pixbuf may not even correspond to
	 * the width/height returned by gtk_icon_size_lookup(), because themes
	 * are free to render the pixbuf however they like, including changing
	 * the usual size.
	 *
	 * Params:
	 *     size = an icon size (#GtkIconSize)
	 *     width = location to store icon width
	 *     height = location to store icon height
	 *
	 * Returns: %TRUE if @size was a valid size
	 */
	public static bool lookup(GtkIconSize size, out int width, out int height)
	{
		return gtk_icon_size_lookup(size, &width, &height) != 0;
	}

	/**
	 * Obtains the pixel size of a semantic icon size, possibly
	 * modified by user preferences for a particular
	 * #GtkSettings. Normally @size would be
	 * #GTK_ICON_SIZE_MENU, #GTK_ICON_SIZE_BUTTON, etc.  This function
	 * isn’t normally needed, gtk_widget_render_icon_pixbuf() is the usual
	 * way to get an icon for rendering, then just look at the size of
	 * the rendered pixbuf. The rendered pixbuf may not even correspond to
	 * the width/height returned by gtk_icon_size_lookup(), because themes
	 * are free to render the pixbuf however they like, including changing
	 * the usual size.
	 *
	 * Deprecated: Use gtk_icon_size_lookup() instead.
	 *
	 * Params:
	 *     settings = a #GtkSettings object, used to determine
	 *         which set of user preferences to used.
	 *     size = an icon size (#GtkIconSize)
	 *     width = location to store icon width
	 *     height = location to store icon height
	 *
	 * Returns: %TRUE if @size was a valid size
	 *
	 * Since: 2.2
	 */
	public static bool lookupForSettings(Settings settings, GtkIconSize size, out int width, out int height)
	{
		return gtk_icon_size_lookup_for_settings((settings is null) ? null : settings.getSettingsStruct(), size, &width, &height) != 0;
	}

	/**
	 * Registers a new icon size, along the same lines as #GTK_ICON_SIZE_MENU,
	 * etc. Returns the integer value for the size.
	 *
	 * Deprecated: Use #GtkIconTheme instead.
	 *
	 * Params:
	 *     name = name of the icon size
	 *     width = the icon width
	 *     height = the icon height
	 *
	 * Returns: integer value representing the size (#GtkIconSize)
	 */
	public static GtkIconSize register(string name, int width, int height)
	{
		return gtk_icon_size_register(Str.toStringz(name), width, height);
	}

	/**
	 * Registers @alias as another name for @target.
	 * So calling gtk_icon_size_from_name() with @alias as argument
	 * will return @target.
	 *
	 * Deprecated: Use #GtkIconTheme instead.
	 *
	 * Params:
	 *     alias_ = an alias for @target
	 *     target = an existing icon size (#GtkIconSize)
	 */
	public static void registerAlias(string alias_, GtkIconSize target)
	{
		gtk_icon_size_register_alias(Str.toStringz(alias_), target);
	}
}