pspell-config-mode.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 81b23db050ac0627b056585c16bfe95445ae174e Maintainer: yannick Status: ready -->
<!-- Reviewed: yes -->
<refentry xml:id="function.pspell-config-mode" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>pspell_config_mode</refname>
  <refpurpose>Change le mode de suggestion</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>pspell_config_mode</methodname>
   <methodparam><type>PSpell\Config</type><parameter>config</parameter></methodparam>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
  </methodsynopsis>
  <simpara>
   <function>pspell_config_mode</function> doit être appelée dans une configuration
   avant <function>pspell_new_config</function>. Cette fonction détermine le
   nombre de suggestions qui seront retournées par
   <function>pspell_suggest</function>.
  </simpara>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>config</parameter></term>
     <listitem>
      &pspell.parameter.pspell-config;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>mode</parameter></term>
     <listitem>
      <para>
       Le paramètre de mode est le mode de travail du vérificateur
       d'orthographe. Plusieurs modes sont disponibles :
       <itemizedlist>
        <listitem>
         <simpara>
          <constant>PSPELL_FAST</constant> - Mode rapide (moins de 
          suggestions)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_NORMAL</constant> - Mode normal (plus de suggestions)
         </simpara>
        </listitem>
        <listitem>
         <simpara>
          <constant>PSPELL_BAD_SPELLERS</constant> - Mode lent (beaucoup plus de 
          suggestions)
         </simpara>
        </listitem>
       </itemizedlist>
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </para>
 </refsect1>

 <refsect1 role="changelog">
  &reftitle.changelog;
  <informaltable>
   <tgroup cols="2">
    <thead>
     <row>
      <entry>&Version;</entry>
      <entry>&Description;</entry>
     </row>
    </thead>
    <tbody>
     &pspell.changelog.pspell-config;
    </tbody>
   </tgroup>
  </informaltable>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Exemple avec <function>pspell_config_mode</function></title>
    <programlisting role="php">
<![CDATA[
<?php
$pspell_config = pspell_config_create("en");
pspell_config_mode($pspell_config, PSPELL_FAST);
$pspell = pspell_new_config($pspell_config);
pspell_check($pspell, "thecat");
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->