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

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

Initial release

File size: 4.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 gio.Vfs;
22
23private import gi.gio;
24public  import gi.giotypes;
25private import gio.File;
26private import gio.FileIF;
27private import glib.Str;
28private import gobject.ObjectG;
29
30
31/**
32 * Entry point for using GIO functionality.
33 */
34public class Vfs : ObjectG
35{
36        /** the main Gtk struct */
37        protected GVfs* gVfs;
38
39        /** Get the main Gtk struct */
40        public GVfs* getVfsStruct()
41        {
42                return gVfs;
43        }
44
45        /** the main Gtk struct as a void* */
46        protected override void* getStruct()
47        {
48                return cast(void*)gVfs;
49        }
50
51        protected override void setStruct(GObject* obj)
52        {
53                gVfs = cast(GVfs*)obj;
54                super.setStruct(obj);
55        }
56
57        /**
58         * Sets our main struct and passes it to the parent class.
59         */
60        public this (GVfs* gVfs, bool ownedRef = false)
61        {
62                this.gVfs = gVfs;
63                super(cast(GObject*)gVfs, ownedRef);
64        }
65
66
67        /** */
68        public static GType getType()
69        {
70                return g_vfs_get_type();
71        }
72
73        /**
74         * Gets the default #GVfs for the system.
75         *
76         * Returns: a #GVfs.
77         */
78        public static Vfs getDefault()
79        {
80                auto p = g_vfs_get_default();
81               
82                if(p is null)
83                {
84                        return null;
85                }
86               
87                return ObjectG.getDObject!(Vfs)(cast(GVfs*) p);
88        }
89
90        /**
91         * Gets the local #GVfs for the system.
92         *
93         * Returns: a #GVfs.
94         */
95        public static Vfs getLocal()
96        {
97                auto p = g_vfs_get_local();
98               
99                if(p is null)
100                {
101                        return null;
102                }
103               
104                return ObjectG.getDObject!(Vfs)(cast(GVfs*) p);
105        }
106
107        /**
108         * Gets a #GFile for @path.
109         *
110         * Params:
111         *     path = a string containing a VFS path.
112         *
113         * Returns: a #GFile.
114         *     Free the returned object with g_object_unref().
115         */
116        public FileIF getFileForPath(string path)
117        {
118                auto p = g_vfs_get_file_for_path(gVfs, Str.toStringz(path));
119               
120                if(p is null)
121                {
122                        return null;
123                }
124               
125                return ObjectG.getDObject!(File, FileIF)(cast(GFile*) p, true);
126        }
127
128        /**
129         * Gets a #GFile for @uri.
130         *
131         * This operation never fails, but the returned object
132         * might not support any I/O operation if the URI
133         * is malformed or if the URI scheme is not supported.
134         *
135         * Params:
136         *     uri = a string containing a URI
137         *
138         * Returns: a #GFile.
139         *     Free the returned object with g_object_unref().
140         */
141        public FileIF getFileForUri(string uri)
142        {
143                auto p = g_vfs_get_file_for_uri(gVfs, Str.toStringz(uri));
144               
145                if(p is null)
146                {
147                        return null;
148                }
149               
150                return ObjectG.getDObject!(File, FileIF)(cast(GFile*) p, true);
151        }
152
153        /**
154         * Gets a list of URI schemes supported by @vfs.
155         *
156         * Returns: a %NULL-terminated array of strings.
157         *     The returned array belongs to GIO and must
158         *     not be freed or modified.
159         */
160        public string[] getSupportedUriSchemes()
161        {
162                return Str.toStringArray(g_vfs_get_supported_uri_schemes(gVfs));
163        }
164
165        /**
166         * Checks if the VFS is active.
167         *
168         * Returns: %TRUE if construction of the @vfs was successful
169         *     and it is now active.
170         */
171        public bool isActive()
172        {
173                return g_vfs_is_active(gVfs) != 0;
174        }
175
176        /**
177         * This operation never fails, but the returned object might
178         * not support any I/O operations if the @parse_name cannot
179         * be parsed by the #GVfs module.
180         *
181         * Params:
182         *     parseName = a string to be parsed by the VFS module.
183         *
184         * Returns: a #GFile for the given @parse_name.
185         *     Free the returned object with g_object_unref().
186         */
187        public FileIF parseName(string parseName)
188        {
189                auto p = g_vfs_parse_name(gVfs, Str.toStringz(parseName));
190               
191                if(p is null)
192                {
193                        return null;
194                }
195               
196                return ObjectG.getDObject!(File, FileIF)(cast(GFile*) p, true);
197        }
198}
Note: See TracBrowser for help on using the repository browser.