/usr/share/gtk-doc/html/plank/Plank.Paths.html is in libplank-doc 0.11.4-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 | <?xml version="1.0" encoding="utf-8"?>
<html>
<head>
<meta charset="UTF-8"/>
<title>Plank.Paths – plank – Vala Binding Reference</title>
<link href="devhelpstyle.css" rel="stylesheet" type="text/css"/><script src="scripts.js" type="text/javascript">
</script>
</head>
<body>
<div class="site_header">Plank.Paths – plank Reference Manual</div>
<div class="site_body">
<div class="site_content">
<h1 class="main_title">Paths</h1>
<hr class="main_hr"/>
<h2 class="main_title">Object Hierarchy:</h2>
<img class="main_diagram" usemap="#Plank.Paths" alt="Object hierarchy for Paths" src="img/Plank.Paths.png"/>
<map id="Plank.Paths" name="Plank.Paths">
<area shape="rect" id="node1" href="Plank.Paths.html" title="Plank.Paths" alt="" coords="9,101,115,149"/>
</map>
<h2 class="main_title">Description:</h2>
<div class="main_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">class</span> <b><span class="class">Paths</span></b> : <span class="main_type"><span class="class">Object</span></span>
</div>
<div class="description">
<p>A wrapper class that gives static instances of <span class="interface">GLib.File</span> for commonly used paths. Most paths are retrieved
from <span class="namespace">GLib.Environment</span>, which on Linux uses the XDG Base Directory specification (see
<a href="http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html" target="_blank">
http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html</a>).</p>
<p>Initializing this class also ensures any writable directories exist.</p>
</div><br/>
<div class="namespace_note"><b>Namespace:</b> <a href="Plank.html">Plank</a>
</div>
<div class="package_note"><b>Package:</b> <a href="index.htm">plank</a>
</div>
<h2 class="main_title">Content:</h2>
<h3 class="main_title">Properties:</h3>
<ul class="navi_inline">
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.HomeFolder.html" class="property">HomeFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">User's home folder - $HOME</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.DataFolder.html" class="property">DataFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">Path passed in to initialize method should be Build.PKGDATADIR</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.ThemeFolder.html" class="property">ThemeFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">DataFolder/themes</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.ConfigHomeFolder.html" class="property">ConfigHomeFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">HomeFolder/.config</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.DataHomeFolder.html" class="property">DataHomeFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">HomeFolder/.local/share</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.CacheHomeFolder.html" class="property">CacheHomeFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">HomeFolder/.cache</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="class">ArrayList</span></span><<span class="main_type"><span class="interface">File</span></span>> <b><a href="Plank.Paths.DataDirFolders.html" class="property">DataDirFolders</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">/usr/local/share/:/usr/share/</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.AppConfigFolder.html" class="property">AppConfigFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">defaults to ConfigHomeFolder/app_name</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.AppDataFolder.html" class="property">AppDataFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">defaults to DataHomeFolder/app_name</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.AppThemeFolder.html" class="property">AppThemeFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">defaults to AppDataFolder/themes</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_type"><span class="interface">File</span></span> <b><a href="Plank.Paths.AppCacheFolder.html" class="property">AppCacheFolder</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">defaults to CacheHomeFolder/app_name</span>
</div></li>
<li class="property"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_basic_type"><span class="class">string</span></span> <b><a href="Plank.Paths.AppName.html" class="property">AppName</a></b> { <span class="main_keyword">protected</span> <span class="main_keyword">set</span>; <span class="main_keyword">get</span>; }
</span>
<div class="leaf_brief_description"><span class="brief_description">application name which got passed to initialize</span>
</div></li>
</ul>
<h3 class="main_title">Static methods:</h3>
<ul class="navi_inline">
<li class="static_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">static</span> <span class="main_keyword">void</span> <b><a href="Plank.Paths.initialize.html" class="static_method">initialize</a></b> (<span class="main_basic_type"><span class="class">string</span></span> app_name, <span class="main_basic_type"><span class="class">string</span></span> data_folder)
</span>
<div class="leaf_brief_description"><span class="brief_description">Initialize the class, creating the <span class="interface">GLib.File
</span> instances for all common paths. Also ensure that any writable directory exists.</span>
</div></li>
<li class="static_method"><span class="leaf_code_definition"><span class="main_keyword">public</span> <span class="main_keyword">static</span> <span class="main_basic_type"><span class="struct">bool</span></span> <b><a href="Plank.Paths.ensure_directory_exists.html" class="static_method">ensure_directory_exists</a></b> (<span class="main_type"><span class="interface">File</span></span> dir)
</span>
<div class="leaf_brief_description"><span class="brief_description">Creates the directory if it does not already exist</span>
</div></li>
</ul>
<h3 class="main_title">Inherited Members:</h3>
<div class="box">
<div class="headline" onclick="toggle_box (this, 'box-content-78')">All known members inherited from class GLib.Object</div>
<div class="content" id="box-content-78">
<div class="column">
<ul class="navi_inline">
<li class="static_method">@new</li>
<li class="static_method">new_valist</li>
<li class="static_method">newv</li>
<li class="method">add_toggle_ref</li>
<li class="method">add_weak_pointer</li>
<li class="method">bind_property</li>
<li class="method">connect</li>
<li class="virtual_method">constructed</li>
<li class="method">disconnect</li>
<li class="virtual_method">dispose</li>
<li class="method">dup_data</li>
<li class="method">dup_qdata</li>
<li class="method">freeze_notify</li>
<li class="method">@get</li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="method">get_class</li>
<li class="method">get_data</li>
<li class="method">get_property</li>
<li class="method">get_qdata</li>
<li class="method">get_type</li>
<li class="method">notify_property</li>
<li class="method">@ref</li>
<li class="method">ref_sink</li>
<li class="method">replace_data</li>
<li class="method">replace_qdata</li>
<li class="method">remove_toggle_ref</li>
<li class="method">remove_weak_pointer</li>
<li class="method">@set</li>
<li class="method">set_data</li>
</ul>
</div>
<div class="column">
<ul class="navi_inline">
<li class="method">set_data_full</li>
<li class="method">set_property</li>
<li class="method">set_qdata</li>
<li class="method">set_qdata_full</li>
<li class="method">steal_data</li>
<li class="method">steal_qdata</li>
<li class="method">thaw_notify</li>
<li class="method">unref</li>
<li class="method">watch_closure</li>
<li class="method">weak_ref</li>
<li class="method">weak_unref</li>
<li class="signal">notify</li>
<li class="field">ref_count</li>
</ul>
</div>
</div>
</div>
</div>
</div><br/>
<div class="site_footer">Generated by <a href="http://www.valadoc.org/">Valadoc</a>
</div>
</body>
</html>
|