php-doc-en/reference/newt/functions/newt-push-help-line.xml
Michael Spector 0a623eaaef fixed notes.
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@198076 c90b9560-bf6c-de11-be94-00142212c4b1
2005-10-10 12:23:00 +00:00

66 lines
1.6 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.3 $ -->
<refentry id="function.newt-push-help-line">
<refnamediv>
<refname>newt_push_help_line</refname>
<refpurpose>Saves the current help line on a stack, and displays the new line</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>newt_push_help_line</methodname>
<methodparam choice="opt"><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>Saves the current help line on a stack, and displays the new
line.</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<para>
New help text message
</para>
<note><para>
If not specified, the help line is cleared.
</para></note>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>newt_pop_help_line</function></member>
</simplelist>
</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:"../../../../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
-->