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

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

Initial release

File size: 4.2 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.Image;
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 Image : ObjectG
32{
33        /** the main Gtk struct */
34        protected AsImage* asImage;
35
36        /** Get the main Gtk struct */
37        public AsImage* getImageStruct()
38        {
39                return asImage;
40        }
41
42        /** the main Gtk struct as a void* */
43        protected override void* getStruct()
44        {
45                return cast(void*)asImage;
46        }
47
48        protected override void setStruct(GObject* obj)
49        {
50                asImage = cast(AsImage*)obj;
51                super.setStruct(obj);
52        }
53
54        /**
55         * Sets our main struct and passes it to the parent class.
56         */
57        public this (AsImage* asImage, bool ownedRef = false)
58        {
59                this.asImage = asImage;
60                super(cast(GObject*)asImage, ownedRef);
61        }
62
63
64        /** */
65        public static GType getType()
66        {
67                return as_image_get_type();
68        }
69
70        /**
71         * Creates a new #AsImage.
72         *
73         * Returns: a #AsImage
74         *
75         * Throws: ConstructionException GTK+ fails to create the object.
76         */
77        public this()
78        {
79                auto p = as_image_new();
80               
81                if(p is null)
82                {
83                        throw new ConstructionException("null returned by new");
84                }
85               
86                this(cast(AsImage*) p, true);
87        }
88
89        /**
90         * Converts the text representation to an enumerated value.
91         *
92         * Params:
93         *     kind = the string.
94         *
95         * Returns: a #AsImageKind, or %AS_IMAGE_KIND_UNKNOWN for unknown.
96         */
97        public static AsImageKind kindFromString(string kind)
98        {
99                return as_image_kind_from_string(Str.toStringz(kind));
100        }
101
102        /**
103         * Converts the enumerated value to an text representation.
104         *
105         * Params:
106         *     kind = the #AsImageKind.
107         *
108         * Returns: string version of @kind
109         */
110        public static string kindToString(AsImageKind kind)
111        {
112                return Str.toString(as_image_kind_to_string(kind));
113        }
114
115        /**
116         * Gets the image height.
117         *
118         * Returns: height in pixels
119         */
120        public uint getHeight()
121        {
122                return as_image_get_height(asImage);
123        }
124
125        /**
126         * Gets the image kind.
127         *
128         * Returns: the #AsImageKind
129         */
130        public AsImageKind getKind()
131        {
132                return as_image_get_kind(asImage);
133        }
134
135        /**
136         * Get locale for this image.
137         *
138         * Returns: Locale string
139         *
140         * Since: 0.9.5
141         */
142        public string getLocale()
143        {
144                return Str.toString(as_image_get_locale(asImage));
145        }
146
147        /**
148         * Gets the full qualified URL for the image, usually pointing at some mirror.
149         *
150         * Returns: URL
151         */
152        public string getUrl()
153        {
154                return Str.toString(as_image_get_url(asImage));
155        }
156
157        /**
158         * Gets the image width.
159         *
160         * Returns: width in pixels
161         */
162        public uint getWidth()
163        {
164                return as_image_get_width(asImage);
165        }
166
167        /**
168         * Sets the image height.
169         *
170         * Params:
171         *     height = the height in pixels.
172         */
173        public void setHeight(uint height)
174        {
175                as_image_set_height(asImage, height);
176        }
177
178        /**
179         * Sets the image kind.
180         *
181         * Params:
182         *     kind = the #AsImageKind, e.g. %AS_IMAGE_KIND_THUMBNAIL.
183         */
184        public void setKind(AsImageKind kind)
185        {
186                as_image_set_kind(asImage, kind);
187        }
188
189        /**
190         * Sets the locale for this image.
191         *
192         * Params:
193         *     locale = the locale string.
194         *
195         * Since: 0.9.5
196         */
197        public void setLocale(string locale)
198        {
199                as_image_set_locale(asImage, Str.toStringz(locale));
200        }
201
202        /**
203         * Sets the fully-qualified mirror URL to use for the image.
204         *
205         * Params:
206         *     url = the URL.
207         */
208        public void setUrl(string url)
209        {
210                as_image_set_url(asImage, Str.toStringz(url));
211        }
212
213        /**
214         * Sets the image width.
215         *
216         * Params:
217         *     width = the width in pixels.
218         */
219        public void setWidth(uint width)
220        {
221                as_image_set_width(asImage, width);
222        }
223}
Note: See TracBrowser for help on using the repository browser.