php-doc-en/reference/newt/functions/newt-draw-root-text.xml
Daniel Egeberg 96c9d88bad Converted to utf-8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
2010-03-28 22:10:10 +00:00

128 lines
3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.newt-draw-root-text" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>newt_draw_root_text</refname>
<refpurpose>Displays the string text at the position indicated</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>void</type><methodname>newt_draw_root_text</methodname>
<methodparam><type>int</type><parameter>left</parameter></methodparam>
<methodparam><type>int</type><parameter>top</parameter></methodparam>
<methodparam><type>string</type><parameter>text</parameter></methodparam>
</methodsynopsis>
<para>Displays the string text at the position indicated.</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>left</parameter></term>
<listitem>
<para>
Column number
</para>
<note>
<para>
If left is negative, the position is measured from the opposite side of the screen.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>top</parameter></term>
<listitem>
<para>
Line number
</para>
<note>
<para>
If top is negative, the position is measured from the opposite side of the screen.
</para>
</note>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>text</parameter></term>
<listitem>
<para>
Text to display.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.void;
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>newt_draw_root_text</function> example</title>
<para>
This code demonstrates drawing of titles in the both corners of the screen.
</para>
<programlisting role="php">
<![CDATA[
<?php
newt_init();
newt_cls();
newt_draw_root_text (2, 0, "Some root text");
newt_refresh();
sleep(1);
newt_draw_root_text (-30, 0, "Root text in the other corner");
newt_refresh();
sleep(1);
newt_finished();
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>newt_push_help_line</function></member>
<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:"~/.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
-->