## Documentation

Table of Contents
Class Inheritance Tree
Widget Screenshots
Package groups

## Index

Package: Intl

- Goto spec source

# Description

    package Gtkada.Intl is

This package provides support for string internationalization using the libintl library.

Developer setup =============== To provide internationalization in your application, you must install a number of files along with your application, and modify your code to highlight the strings to translate. This translation is based on the gettext() library. Reading its documentation is recommended since it explains best practices for handling translations.

Preparing your code =================== Gettext needs to information to locate the translation files: a language, as setup by the user (see User Setup below), and a domain, hard-coded in the application. The domain is the name of your application. Given these two pieces of information, the translation file will be found in: $prefix/<lang>/LC_MESSAGES/<domain>.mo Where $prefix is either one of the standard search paths, or specified through a call to Bind_Text_Domain.

Although the user can simply specify which language to use by setting one environment variable, they are in fact several other setup to be done, so that the C library properly handles date format for instance. This is done through a call to Setlocale.

An application can be associated with several domains, although it is generally recommended to have one default domain, specify through a call to Text_Domain. Each string can then be translated through a call to Gettext, without specifying the domain every time.

A convenient shortcut is provided in the form of the "-" operator.

As a result, typical code would look like: begin Setlocale; Text_Domain ("application"); Bind_Text_Domain ("application", "/usr/local/share/locale"); ... Put_Line (-"I18n string"); end; Preparing and installing the translation files =============================================== The Gtkada distribution comes with a convenient script named build_skeleton.pl, which you can run on your application to extract all the strings that should be translated. See the "po/" directory in GtkAda, as well as the Makefile in this directory.

Running "make refresh" will reparse all the source files in your application, and create (or update if they already exist) one file .po for each language registered in the Makefile.

You would then translate each of the string indicated my "msgid", by modifying the lines starting with "msgstr".

Once this is done, running the msgfmt tool through "make install" will generate a <lang>.mo binary file, which should be copied in the directory $prefix/<lang>/LC_MESSAGES/<domain>.mo The translation files can also be created fully by hand.

Here is a sample translation file that can be used as an input for msgfmt: # gtkada-fr.po msgid "Help" msgstr "Aide" msgid "Yes" msgstr "Oui" $ msgfmt gtkada-fr.po -o gtkada-fr.gmo $ cp gtkada-fr.gmo /usr/share/locale/fr/LC_MESSAGES/gtkada.mo User setup ========== To change the current locale setting, use the environment variables "LANG". For example, to switch to the french locale using bash: $ export LANG=fr_FR Depending on the specific implementation of gettext, the following environment variables may be set to change the default settings of locale parameters: - LANG Specifies locale name. - LC_MESSAGES Specifies messaging locale, and if present overrides LANG for messages. - TEXTDOMAIN Specifies the text domain name, which is identical to the message object filename without .mo suffix. - TEXTDOMAINDIR Specifies the pathname to the message database, and if present replaces the default (e.g /usr/lib/locale on Solaris, /usr/share/locale on Linux).

See the gettext documentation of your specific OS for more details.

# Subprograms & Entries

### Gettext

- Goto spec in source

    function Gettext (Msg: Glib.UTF8_String) return Glib.UTF8_String;

Look up Msg in the current default message catalog. Use the current locale as specified by LC_MESSAGES. If not found, return Msg itself (the default text).

### Dgettext

- Goto spec in source

    function Dgettext (Domain: String;Msg: Glib.UTF8_String) return Glib.UTF8_String;

Look up Msg in the Domain message catalog for the current locale.

### -

- Goto spec in source

    function "-" (Msg: Glib.UTF8_String) return Glib.UTF8_String;

Shortcut for Dgettext ("GtkAda", Msg)

### Dcgettext

- Goto spec in source

    function Dcgettext (Domain: String;Msg: Glib.UTF8_String;Category: Integer) return Glib.UTF8_String;

Look up Msg in the Domain message catalog for the Category locale.

### Default_Text_Domain

- Goto spec in source

    function Default_Text_Domain return String;

Return the current default message catalog.

### Text_Domain

- Goto spec in source

    procedure Text_Domain (Domain: String := "");

Set the current default message catalog to Domain. If Domain is "", reset to the default of "messages".

### Bind_Text_Domain

- Goto spec in source

    procedure Bind_Text_Domain (Domain: String;Dirname: String);

Specify that the Domain message catalog will be found in Dirname. This overrides the default system locale data base. Dirname will generally be the installation prefix for your application.

### Setlocale

- Goto spec in source

    procedure Setlocale;

This procedure must be called before any other subprogram in this package. It will initialize internal variables based on the environment variables.