mirror of
https://gitlab.gnome.org/GNOME/gimp.git
synced 2025-07-03 17:33:25 +00:00
8005eea835
because it confuses gtk-doc and breaks some links. Also change the "Index of new symbols in GIMP 2.x" sections to be what seems to be the modern standard (looked at the GLib and GTK+ docs), and update some other stuff.
244 lines
6.6 KiB
C
244 lines
6.6 KiB
C
/* LIBGIMP - The GIMP Library
|
|
* Copyright (C) 1995-1997 Spencer Kimball and Peter Mattis
|
|
*
|
|
* gimpbasetypes.c
|
|
* Copyright (C) 2004 Sven Neumann <sven@gimp.org>
|
|
*
|
|
* This library is free software: you can redistribute it and/or
|
|
* modify it under the terms of the GNU Lesser General Public
|
|
* License as published by the Free Software Foundation; either
|
|
* version 3 of the License, or (at your option) any later version.
|
|
*
|
|
* This library is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
|
* Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public
|
|
* License along with this library. If not, see
|
|
* <http://www.gnu.org/licenses/>.
|
|
*/
|
|
|
|
#include "config.h"
|
|
|
|
#include <glib-object.h>
|
|
|
|
#include "gimpbasetypes.h"
|
|
|
|
|
|
/**
|
|
* SECTION: gimpbasetypes
|
|
* @title: gimpbasetypes
|
|
* @short_description: Translation between gettext translation domain
|
|
* identifier and GType.
|
|
*
|
|
* Translation between gettext translation domain identifier and
|
|
* GType.
|
|
**/
|
|
|
|
|
|
static GQuark gimp_translation_domain_quark (void) G_GNUC_CONST;
|
|
static GQuark gimp_translation_context_quark (void) G_GNUC_CONST;
|
|
static GQuark gimp_value_descriptions_quark (void) G_GNUC_CONST;
|
|
|
|
|
|
/**
|
|
* gimp_type_set_translation_domain:
|
|
* @type: a #GType
|
|
* @domain: a constant string that identifies a translation domain or %NULL
|
|
*
|
|
* This function attaches a constant string as a gettext translation
|
|
* domain identifier to a #GType. The only purpose of this function is
|
|
* to use it when registering a #G_TYPE_ENUM with translatable value
|
|
* names.
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
void
|
|
gimp_type_set_translation_domain (GType type,
|
|
const gchar *domain)
|
|
{
|
|
g_type_set_qdata (type,
|
|
gimp_translation_domain_quark (), (gpointer) domain);
|
|
}
|
|
|
|
/**
|
|
* gimp_type_get_translation_domain:
|
|
* @type: a #GType
|
|
*
|
|
* Retrieves the gettext translation domain identifier that has been
|
|
* previously set using gimp_type_set_translation_domain(). You should
|
|
* not need to use this function directly, use gimp_enum_get_value()
|
|
* or gimp_enum_value_get_desc() instead.
|
|
*
|
|
* Return value: the translation domain associated with @type
|
|
* or %NULL if no domain was set
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
const gchar *
|
|
gimp_type_get_translation_domain (GType type)
|
|
{
|
|
return (const gchar *) g_type_get_qdata (type,
|
|
gimp_translation_domain_quark ());
|
|
}
|
|
|
|
/**
|
|
* gimp_type_set_translation_context:
|
|
* @type: a #GType
|
|
* @context: a constant string that identifies a translation context or %NULL
|
|
*
|
|
* This function attaches a constant string as a translation context
|
|
* to a #GType. The only purpose of this function is to use it when
|
|
* registering a #G_TYPE_ENUM with translatable value names.
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
void
|
|
gimp_type_set_translation_context (GType type,
|
|
const gchar *context)
|
|
{
|
|
g_type_set_qdata (type,
|
|
gimp_translation_context_quark (), (gpointer) context);
|
|
}
|
|
|
|
/**
|
|
* gimp_type_get_translation_context:
|
|
* @type: a #GType
|
|
*
|
|
* Retrieves the translation context that has been previously set
|
|
* using gimp_type_set_translation_context(). You should not need to
|
|
* use this function directly, use gimp_enum_get_value() or
|
|
* gimp_enum_value_get_desc() instead.
|
|
*
|
|
* Return value: the translation context associated with @type
|
|
* or %NULL if no context was set
|
|
*
|
|
* Since: 2.8
|
|
**/
|
|
const gchar *
|
|
gimp_type_get_translation_context (GType type)
|
|
{
|
|
return (const gchar *) g_type_get_qdata (type,
|
|
gimp_translation_context_quark ());
|
|
}
|
|
|
|
/**
|
|
* gimp_enum_set_value_descriptions:
|
|
* @enum_type: a #GType
|
|
* @descriptions: a %NULL terminated constant static array of #GimpEnumDesc
|
|
*
|
|
* Sets the array of human readable and translatable descriptions
|
|
* and help texts for enum values.
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
void
|
|
gimp_enum_set_value_descriptions (GType enum_type,
|
|
const GimpEnumDesc *descriptions)
|
|
{
|
|
g_return_if_fail (g_type_is_a (enum_type, G_TYPE_ENUM));
|
|
g_return_if_fail (descriptions != NULL);
|
|
|
|
g_type_set_qdata (enum_type,
|
|
gimp_value_descriptions_quark (),
|
|
(gpointer) descriptions);
|
|
}
|
|
|
|
/**
|
|
* gimp_enum_get_value_descriptions:
|
|
* @enum_type: a #GType
|
|
*
|
|
* Retreives the array of human readable and translatable descriptions
|
|
* and help texts for enum values.
|
|
*
|
|
* Returns: a %NULL terminated constant array of #GimpEnumDesc
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
const GimpEnumDesc *
|
|
gimp_enum_get_value_descriptions (GType enum_type)
|
|
{
|
|
g_return_val_if_fail (g_type_is_a (enum_type, G_TYPE_ENUM), NULL);
|
|
|
|
return (const GimpEnumDesc *)
|
|
g_type_get_qdata (enum_type, gimp_value_descriptions_quark ());
|
|
}
|
|
|
|
/**
|
|
* gimp_flags_set_value_descriptions:
|
|
* @flags_type: a #GType
|
|
* @descriptions: a %NULL terminated constant static array of #GimpFlagsDesc
|
|
*
|
|
* Sets the array of human readable and translatable descriptions
|
|
* and help texts for flags values.
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
void
|
|
gimp_flags_set_value_descriptions (GType flags_type,
|
|
const GimpFlagsDesc *descriptions)
|
|
{
|
|
g_return_if_fail (g_type_is_a (flags_type, G_TYPE_FLAGS));
|
|
g_return_if_fail (descriptions != NULL);
|
|
|
|
g_type_set_qdata (flags_type,
|
|
gimp_value_descriptions_quark (),
|
|
(gpointer) descriptions);
|
|
}
|
|
|
|
/**
|
|
* gimp_flags_get_value_descriptions:
|
|
* @flags_type: a #GType
|
|
*
|
|
* Retreives the array of human readable and translatable descriptions
|
|
* and help texts for flags values.
|
|
*
|
|
* Returns: a %NULL terminated constant array of #GimpFlagsDesc
|
|
*
|
|
* Since: 2.2
|
|
**/
|
|
const GimpFlagsDesc *
|
|
gimp_flags_get_value_descriptions (GType flags_type)
|
|
{
|
|
g_return_val_if_fail (g_type_is_a (flags_type, G_TYPE_FLAGS), NULL);
|
|
|
|
return (const GimpFlagsDesc *)
|
|
g_type_get_qdata (flags_type, gimp_value_descriptions_quark ());
|
|
}
|
|
|
|
|
|
/* private functions */
|
|
|
|
static GQuark
|
|
gimp_translation_domain_quark (void)
|
|
{
|
|
static GQuark quark = 0;
|
|
|
|
if (! quark)
|
|
quark = g_quark_from_static_string ("gimp-translation-domain-quark");
|
|
|
|
return quark;
|
|
}
|
|
|
|
static GQuark
|
|
gimp_translation_context_quark (void)
|
|
{
|
|
static GQuark quark = 0;
|
|
|
|
if (! quark)
|
|
quark = g_quark_from_static_string ("gimp-translation-context-quark");
|
|
|
|
return quark;
|
|
}
|
|
|
|
static GQuark
|
|
gimp_value_descriptions_quark (void)
|
|
{
|
|
static GQuark quark = 0;
|
|
|
|
if (! quark)
|
|
quark = g_quark_from_static_string ("gimp-value-descriptions-quark");
|
|
|
|
return quark;
|
|
}
|