~ubuntu-branches/ubuntu/natty/gnome-vfs/natty

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-type-from-name" title="gnome_vfs_mime_type_from_name ()">gnome_vfs_mime_type_from_name</a> (const char *filename);

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-type-from-name-or-default" title="gnome_vfs_mime_type_from_name_or_default ()">gnome_vfs_mime_type_from_name_or_default</a>

(const char *filename,

const char *defaultv);

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-mime-type-common" title="gnome_vfs_get_mime_type_common ()">gnome_vfs_get_mime_type_common</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-mime-type-from-uri" title="gnome_vfs_get_mime_type_from_uri ()">gnome_vfs_get_mime_type_from_uri</a> (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-mime-type-from-file-data" title="gnome_vfs_get_mime_type_from_file_data ()">gnome_vfs_get_mime_type_from_file_data</a>

(<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type-fast" title="gnome_vfs_get_file_mime_type_fast ()">gnome_vfs_get_file_mime_type_fast</a> (const char *path,

const struct stat *optional_stat_info);

const char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type" title="gnome_vfs_get_file_mime_type ()">gnome_vfs_get_file_mime_type</a> (const char *path,

const struct stat *optional_stat_info,

gboolean suffix_only);

gboolean <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-type-is-supertype" title="gnome_vfs_mime_type_is_supertype ()">gnome_vfs_mime_type_is_supertype</a> (const char *mime_type);

char * <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-supertype-from-mime-type" title="gnome_vfs_get_supertype_from_mime_type ()">gnome_vfs_get_supertype_from_mime_type</a>

(const char *mime_type);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-info-cache-reload" title="gnome_vfs_mime_info_cache_reload ()">gnome_vfs_mime_info_cache_reload</a> (const char *dir);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-reload" title="gnome_vfs_mime_reload ()">gnome_vfs_mime_reload</a> (void);

void <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-mime-shutdown" title="gnome_vfs_mime_shutdown ()">gnome_vfs_mime_shutdown</a> (void);

</pre>

</div>

<a name="gnome-vfs-2.0-gnome-vfs-mime.description"></a><h2>Description</h2>

<p>

</p>

</div>

<a name="gnome-vfs-2.0-gnome-vfs-mime.details"></a><h2>Details</h2>

<a name="gnome-vfs-mime-type-from-name"></a><h3>gnome_vfs_mime_type_from_name ()</h3>

<pre class="programlisting">const char * gnome_vfs_mime_type_from_name (const char *filename);</pre>

<h3 class="title">Warning</h3>

<p><code class="literal">gnome_vfs_mime_type_from_name</code> is deprecated and should not be used in newly-written code. This function is deprecated, use

<a class="link" href="gnome-vfs-2.0-gnome-vfs-mime-utils.html#gnome-vfs-get-mime-type-for-name" title="gnome_vfs_get_mime_type_for_name ()"><code class="function">gnome_vfs_get_mime_type_for_name()</code></a> instead.</p>

</div>

<p>

Determine the mime type for <em class="parameter"><code>filename</code></em>.</p>

<p>

</p>

<tbody>

<tr>

<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>

<td> a filename (the file does not necessarily exist).

</td>

</tr>

<tr>

100

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

101

<td> the mime-type for this filename. Will return

102

<a class="link" href="gnome-vfs-2.0-gnome-vfs-mime-utils.html#GNOME-VFS-MIME-TYPE-UNKNOWN:CAPS" title="GNOME_VFS_MIME_TYPE_UNKNOWN"><code class="literal">GNOME_VFS_MIME_TYPE_UNKNOWN</code></a> if mime-type could not be found.

103

</td>

104

</tr>

105

</tbody>

106

</table></div>

107

</div>

108

<hr>

109

110

<a name="gnome-vfs-mime-type-from-name-or-default"></a><h3>gnome_vfs_mime_type_from_name_or_default ()</h3>

111

<pre class="programlisting">const char * gnome_vfs_mime_type_from_name_or_default

112

(const char *filename,

113

const char *defaultv);</pre>

114

<p>

115

This routine tries to determine the mime-type of the filename

116

only by looking at the filename from the GNOME database of mime-types.</p>

117

<p>

118

</p>

119

120

121

<tbody>

122

<tr>

123

<td><p><span class="term"><em class="parameter"><code>filename</code></em> :</span></p></td>

124

<td> a filename (the file does not necessarily exist).

125

</td>

126

</tr>

127

<tr>

128

<td><p><span class="term"><em class="parameter"><code>defaultv</code></em> :</span></p></td>

129

<td> a default value to be returned if no match is found.

130

</td>

131

</tr>

132

<tr>

133

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

134

<td> the mime-type of the <em class="parameter"><code>filename</code></em>. If no value could be

135

determined, it will return <em class="parameter"><code>defaultv</code></em>.

136

</td>

137

</tr>

138

</tbody>

139

</table></div>

140

</div>

141

<hr>

142

143

<a name="gnome-vfs-get-mime-type-common"></a><h3>gnome_vfs_get_mime_type_common ()</h3>

144

<pre class="programlisting">const char * gnome_vfs_get_mime_type_common (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>

145

<p>

146

Tries to guess the mime type of the file represented by <em class="parameter"><code>uri</code></em>.

147

Favors using the file data to the <em class="parameter"><code>uri</code></em> extension.

148

Handles <em class="parameter"><code>uri</code></em> of a non-existent file by falling back

149

on returning a type based on the extension. If cant find the mime-type based on the

150

extension also then returns 'application/octet-stream'.

151

</p>

152

<p>

153

FIXME: This function will not necessarily return the same mime type as doing a

154

get file info on the text uri.</p>

155

<p>

156

</p>

157

158

159

<tbody>

160

<tr>

161

162

<td> a real file or a non-existent uri.

163

</td>

164

</tr>

165

<tr>

166

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

167

<td> the mime-type for <em class="parameter"><code>uri</code></em>.

168

</td>

169

</tr>

170

</tbody>

171

</table></div>

172

</div>

173

<hr>

174

175

<a name="gnome-vfs-get-mime-type-from-uri"></a><h3>gnome_vfs_get_mime_type_from_uri ()</h3>

176

<pre class="programlisting">const char * gnome_vfs_get_mime_type_from_uri (<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>

177

<p>

178

Tries to guess the mime type of the file <em class="parameter"><code>uri</code></em> by

179

checking the file name extension. Works on non-existent

180

files.</p>

181

<p>

182

</p>

183

184

185

<tbody>

186

<tr>

187

188

<td> a file uri.

189

</td>

190

</tr>

191

<tr>

192

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

193

<td> the mime-type for file at <em class="parameter"><code>uri</code></em>.

194

</td>

195

</tr>

196

</tbody>

197

</table></div>

198

</div>

199

<hr>

200

201

<a name="gnome-vfs-get-mime-type-from-file-data"></a><h3>gnome_vfs_get_mime_type_from_file_data ()</h3>

202

<pre class="programlisting">const char * gnome_vfs_get_mime_type_from_file_data

203

(<a class="link" href="gnome-vfs-2.0-gnome-vfs-uri.html#GnomeVFSURI" title="GnomeVFSURI">GnomeVFSURI</a> *uri);</pre>

204

205

<h3 class="title">Warning</h3>

206

<p><code class="literal">gnome_vfs_get_mime_type_from_file_data</code> is deprecated and should not be used in newly-written code. </p>

207

</div>

208

<p>

209

Tries to guess the mime type of the file <em class="parameter"><code>uri</code></em> by

210

checking the file data using the magic patterns. Does not handle text files properly.</p>

211

<p>

212

</p>

213

214

215

<tbody>

216

<tr>

217

218

<td> a file uri.

219

</td>

220

</tr>

221

<tr>

222

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

223

<td> the mime-type for this filename.

224

</td>

225

</tr>

226

</tbody>

227

</table></div>

228

</div>

229

<hr>

230

231

<a name="gnome-vfs-get-file-mime-type-fast"></a><h3>gnome_vfs_get_file_mime_type_fast ()</h3>

232

<pre class="programlisting">const char * gnome_vfs_get_file_mime_type_fast (const char *path,

233

const struct stat *optional_stat_info);</pre>

234

<p>

235

Tries to guess the mime type of the file represented by <em class="parameter"><code>path</code></em>.

236

It uses extention/name detection first, and if that fails

237

it falls back to mime-magic based lookup. This is faster

238

than always doing mime-magic but doesn't always produce

239

the right answer, so for important decisions

240

you should use <a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type" title="gnome_vfs_get_file_mime_type ()"><code class="function">gnome_vfs_get_file_mime_type()</code></a>.</p>

241

<p>

242

</p>

243

244

245

<tbody>

246

<tr>

247

248

<td> path of the file whose mime type is to be found out.

249

</td>

250

</tr>

251

<tr>

252

<td><p><span class="term"><em class="parameter"><code>optional_stat_info</code></em> :</span></p></td>

253

<td> optional stat buffer.

254

</td>

255

</tr>

256

<tr>

257

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

258

<td> the mime-type for file at <em class="parameter"><code>path</code></em>.

259

</td>

260

</tr>

261

</tbody>

262

</table></div>

263

</div>

264

<hr>

265

266

<a name="gnome-vfs-get-file-mime-type"></a><h3>gnome_vfs_get_file_mime_type ()</h3>

267

<pre class="programlisting">const char * gnome_vfs_get_file_mime_type (const char *path,

268

const struct stat *optional_stat_info,

269

gboolean suffix_only);</pre>

270

<p>

271

Tries to guess the mime type of the file represented by <em class="parameter"><code>path</code></em>.

272

If <em class="parameter"><code>suffix_only</code></em> is false, uses the mime-magic based lookup first.

273

Handles <em class="parameter"><code>path</code></em> of a non-existent file by falling back

274

on returning a type based on the extension.

275

</p>

276

<p>

277

If you need a faster, less accurate version, use

278

<a class="link" href="gnome-vfs-2.0-gnome-vfs-mime.html#gnome-vfs-get-file-mime-type-fast" title="gnome_vfs_get_file_mime_type_fast ()"><code class="function">gnome_vfs_get_file_mime_type_fast()</code></a>.</p>

279

<p>

280

</p>

281

282

283

<tbody>

284

<tr>

285

286

<td> path of a file whose mime type is to be found out.

287

</td>

288

</tr>

289

<tr>

290

<td><p><span class="term"><em class="parameter"><code>optional_stat_info</code></em> :</span></p></td>

291

<td> optional stat buffer.

292

</td>

293

</tr>

294

<tr>

295

<td><p><span class="term"><em class="parameter"><code>suffix_only</code></em> :</span></p></td>

296

<td> whether or not to do a magic-based lookup.

297

</td>

298

</tr>

299

<tr>

300

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

301

<td> the mime-type for file at <em class="parameter"><code>path</code></em>.

302

</td>

303

</tr>

304

</tbody>

305

</table></div>

306

</div>

307

<hr>

308

309

<a name="gnome-vfs-mime-type-is-supertype"></a><h3>gnome_vfs_mime_type_is_supertype ()</h3>

310

<pre class="programlisting">gboolean gnome_vfs_mime_type_is_supertype (const char *mime_type);</pre>

311

<p>

312

</p>

313

314

315

<tbody>

316

<tr>

317

318

<td> a const char * identifying a mime type.

319

</td>

320

</tr>

321

<tr>

322

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

323

<td> Whether <em class="parameter"><code>mime_type</code></em> is of the form "foo<code class="literal">/</code>*".

324

</td>

325

</tr>

326

</tbody>

327

</table></div>

328

</div>

329

<hr>

330

331

<a name="gnome-vfs-get-supertype-from-mime-type"></a><h3>gnome_vfs_get_supertype_from_mime_type ()</h3>

332

<pre class="programlisting">char * gnome_vfs_get_supertype_from_mime_type

333

(const char *mime_type);</pre>

334

<p>

335

</p>

336

337

338

<tbody>

339

<tr>

340

341

<td> mime type to get the supertype for.

342

</td>

343

</tr>

344

<tr>

345

<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>

346

<td> The supertype for <em class="parameter"><code>mime_type</code></em>, allocating new memory.

347

348

The supertype of an application is computed by removing its

349

suffix, and replacing it with "*". Thus, "foo/bar" will be

350

converted to "foo<code class="literal">/</code>*".

351

352

353

354

If this function is called on a supertype, it will return a copy of the supertype.

355

</div>

356

</td>

357

</tr>

358

</tbody>

359

</table></div>

360

</div>

361

<hr>

362

363

<a name="gnome-vfs-mime-info-cache-reload"></a><h3>gnome_vfs_mime_info_cache_reload ()</h3>

364

<pre class="programlisting">void gnome_vfs_mime_info_cache_reload (const char *dir);</pre>

365

<p>

366

Reload the mime information for the <em class="parameter"><code>dir</code></em>.</p>

367

<p>

368

</p>

369

370

371

372

373

<td> directory path which needs reloading.

374

</td>

375

</tr></tbody>

376

</table></div>

377

</div>

378

<hr>

379

380

<a name="gnome-vfs-mime-reload"></a><h3>gnome_vfs_mime_reload ()</h3>

381

<pre class="programlisting">void gnome_vfs_mime_reload (void);</pre>

382

<p>

383

Reload the MIME database.</p>

384

<p>

385

</p>

386

</div>

387

<hr>

388

389

<a name="gnome-vfs-mime-shutdown"></a><h3>gnome_vfs_mime_shutdown ()</h3>

390

<pre class="programlisting">void gnome_vfs_mime_shutdown (void);</pre>

391

392

<h3 class="title">Warning</h3>

393

<p><code class="literal">gnome_vfs_mime_shutdown</code> is deprecated and should not be used in newly-written code. This function doesn't have to be called as the

394

operating system automatically cleans up resources when exiting.

395

</p>

396

<p>

397

Unload the MIME database from memory.</p>

398

</div>

399

<p>

400

</p>

401

</div>

402

</div>

403

</div>

404

405

<hr>

406

Generated by GTK-Doc V1.12</div>

407

</body>

408

</html>

Older »