Blame docs/reference/gio/html/gio-GContentType.html

Packit ae235b
Packit ae235b
<html>
Packit ae235b
<head>
Packit ae235b
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
Packit ae235b
<title>GContentType: GIO Reference Manual</title>
Packit ae235b
<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot">
Packit ae235b
<link rel="home" href="index.html" title="GIO Reference Manual">
Packit ae235b
<link rel="up" href="types.html" title="File types and applications">
Packit ae235b
<link rel="prev" href="types.html" title="File types and applications">
Packit ae235b
<link rel="next" href="GAppInfo.html" title="GAppInfo">
Packit ae235b
<meta name="generator" content="GTK-Doc V1.27 (XML mode)">
Packit ae235b
<link rel="stylesheet" href="style.css" type="text/css">
Packit ae235b
</head>
Packit ae235b
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
Packit ae235b
Packit ae235b
Packit ae235b
Top  | 
Packit ae235b
                  Description
Packit ae235b
Packit ae235b
Home
Packit ae235b
Up
Packit ae235b
Prev
Packit ae235b
Next
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

GContentType

Packit ae235b

GContentType — Platform-specific content typing

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_equals ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_is_a ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_is_mime_type ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_is_unknown ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_get_description ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_get_mime_type ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GIcon *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_get_icon ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GIcon *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_get_symbolic_icon ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_get_generic_icon_name ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gboolean
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_can_be_executable ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_from_mime_type ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_guess ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
gchar **
Packit ae235b
Packit ae235b
Packit ae235b
g_content_type_guess_for_tree ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
GList *
Packit ae235b
Packit ae235b
Packit ae235b
g_content_types_get_registered ()
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Includes

Packit ae235b
#include <gio/gio.h>
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Description

Packit ae235b

A content type is a platform specific string that defines the type

Packit ae235b
of a file. On UNIX it is a
Packit ae235b
mime type
Packit ae235b
like "text/plain" or "image/png".
Packit ae235b
On Win32 it is an extension string like ".doc", ".txt" or a perceived
Packit ae235b
string like "audio". Such strings can be looked up in the registry at
Packit ae235b
HKEY_CLASSES_ROOT.
Packit ae235b
On OSX it is a Uniform Type Identifier
Packit ae235b
such as "com.apple.application".

Packit ae235b
Packit ae235b
Packit ae235b

Functions

Packit ae235b
Packit ae235b

g_content_type_equals ()

Packit ae235b
gboolean
Packit ae235b
g_content_type_equals (const gchar *type1,
Packit ae235b
                       const gchar *type2);
Packit ae235b

Compares two content types for equality.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type1

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

type2

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if the two strings are identical or equivalent,

Packit ae235b
FALSE otherwise.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_is_a ()

Packit ae235b
gboolean
Packit ae235b
g_content_type_is_a (const gchar *type,
Packit ae235b
                     const gchar *supertype);
Packit ae235b

Determines if type

Packit ae235b
 is a subset of supertype
Packit ae235b
.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

supertype

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if type

Packit ae235b
is a kind of supertype
Packit ae235b
,
Packit ae235b
FALSE otherwise.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_is_mime_type ()

Packit ae235b
gboolean
Packit ae235b
g_content_type_is_mime_type (const gchar *type,
Packit ae235b
                             const gchar *mime_type);
Packit ae235b

Determines if type

Packit ae235b
 is a subset of mime_type
Packit ae235b
.
Packit ae235b
Convenience wrapper around g_content_type_is_a().

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

mime_type

Packit ae235b

a mime type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if type

Packit ae235b
is a kind of mime_type
Packit ae235b
,
Packit ae235b
FALSE otherwise.

Packit ae235b
Packit ae235b

Since: 2.52

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_is_unknown ()

Packit ae235b
gboolean
Packit ae235b
g_content_type_is_unknown (const gchar *type);
Packit ae235b

Checks if the content type is the generic "unknown" type.

Packit ae235b
On UNIX this is the "application/octet-stream" mimetype,
Packit ae235b
while on win32 it is "*" and on OSX it is a dynamic type
Packit ae235b
or octet-stream.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if the type is the unknown type.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_get_description ()

Packit ae235b
gchar *
Packit ae235b
g_content_type_get_description (const gchar *type);
Packit ae235b

Gets the human readable description of the content type.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a short description of the content type type

Packit ae235b
. Free the
Packit ae235b
returned string with g_free()

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_get_mime_type ()

Packit ae235b
gchar *
Packit ae235b
g_content_type_get_mime_type (const gchar *type);
Packit ae235b

Gets the mime type for the content type, if one is registered.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the registered mime type for the given type

Packit ae235b
,
Packit ae235b
or NULL if unknown. 

Packit ae235b

[nullable]

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_get_icon ()

Packit ae235b
GIcon *
Packit ae235b
g_content_type_get_icon (const gchar *type);
Packit ae235b

Gets the icon for a content type.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

GIcon corresponding to the content type. Free the returned

Packit ae235b
object with g_object_unref(). 

Packit ae235b

[transfer full]

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_get_symbolic_icon ()

Packit ae235b
GIcon *
Packit ae235b
g_content_type_get_symbolic_icon (const gchar *type);
Packit ae235b

Gets the symbolic icon for a content type.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

symbolic GIcon corresponding to the content type.

Packit ae235b
Free the returned object with g_object_unref(). 

Packit ae235b

[transfer full]

Packit ae235b
Packit ae235b

Since: 2.34

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_get_generic_icon_name ()

Packit ae235b
gchar *
Packit ae235b
g_content_type_get_generic_icon_name (const gchar *type);
Packit ae235b

Gets the generic icon name for a content type.

Packit ae235b

See the

Packit ae235b
shared-mime-info
Packit ae235b
specification for more on the generic icon name.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

the registered generic icon name for the given type

Packit ae235b
,
Packit ae235b
or NULL if unknown. Free with g_free(). 

Packit ae235b

[nullable]

Packit ae235b
Packit ae235b

Since: 2.34

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_can_be_executable ()

Packit ae235b
gboolean
Packit ae235b
g_content_type_can_be_executable (const gchar *type);
Packit ae235b

Checks if a content type can be executable. Note that for instance

Packit ae235b
things like text files can be executables (i.e. scripts and batch files).

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

type

Packit ae235b

a content type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

TRUE if the file type corresponds to a type that

Packit ae235b
can be executable, FALSE otherwise.

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_from_mime_type ()

Packit ae235b
gchar *
Packit ae235b
g_content_type_from_mime_type (const gchar *mime_type);
Packit ae235b

Tries to find a content type based on the mime type name.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

mime_type

Packit ae235b

a mime type string

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

Newly allocated string with content type or

Packit ae235b
NULL. Free with g_free(). 

Packit ae235b

[nullable]

Packit ae235b
Packit ae235b

Since: 2.18

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_guess ()

Packit ae235b
gchar *
Packit ae235b
g_content_type_guess (const gchar *filename,
Packit ae235b
                      const guchar *data,
Packit ae235b
                      gsize data_size,
Packit ae235b
                      gboolean *result_uncertain);
Packit ae235b

Guesses the content type based on example data. If the function is

Packit ae235b
uncertain, result_uncertain
Packit ae235b
 will be set to TRUE. Either filename
Packit ae235b
Packit ae235b
or data
Packit ae235b
 may be NULL, in which case the guess will be based solely
Packit ae235b
on the other argument.

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

filename

Packit ae235b

a string, or NULL.

Packit ae235b
[nullable]
Packit ae235b
Packit ae235b
Packit ae235b

data

Packit ae235b

a stream of data, or NULL.

Packit ae235b
[nullable][array length=data_size]
Packit ae235b
Packit ae235b
Packit ae235b

data_size

Packit ae235b

the size of data

Packit ae235b

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b

result_uncertain

Packit ae235b

return location for the certainty

Packit ae235b
of the result, or NULL. 

Packit ae235b
[out][optional]
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

a string indicating a guessed content type for the

Packit ae235b
given data. Free with g_free()

Packit ae235b
Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_type_guess_for_tree ()

Packit ae235b
gchar **
Packit ae235b
g_content_type_guess_for_tree (GFile *root);
Packit ae235b

Tries to guess the type of the tree with root root

Packit ae235b
, by
Packit ae235b
looking at the files it contains. The result is an array
Packit ae235b
of content types, with the best guess coming first.

Packit ae235b

The types returned all have the form x-content/foo, e.g.

Packit ae235b
x-content/audio-cdda (for audio CDs) or x-content/image-dcf
Packit ae235b
(for a camera memory card). See the
Packit ae235b
shared-mime-info
Packit ae235b
specification for more on x-content types.

Packit ae235b

This function is useful in the implementation of

Packit ae235b
g_mount_guess_content_type().

Packit ae235b
Packit ae235b

Parameters

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

root

Packit ae235b

the root of the tree to guess a type for

Packit ae235b
 
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Returns

Packit ae235b

an NULL-terminated

Packit ae235b
array of zero or more content types. Free with g_strfreev(). 

Packit ae235b

[transfer full][array zero-terminated=1]

Packit ae235b
Packit ae235b

Since: 2.18

Packit ae235b
Packit ae235b

Packit ae235b
Packit ae235b

g_content_types_get_registered ()

Packit ae235b
GList *
Packit ae235b
g_content_types_get_registered (void);
Packit ae235b

Gets a list of strings containing all the registered content types

Packit ae235b
known to the system. The list and its data should be freed using
Packit ae235b
g_list_free_full (list, g_free).

Packit ae235b
Packit ae235b

Returns

Packit ae235b

list of the registered

Packit ae235b
content types. 

Packit ae235b

[element-type utf8][transfer full]

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Types and Values

Packit ae235b
Packit ae235b
Packit ae235b
Packit ae235b

Generated by GTK-Doc V1.27
Packit ae235b
</body>
Packit ae235b
</html>