<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>glibmm 2.4: Gio::Vfs Class Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head>
<body bgcolor="#ffffff">
<table border="0" width="100%">
<tr>
<td width="10%" height="40"><img src="../../images/gtkmm_logo.gif" alt="logo" border="0" width="100%" height="100%"/></td>
<td width="90%" height="40"><img src="../../images/top.gif" alt="top" width="100%" height="40"/></td>
</tr>
</table>
<center>
<a class="qindex" href="../../../../gtkmm-2.4/docs/index.html">Main Page</a>
<a href="../../../../gtkmm-2.4/docs/reference/html/group__Widgets.html">Widgets</a>
<a class="qindex" href="namespaces.html">glibmm Namespaces</a>
<a href="../../../../gtkmm-2.4/docs/tutorial/html/index.html"> Book</a>
</center>
<hr width="100%"/>
<!-- begin main content -->
<div id="content">
<!-- Generated by Doxygen 1.5.3 -->
<div class="nav">
<a class="el" href="namespaceGio.html">Gio</a>::<a class="el" href="classGio_1_1Vfs.html">Vfs</a></div>
<h1>Gio::Vfs Class Reference</h1><!-- doxytag: class="Gio::Vfs" --><!-- doxytag: inherits="Glib::Object" -->Entry point for using GIO functionality.
<a href="#_details">More...</a>
<p>
<div class="dynheader">
Inheritance diagram for Gio::Vfs:</div>
<div class="dynsection">
<p><center><img src="classGio_1_1Vfs__inherit__graph.png" border="0" usemap="#Gio_1_1Vfs__inherit__map" alt="Inheritance graph"></center>
<map name="Gio_1_1Vfs__inherit__map">
<area shape="rect" href="classGlib_1_1Object.html" title="Glib::Object" alt="" coords="21,161,115,188"><area shape="rect" href="classGlib_1_1ObjectBase.html" title="Glib::ObjectBase is a common base class for Objects and Interfaces." alt="" coords="5,84,131,111"><area shape="rect" href="classsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="12,7,124,33"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classGio_1_1Vfs-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#cd46536f0510d8c184dc7da1c7fcecd5">~Vfs</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GVfs* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#c0fa6be64df6573ab2fef062d2e27142">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#c0fa6be64df6573ab2fef062d2e27142"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GVfs* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#809317bf98bfa9d4cd1901b876b1663f">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#809317bf98bfa9d4cd1901b876b1663f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GVfs* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#1214cf83afa9b98ea7419732a17d7947">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#1214cf83afa9b98ea7419732a17d7947"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1File.html">File</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#80396102cfefce571542c13b02e6a92d">file_for_path</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& path)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a> for <em>path</em>. <a href="#80396102cfefce571542c13b02e6a92d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1File.html">File</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#2777c4c3baaf761700cbad0e2ac560ff">file_for_uri</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& uri)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets a <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a> for <em>uri</em>. <a href="#2777c4c3baaf761700cbad0e2ac560ff"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1File.html">File</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#36596855d53b7485ee35b50faabdbceb">parse_name</a> (const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a>& parse_name)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">This operation never fails, but the returned object might not support any I/O operations if the <em>parse_name</em> cannot be parsed by the <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a> module. <a href="#36596855d53b7485ee35b50faabdbceb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#565b0fe0c4cde7cc041966ff7fad8c7a">is_active</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Checks if the VFS is active. <a href="#565b0fe0c4cde7cc041966ff7fad8c7a"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGio_1_1Vfs.html">Vfs</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#2d7088e614b949ec38e8efc63a2ff8eb">get_default</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the default <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a> for the system. <a href="#2d7088e614b949ec38e8efc63a2ff8eb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><br>
<<a class="el" href="classGio_1_1Vfs.html">Vfs</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#e25c27cdec444a4a70a3c642ba2bd2c5">get_local</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Gets the local <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a> for the system. <a href="#e25c27cdec444a4a70a3c642ba2bd2c5"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Vfs.html">Gio::Vfs</a>> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGio_1_1Vfs.html#885ba46971bc010632a9c271f2a7a130">wrap</a> (GVfs* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#885ba46971bc010632a9c271f2a7a130"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Entry point for using GIO functionality.
<p>
<dl compact><dt><b><a class="el" href="newin2p16s.html#_newin2p16s000046">Since glibmm 2.16:</a></b></dt><dd></dd></dl>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="cd46536f0510d8c184dc7da1c7fcecd5"></a><!-- doxytag: member="Gio::Vfs::~Vfs" ref="cd46536f0510d8c184dc7da1c7fcecd5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gio::Vfs::~Vfs </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="c0fa6be64df6573ab2fef062d2e27142"></a><!-- doxytag: member="Gio::Vfs::gobj" ref="c0fa6be64df6573ab2fef062d2e27142" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GVfs* Gio::Vfs::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="809317bf98bfa9d4cd1901b876b1663f"></a><!-- doxytag: member="Gio::Vfs::gobj" ref="809317bf98bfa9d4cd1901b876b1663f" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GVfs* Gio::Vfs::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject.
<p>
<p>Reimplemented from <a class="el" href="classGlib_1_1ObjectBase.html#778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="1214cf83afa9b98ea7419732a17d7947"></a><!-- doxytag: member="Gio::Vfs::gobj_copy" ref="1214cf83afa9b98ea7419732a17d7947" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GVfs* Gio::Vfs::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs.
<p>
</div>
</div><p>
<a class="anchor" name="2d7088e614b949ec38e8efc63a2ff8eb"></a><!-- doxytag: member="Gio::Vfs::get_default" ref="2d7088e614b949ec38e8efc63a2ff8eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Vfs.html">Vfs</a>> Gio::Vfs::get_default </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the default <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a> for the system.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="e25c27cdec444a4a70a3c642ba2bd2c5"></a><!-- doxytag: member="Gio::Vfs::get_local" ref="e25c27cdec444a4a70a3c642ba2bd2c5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Vfs.html">Vfs</a>> Gio::Vfs::get_local </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets the local <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a> for the system.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="80396102cfefce571542c13b02e6a92d"></a><!-- doxytag: member="Gio::Vfs::file_for_path" ref="80396102cfefce571542c13b02e6a92d" args="(const std::string &path)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1File.html">File</a>> Gio::Vfs::file_for_path </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>path</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets a <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a> for <em>path</em>.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>path</em> </td><td>A string containing a VFS path. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="2777c4c3baaf761700cbad0e2ac560ff"></a><!-- doxytag: member="Gio::Vfs::file_for_uri" ref="2777c4c3baaf761700cbad0e2ac560ff" args="(const std::string &uri)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1File.html">File</a>> Gio::Vfs::file_for_uri </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>uri</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Gets a <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a> for <em>uri</em>.
<p>
This operation never fails, but the returned object might not support any I/O operation if the uri is malformed or if the uri type is not supported. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>uri</em> </td><td>A string containing a URI path. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="36596855d53b7485ee35b50faabdbceb"></a><!-- doxytag: member="Gio::Vfs::parse_name" ref="36596855d53b7485ee35b50faabdbceb" args="(const std::string &parse_name)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1File.html">File</a>> Gio::Vfs::parse_name </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" doxygen="libstdc++.tag.xml:http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/classstd_1_1basic__string.html">std::string</a> & </td>
<td class="paramname"> <em>parse_name</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
This operation never fails, but the returned object might not support any I/O operations if the <em>parse_name</em> cannot be parsed by the <a class="el" href="classGio_1_1Vfs.html" title="Entry point for using GIO functionality.">Vfs</a> module.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>parse_name</em> </td><td>A string to be parsed by the VFS module. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A <a class="el" href="classGio_1_1File.html" title="File and directory handling.">File</a> for the given <em>parse_name</em>. </dd></dl>
</div>
</div><p>
<a class="anchor" name="565b0fe0c4cde7cc041966ff7fad8c7a"></a><!-- doxytag: member="Gio::Vfs::is_active" ref="565b0fe0c4cde7cc041966ff7fad8c7a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool Gio::Vfs::is_active </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Checks if the VFS is active.
<p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd><code>true</code> if construction of the <em>vfs</em> was successful and it is now active. </dd></dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="885ba46971bc010632a9c271f2a7a130"></a><!-- doxytag: member="Gio::Vfs::wrap" ref="885ba46971bc010632a9c271f2a7a130" args="(GVfs *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGio_1_1Vfs.html">Gio::Vfs</a>> wrap </td>
<td>(</td>
<td class="paramtype">GVfs * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td width="100%"><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="el" href="namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object.
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="vfs_8h.html">vfs.h</a></ul>
</div> <!-- end main content -->
<hr><address><small>
Generated for glibmm 2.4 by <a href="http://www.doxygen.org/index.html">
Doxygen</a> 1.5.3 © 1997-2001</small></address>
</body>
</html>
