source: appstream-generator/build/girepo/appstream/Icon.d @ 4841

Last change on this file since 4841 was 4841, checked in by Juanma, 2 years ago

Initial release

File size: 4.7 KB
Line 
1/*
2 * Licensed under the GNU Lesser General Public License Version 3
3 *
4 * This library is free software: you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as published by
6 * the Free Software Foundation, either version 3 of the license, or
7 * (at your option) any later version.
8 *
9 * This software is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 * GNU Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public License
15 * along with this library.  If not, see <http://www.gnu.org/licenses/>.
16 */
17
18// generated automatically - do not change
19
20
21module appstream.Icon;
22
23private import gi.appstream;
24public  import gi.appstreamtypes;
25private import glib.ConstructionException;
26private import glib.Str;
27private import gobject.ObjectG;
28
29
30/** */
31public class Icon : ObjectG
32{
33        /** the main Gtk struct */
34        protected AsIcon* asIcon;
35
36        /** Get the main Gtk struct */
37        public AsIcon* getIconStruct()
38        {
39                return asIcon;
40        }
41
42        /** the main Gtk struct as a void* */
43        protected override void* getStruct()
44        {
45                return cast(void*)asIcon;
46        }
47
48        protected override void setStruct(GObject* obj)
49        {
50                asIcon = cast(AsIcon*)obj;
51                super.setStruct(obj);
52        }
53
54        /**
55         * Sets our main struct and passes it to the parent class.
56         */
57        public this (AsIcon* asIcon, bool ownedRef = false)
58        {
59                this.asIcon = asIcon;
60                super(cast(GObject*)asIcon, ownedRef);
61        }
62
63
64        /** */
65        public static GType getType()
66        {
67                return as_icon_get_type();
68        }
69
70        /**
71         * Creates a new #AsIcon.
72         *
73         * Returns: a #AsIcon
74         *
75         * Throws: ConstructionException GTK+ fails to create the object.
76         */
77        public this()
78        {
79                auto p = as_icon_new();
80               
81                if(p is null)
82                {
83                        throw new ConstructionException("null returned by new");
84                }
85               
86                this(cast(AsIcon*) p, true);
87        }
88
89        /**
90         * Converts the text representation to an enumerated value.
91         *
92         * Params:
93         *     kindStr = the string.
94         *
95         * Returns: a #AsIconKind or %AS_ICON_KIND_UNKNOWN for unknown
96         */
97        public static AsIconKind kindFromString(string kindStr)
98        {
99                return as_icon_kind_from_string(Str.toStringz(kindStr));
100        }
101
102        /**
103         * Converts the enumerated value to an text representation.
104         *
105         * Params:
106         *     kind = the %AsIconKind.
107         *
108         * Returns: string version of @kind
109         */
110        public static string kindToString(AsIconKind kind)
111        {
112                return Str.toString(as_icon_kind_to_string(kind));
113        }
114
115        /**
116         * Returns: The absolute path for the icon on disk.
117         *     This is only set for icons of kind %AS_ICON_KIND_LOCAL or
118         *     %AS_ICON_KIND_CACHED.
119         */
120        public string getFilename()
121        {
122                return Str.toString(as_icon_get_filename(asIcon));
123        }
124
125        /**
126         * Returns: The icon height in pixels, or 0 if unknown.
127         */
128        public uint getHeight()
129        {
130                return as_icon_get_height(asIcon);
131        }
132
133        /**
134         * Gets the icon kind.
135         *
136         * Returns: the #AsIconKind
137         */
138        public AsIconKind getKind()
139        {
140                return as_icon_get_kind(asIcon);
141        }
142
143        /**
144         * Returns: the stock name of the icon. In case the icon is not of kind
145         *     "stock", the basename of the icon filename or URL is returned.
146         */
147        public string getName()
148        {
149                return Str.toString(as_icon_get_name(asIcon));
150        }
151
152        /**
153         * Gets the icon URL, pointing at a remote location. HTTPS and FTP urls are allowed.
154         * This property is only set for icons of type %AS_ICON_KIND_REMOTE
155         *
156         * Returns: the URL
157         */
158        public string getUrl()
159        {
160                return Str.toString(as_icon_get_url(asIcon));
161        }
162
163        /**
164         * Returns: The icon width in pixels, or 0 if unknown.
165         */
166        public uint getWidth()
167        {
168                return as_icon_get_width(asIcon);
169        }
170
171        /**
172         * Sets the icon absolute filename.
173         *
174         * Params:
175         *     filename = the new icon URL.
176         */
177        public void setFilename(string filename)
178        {
179                as_icon_set_filename(asIcon, Str.toStringz(filename));
180        }
181
182        /**
183         * Sets the icon height.
184         *
185         * Params:
186         *     height = the height in pixels.
187         */
188        public void setHeight(uint height)
189        {
190                as_icon_set_height(asIcon, height);
191        }
192
193        /**
194         * Sets the icon kind.
195         *
196         * Params:
197         *     kind = the #AsIconKind, e.g. %AS_ICON_KIND_CACHED.
198         */
199        public void setKind(AsIconKind kind)
200        {
201                as_icon_set_kind(asIcon, kind);
202        }
203
204        /**
205         * Sets the stock name or basename to use for the icon.
206         *
207         * Params:
208         *     name = the icon stock name, e.g. "gwenview"
209         */
210        public void setName(string name)
211        {
212                as_icon_set_name(asIcon, Str.toStringz(name));
213        }
214
215        /**
216         * Sets the icon URL.
217         *
218         * Params:
219         *     url = the new icon URL.
220         */
221        public void setUrl(string url)
222        {
223                as_icon_set_url(asIcon, Str.toStringz(url));
224        }
225
226        /**
227         * Sets the icon width.
228         *
229         * Params:
230         *     width = the width in pixels.
231         */
232        public void setWidth(uint width)
233        {
234                as_icon_set_width(asIcon, width);
235        }
236}
Note: See TracBrowser for help on using the repository browser.