Top |
Functions
void | gimp_env_init () |
const gchar * | gimp_directory () |
const gchar * | gimp_data_directory () |
const gchar * | gimp_locale_directory () |
const gchar * | gimp_plug_in_directory () |
const gchar * | gimp_sysconf_directory () |
const gchar * | gimp_user_directory () |
gchar * | gimp_personal_rc_file () |
const gchar * | gimp_gtkrc () |
GList * | gimp_path_parse () |
gchar * | gimp_path_to_str () |
void | gimp_path_free () |
gchar * | gimp_path_get_user_writable_dir () |
Description
A set of functions to find the locations of GIMP's data directories and configuration files.
Functions
gimp_env_init ()
void
gimp_env_init (gboolean plug_in
);
You don't need to care about this function. It is being called for
you automatically (by means of the MAIN()
macro that every plug-in
runs). Calling it again will cause a fatal error.
Since: GIMP 2.4
gimp_directory ()
const gchar *
gimp_directory (void
);
Returns the user-specific GIMP settings directory. If the
environment variable GIMP2_DIRECTORY exists, it is used. If it is
an absolute path, it is used as is. If it is a relative path, it
is taken to be a subdirectory of the home directory. If it is a
relative path, and no home directory can be determined, it is taken
to be a subdirectory of gimp_data_directory()
.
The usual case is that no GIMP2_DIRECTORY environment variable
exists, and then we use the GIMPDIR subdirectory of the home
directory. If no home directory exists, we use a per-user
subdirectory of gimp_data_directory()
. In any case, we always
return some non-empty string, whether it corresponds to an existing
directory or not.
The returned string is owned by GIMP and must not be modified or freed. The returned string is in the encoding used for filenames by GLib, which isn't necessarily UTF-8. (On Windows it always is UTF-8.)
gimp_data_directory ()
const gchar *
gimp_data_directory (void
);
Returns the top directory for GIMP data. If the environment variable GIMP2_DATADIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable's full filename is used.
The returned string is owned by GIMP and must not be modified or freed. The returned string is in the encoding used for filenames by GLib, which isn't necessarily UTF-8. (On Windows it always is UTF-8.)
gimp_locale_directory ()
const gchar *
gimp_locale_directory (void
);
Returns the top directory for GIMP locale files. If the environment variable GIMP2_LOCALEDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable's full filename is used.
The returned string is owned by GIMP and must not be modified or
freed. The returned string is in the encoding used for filenames by
the C library, which isn't necessarily UTF-8. (On Windows, unlike
the other similar functions here, the return value from this
function is in the system codepage, never in UTF-8. It can thus be
passed directly to the bindtextdomain()
function from libintl which
does not handle UTF-8.)
gimp_plug_in_directory ()
const gchar *
gimp_plug_in_directory (void
);
Returns the top directory for GIMP plug_ins and modules. If the environment variable GIMP2_PLUGINDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable's full filename is used.
The returned string is owned by GIMP and must not be modified or freed. The returned string is in the encoding used for filenames by GLib, which isn't necessarily UTF-8. (On Windows it always is UTF-8.)
gimp_sysconf_directory ()
const gchar *
gimp_sysconf_directory (void
);
Returns the top directory for GIMP config files. If the environment variable GIMP2_SYSCONFDIR exists, that is used. It should be an absolute pathname. Otherwise, on Unix the compile-time defined directory is used. On Windows, the installation directory as deduced from the executable's full filename is used.
The returned string is owned by GIMP and must not be modified or freed. The returned string is in the encoding used for filenames by GLib, which isn't necessarily UTF-8. (On Windows it always is UTF-8.).
gimp_user_directory ()
const gchar *
gimp_user_directory (GimpUserDirectory type
);
gimp_user_directory
is deprecated and should not be used in newly-written code.
This procedure is deprecated! Use g_get_user_special_dir()
instead.
Since: GIMP 2.4
gimp_personal_rc_file ()
gchar *
gimp_personal_rc_file (const gchar *basename
);
Returns the name of a file in the user-specific GIMP settings directory.
The returned string is allocated dynamically and *SHOULD* be freed
with g_free()
after use. The returned string is in the encoding
used for filenames by GLib, which isn't necessarily
UTF-8. (On Windows it always is UTF-8.)
gimp_gtkrc ()
const gchar *
gimp_gtkrc (void
);
gimp_gtkrc
is deprecated and should not be used in newly-written code.
Returns the name of GIMP's application-specific gtkrc file.
The returned string is owned by GIMP and must not be modified or freed. The returned string is in the encoding used for filenames by GLib, which isn't necessarily UTF-8. (On Windows it always is UTF-8.)
gimp_path_parse ()
GList * gimp_path_parse (const gchar *path
,gint max_paths
,gboolean check
,GList **check_failed
);
Parameters
path |
A list of directories separated by G_SEARCHPATH_SEPARATOR. |
|
max_paths |
The maximum number of directories to return. |
|
check |
|
|
check_failed |
Returns a GList of path elements for which the check failed. |
gimp_path_free ()
void
gimp_path_free (GList *path
);
This function frees the memory allocated for the list and the strings it contains.