mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-20 19:08:54 +00:00
fe4f8ec3d1
Closes GH-233. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@351793 c90b9560-bf6c-de11-be94-00142212c4b1
113 lines
2.9 KiB
XML
113 lines
2.9 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.pspell-config-mode" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>pspell_config_mode</refname>
|
|
<refpurpose>Change the mode number of suggestions returned</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>pspell_config_mode</methodname>
|
|
<methodparam><type>int</type><parameter>config</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>mode</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<simpara>
|
|
<function>pspell_config_mode</function> should be used on a config
|
|
before calling <function>pspell_new_config</function>. This function
|
|
determines how many suggestions will be returned by
|
|
<function>pspell_suggest</function>.
|
|
</simpara>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>config</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>mode</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The mode parameter is the mode in which spellchecker will work.
|
|
There are several modes available:
|
|
<itemizedlist>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_FAST</constant> - Fast mode (least number of
|
|
suggestions)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_NORMAL</constant> - Normal mode (more suggestions)
|
|
</simpara>
|
|
</listitem>
|
|
<listitem>
|
|
<simpara>
|
|
<constant>PSPELL_BAD_SPELLERS</constant> - Slow mode (a lot of
|
|
suggestions)
|
|
</simpara>
|
|
</listitem>
|
|
</itemizedlist>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>pspell_config_mode</function> Example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
$pspell_config = pspell_config_create("en");
|
|
pspell_config_mode($pspell_config, PSPELL_FAST);
|
|
$pspell_link = pspell_new_config($pspell_config);
|
|
pspell_check($pspell_link, "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
|
|
-->
|