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

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

Initial release

File size: 3.3 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.Validator;
22
23private import gi.appstream;
24public  import gi.appstreamtypes;
25private import gio.FileIF;
26private import glib.ConstructionException;
27private import glib.ListG;
28private import glib.Str;
29private import gobject.ObjectG;
30
31
32/** */
33public class Validator : ObjectG
34{
35        /** the main Gtk struct */
36        protected AsValidator* asValidator;
37
38        /** Get the main Gtk struct */
39        public AsValidator* getValidatorStruct()
40        {
41                return asValidator;
42        }
43
44        /** the main Gtk struct as a void* */
45        protected override void* getStruct()
46        {
47                return cast(void*)asValidator;
48        }
49
50        protected override void setStruct(GObject* obj)
51        {
52                asValidator = cast(AsValidator*)obj;
53                super.setStruct(obj);
54        }
55
56        /**
57         * Sets our main struct and passes it to the parent class.
58         */
59        public this (AsValidator* asValidator, bool ownedRef = false)
60        {
61                this.asValidator = asValidator;
62                super(cast(GObject*)asValidator, ownedRef);
63        }
64
65
66        /** */
67        public static GType getType()
68        {
69                return as_validator_get_type();
70        }
71
72        /**
73         * Creates a new #AsValidator.
74         *
75         * Returns: an #AsValidator
76         *
77         * Throws: ConstructionException GTK+ fails to create the object.
78         */
79        public this()
80        {
81                auto p = as_validator_new();
82               
83                if(p is null)
84                {
85                        throw new ConstructionException("null returned by new");
86                }
87               
88                this(cast(AsValidator*) p, true);
89        }
90
91        /**
92         * Clears the list of issues
93         */
94        public void clearIssues()
95        {
96                as_validator_clear_issues(asValidator);
97        }
98
99        /**
100         * Get a list of found metadata format issues.
101         *
102         * Returns: a list of #AsValidatorIssue instances, free with g_list_free()
103         */
104        public ListG getIssues()
105        {
106                auto p = as_validator_get_issues(asValidator);
107               
108                if(p is null)
109                {
110                        return null;
111                }
112               
113                return new ListG(cast(GList*) p);
114        }
115
116        /**
117         * Validate AppStream XML data
118         *
119         * Params:
120         *     metadata = XML metadata.
121         */
122        public bool validateData(string metadata)
123        {
124                return as_validator_validate_data(asValidator, Str.toStringz(metadata)) != 0;
125        }
126
127        /**
128         * Validate an AppStream XML file
129         *
130         * Params:
131         *     metadataFile = An AppStream XML file.
132         */
133        public bool validateFile(FileIF metadataFile)
134        {
135                return as_validator_validate_file(asValidator, (metadataFile is null) ? null : metadataFile.getFileStruct()) != 0;
136        }
137
138        /**
139         * Validate a full directory tree for issues in AppStream metadata.
140         *
141         * Params:
142         *     rootDir = The root directory of the filesystem tree that should be validated.
143         */
144        public bool validateTree(string rootDir)
145        {
146                return as_validator_validate_tree(asValidator, Str.toStringz(rootDir)) != 0;
147        }
148}
Note: See TracBrowser for help on using the repository browser.