~ubuntu-branches/ubuntu/maverick/pango1.0/maverick-proposed

#define             <a class="link" href="pango-Scripts-and-Languages.html#PANGO-TYPE-SCRIPT--CAPS" title="PANGO_TYPE_SCRIPT">PANGO_TYPE_SCRIPT</a>

                    <a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter">PangoScriptIter</a>;

<a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a>         <a class="link" href="pango-Scripts-and-Languages.html#pango-script-for-unichar" title="pango_script_for_unichar ()">pango_script_for_unichar</a>            (<a

>gunichar</a> ch);

<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *     <a class="link" href="pango-Scripts-and-Languages.html#pango-script-get-sample-language" title="pango_script_get_sample_language ()">pango_script_get_sample_language</a>    (<a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a> script);

<a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter">PangoScriptIter</a> *   <a class="link" href="pango-Scripts-and-Languages.html#pango-script-iter-new" title="pango_script_iter_new ()">pango_script_iter_new</a>               (const char *text,

                                                         G_CONST_RETURN char **end,

                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a> *script);

<a

>gboolean</a>            <a class="link" href="pango-Scripts-and-Languages.html#pango-script-iter-next" title="pango_script_iter_next ()">pango_script_iter_next</a>              (<a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter">PangoScriptIter</a> *iter);

void                <a class="link" href="pango-Scripts-and-Languages.html#pango-script-iter-free" title="pango_script_iter_free ()">pango_script_iter_free</a>              (<a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter">PangoScriptIter</a> *iter);

                    <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a>;

<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *     <a class="link" href="pango-Scripts-and-Languages.html#pango-language-from-string" title="pango_language_from_string ()">pango_language_from_string</a>          (const char *language);

const char *        <a class="link" href="pango-Scripts-and-Languages.html#pango-language-to-string" title="pango_language_to_string ()">pango_language_to_string</a>            (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *language);

<a

>gboolean</a>            <a class="link" href="pango-Scripts-and-Languages.html#pango-language-matches" title="pango_language_matches ()">pango_language_matches</a>              (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *language,

                                                         const char *range_list);

<a

>gboolean</a>            <a class="link" href="pango-Scripts-and-Languages.html#pango-language-includes-script" title="pango_language_includes_script ()">pango_language_includes_script</a>      (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *language,

                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a> script);

const <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a> * <a class="link" href="pango-Scripts-and-Languages.html#pango-language-get-scripts" title="pango_language_get_scripts ()">pango_language_get_scripts</a>          (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *language,

Note that new types may be added in the future. Applications should be ready

to handle unknown values.  This enumeration is interchangeable with

<a

><span class="type">GUnicodeScript</span></a>.  See <a class="ulink" href="http://www.unicode.org/reports/tr24/" target="_top">Unicode Standard Annex

#24: Script names</a>.

</p>

</pre>

<p>

The <a

><span class="type">GObject</span></a> type for <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a>

</p>

</div>

<hr>

<div class="refsect2" lang="en">

<a name="PangoScriptIter"></a><h3>PangoScriptIter</h3>

<p>

A <a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter"><span class="type">PangoScriptIter</span></a> is used to iterate through a string

and identify ranges in different scripts.</p>

<div class="refsect2" lang="en">

<a name="pango-script-for-unichar"></a><h3>pango_script_for_unichar ()</h3>

<pre class="programlisting"><a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a>         pango_script_for_unichar            (<a

>gunichar</a> ch);</pre>

<p>

Looks up the <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> for a particular character (as defined by

<p>

As of Pango 1.18, this function simply returns the return value of

<a

><code class="function">g_unichar_get_script()</code></a>.</p>

<p>

</p>

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

<td> a <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a> that is representative

of the script, or <a

><code class="literal">NULL</code></a> if no such language exists.

 

</td>

<tr>

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

<td> location to store start position of the range, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

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

<td> location to store end position of the range, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

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

<td> location to store script for range, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<div class="refsect2" lang="en">

<a name="pango-script-iter-next"></a><h3>pango_script_iter_next ()</h3>

<pre class="programlisting"><a

>gboolean</a>            pango_script_iter_next              (<a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter">PangoScriptIter</a> *iter);</pre>

<p>

Advances a <a class="link" href="pango-Scripts-and-Languages.html#PangoScriptIter" title="PangoScriptIter"><span class="type">PangoScriptIter</span></a> to the next range. If <em class="parameter"><code>iter</code></em>

is already at the end, it is left unchanged and <a

><code class="literal">FALSE</code></a>

is returned.</p>

<p>

<tr>

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

<td> <a

><code class="literal">TRUE</code></a> if <em class="parameter"><code>iter</code></em> was successfully advanced.

 

</td>

</pre>

<p>

The <a

><span class="type">GObject</span></a> type for <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a>.

</p>

</div>

<tr>

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

<td> a string representing a language tag, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

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

<td> an opaque pointer to a <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a> structure, or <a

><code class="literal">NULL</code></a>

              if <em class="parameter"><code>language</code></em> was <a

><code class="literal">NULL</code></a>.  The returned pointer will be valid

              forever after, and should not be freed.

</td>

<div class="refsect2" lang="en">

<a name="pango-language-matches"></a><h3>pango_language_matches ()</h3>

<pre class="programlisting"><a

>gboolean</a>            pango_language_matches              (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *language,

                                                         const char *range_list);</pre>

<p>

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

<td> a language tag (see <a class="link" href="pango-Scripts-and-Languages.html#pango-language-from-string" title="pango_language_from_string ()"><code class="function">pango_language_from_string()</code></a>),

           <a

><code class="literal">NULL</code></a> is allowed and matches nothing but '*'

</td>

</tr>

<tr>

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

<td> <a

><code class="literal">TRUE</code></a> if a match was found.

</td>

</tr>

<div class="refsect2" lang="en">

<a name="pango-language-includes-script"></a><h3>pango_language_includes_script ()</h3>

<pre class="programlisting"><a

>gboolean</a>            pango_language_includes_script      (<a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage">PangoLanguage</a> *language,

                                                         <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript">PangoScript</a> script);</pre>

<p>

write <em class="parameter"><code>language</code></em>. The returned value is conservative;

if nothing is known about the language tag <em class="parameter"><code>language</code></em>,

<a

><code class="literal">TRUE</code></a> will be returned, since, as far as Pango knows,

<em class="parameter"><code>script</code></em> might be used to write <em class="parameter"><code>language</code></em>.

</p>

<tr>

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

<td> a <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a>, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

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

<td> <a

><code class="literal">TRUE</code></a> if <em class="parameter"><code>script</code></em> is one of the scripts used

to write <em class="parameter"><code>language</code></em> or if nothing is known about <em class="parameter"><code>language</code></em>

(including the case that <em class="parameter"><code>language</code></em> is <a

><code class="literal">NULL</code></a>),

<a

><code class="literal">FALSE</code></a> otherwise.

 

</td>

Determines the scripts used to to write <em class="parameter"><code>language</code></em>.

If nothing is known about the language tag <em class="parameter"><code>language</code></em>,

or if <em class="parameter"><code>language</code></em> is <a

><code class="literal">NULL</code></a>, then <a

><code class="literal">NULL</code></a> is returned.

The list of scripts returned starts with the script that the

language uses most and continues to the one it uses least.

<p>

The value <em class="parameter"><code>num_script</code></em> points at will be set to the number

of scripts in the returned array (or zero if <a

><code class="literal">NULL</code></a> is returned).

</p>

<p>

any assumptions on the maximum number of scripts returned

though, except that it is positive if the return value is not

<a

><code class="literal">NULL</code></a>, and it is a small number.

</p>

<p>

<tr>

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

<td> a <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a>, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<tr>

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

<td> location to return number of scripts, or <a

><code class="literal">NULL</code></a>

</td>

</tr>

<td> An array of <a class="link" href="pango-Scripts-and-Languages.html#PangoScript" title="enum PangoScript"><span class="type">PangoScript</span></a> values, with the

number of entries in the array stored in <em class="parameter"><code>num_scripts</code></em>, or

<a

><code class="literal">NULL</code></a> if Pango does not have any information about this

particular language tag (also the case if <em class="parameter"><code>language</code></em> is <a

><code class="literal">NULL</code></a>).

The returned array is owned by Pango and should not be modified

or freed.

variables, and setting them won't affect the behavior of functions

like <code class="function">ctime()</code>. The user sets the locale through the Regional Options

in the Control Panel. The C library (in the <a

><code class="function">setlocale()</code></a> function)

does not use country and language codes, but country and language

names spelled out in English.

</p>

<p>

If <em class="parameter"><code>language</code></em> is <a

><code class="literal">NULL</code></a>, the default language as found by

<a class="link" href="pango-Scripts-and-Languages.html#pango-language-get-default" title="pango_language_get_default ()"><code class="function">pango_language_get_default()</code></a> is used.

</p>

<tr>

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

<td> a <a class="link" href="pango-Scripts-and-Languages.html#PangoLanguage" title="PangoLanguage"><span class="type">PangoLanguage</span></a>, or <a

><code class="literal">NULL</code></a>

</td>

</tr>