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

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

Initial release

File size: 5.1 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.Screenshot;
22
23private import appstream.Image;
24private import gi.appstream;
25public  import gi.appstreamtypes;
26private import glib.ConstructionException;
27private import glib.PtrArray;
28private import glib.Str;
29private import gobject.ObjectG;
30
31
32/** */
33public class Screenshot : ObjectG
34{
35        /** the main Gtk struct */
36        protected AsScreenshot* asScreenshot;
37
38        /** Get the main Gtk struct */
39        public AsScreenshot* getScreenshotStruct()
40        {
41                return asScreenshot;
42        }
43
44        /** the main Gtk struct as a void* */
45        protected override void* getStruct()
46        {
47                return cast(void*)asScreenshot;
48        }
49
50        protected override void setStruct(GObject* obj)
51        {
52                asScreenshot = cast(AsScreenshot*)obj;
53                super.setStruct(obj);
54        }
55
56        /**
57         * Sets our main struct and passes it to the parent class.
58         */
59        public this (AsScreenshot* asScreenshot, bool ownedRef = false)
60        {
61                this.asScreenshot = asScreenshot;
62                super(cast(GObject*)asScreenshot, ownedRef);
63        }
64
65
66        /** */
67        public static GType getType()
68        {
69                return as_screenshot_get_type();
70        }
71
72        /**
73         * Creates a new #AsScreenshot.
74         *
75         * Returns: a #AsScreenshot
76         *
77         * Throws: ConstructionException GTK+ fails to create the object.
78         */
79        public this()
80        {
81                auto p = as_screenshot_new();
82               
83                if(p is null)
84                {
85                        throw new ConstructionException("null returned by new");
86                }
87               
88                this(cast(AsScreenshot*) p, true);
89        }
90
91        /**
92         * Converts the text representation to an enumerated value.
93         *
94         * Params:
95         *     kind = the string.
96         *
97         * Returns: a %AsScreenshotKind, or %AS_SCREENSHOT_KIND_UNKNOWN if not known.
98         */
99        public static AsScreenshotKind kindFromString(string kind)
100        {
101                return as_screenshot_kind_from_string(Str.toStringz(kind));
102        }
103
104        /**
105         * Converts the enumerated value to an text representation.
106         *
107         * Params:
108         *     kind = the #AsScreenshotKind.
109         *
110         * Returns: string version of @kind
111         */
112        public static string kindToString(AsScreenshotKind kind)
113        {
114                return Str.toString(as_screenshot_kind_to_string(kind));
115        }
116
117        /**
118         * Adds an image to the screenshot.
119         *
120         * Params:
121         *     image = a #AsImage instance.
122         */
123        public void addImage(Image image)
124        {
125                as_screenshot_add_image(asScreenshot, (image is null) ? null : image.getImageStruct());
126        }
127
128        /**
129         * Get the current active locale, which
130         * is used to get localized messages.
131         */
132        public string getActiveLocale()
133        {
134                auto retStr = as_screenshot_get_active_locale(asScreenshot);
135               
136                scope(exit) Str.freeString(retStr);
137                return Str.toString(retStr);
138        }
139
140        /**
141         * Gets the image caption
142         *
143         * Returns: the caption
144         */
145        public string getCaption()
146        {
147                return Str.toString(as_screenshot_get_caption(asScreenshot));
148        }
149
150        /**
151         * Gets the images for this screenshots. Only images valid for the current
152         * language are returned. We return all sizes.
153         *
154         * Returns: an array
155         */
156        public PtrArray getImages()
157        {
158                auto p = as_screenshot_get_images(asScreenshot);
159               
160                if(p is null)
161                {
162                        return null;
163                }
164               
165                return new PtrArray(cast(GPtrArray*) p);
166        }
167
168        /**
169         * Returns an array of all images we have, regardless of their
170         * size and language.
171         *
172         * Returns: an array
173         *
174         * Since: 0.10
175         */
176        public PtrArray getImagesAll()
177        {
178                auto p = as_screenshot_get_images_all(asScreenshot);
179               
180                if(p is null)
181                {
182                        return null;
183                }
184               
185                return new PtrArray(cast(GPtrArray*) p);
186        }
187
188        /**
189         * Gets the screenshot kind.
190         *
191         * Returns: a #AsScreenshotKind
192         */
193        public AsScreenshotKind getKind()
194        {
195                return as_screenshot_get_kind(asScreenshot);
196        }
197
198        /**
199         * Performs a quick validation on this screenshot
200         *
201         * Returns: TRUE if the screenshot is a complete #AsScreenshot
202         */
203        public bool isValid()
204        {
205                return as_screenshot_is_valid(asScreenshot) != 0;
206        }
207
208        /**
209         * Set the current active locale, which
210         * is used to get localized messages.
211         * If the #AsComponent linking this #AsScreenshot was fetched
212         * from a localized database, usually only
213         * one locale is available.
214         */
215        public void setActiveLocale(string locale)
216        {
217                as_screenshot_set_active_locale(asScreenshot, Str.toStringz(locale));
218        }
219
220        /**
221         * Sets a caption on the screenshot
222         *
223         * Params:
224         *     caption = the caption text.
225         */
226        public void setCaption(string caption, string locale)
227        {
228                as_screenshot_set_caption(asScreenshot, Str.toStringz(caption), Str.toStringz(locale));
229        }
230
231        /**
232         * Sets the screenshot kind.
233         *
234         * Params:
235         *     kind = the #AsScreenshotKind.
236         */
237        public void setKind(AsScreenshotKind kind)
238        {
239                as_screenshot_set_kind(asScreenshot, kind);
240        }
241}
Note: See TracBrowser for help on using the repository browser.