mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
96c9d88bad
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@297028 c90b9560-bf6c-de11-be94-00142212c4b1
108 lines
3.2 KiB
XML
108 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ncurses-init-color" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ncurses_init_color</refname>
|
|
<refpurpose>Define a terminal color</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ncurses_init_color</methodname>
|
|
<methodparam><type>int</type><parameter>color</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>r</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>g</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>b</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Defines or redefines the given color. When this function is called, all
|
|
occurrences of the given color on the screen, if any, immediately change
|
|
to the new definition.
|
|
</para>
|
|
<para>
|
|
Color capabilities must be supported by the terminal and initialized using
|
|
<function>ncurses_start_color</function> prior to calling this function.
|
|
In addition, the terminal must have color changing capabilities; use
|
|
<function>ncurses_can_change_color</function> to check for this.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>color</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The identification number of the color to redefine. It may be one of
|
|
the default color constants.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>r</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A color value, between 0 and 1000, for the red component.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>g</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A color value, between 0 and 1000, for the green component.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>b</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A color value, between 0 and 1000, for the blue component.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns <literal>-1</literal> if the function was successful,
|
|
and <literal>0</literal> if ncurses or terminal
|
|
color capabilities have not been initialized or the terminal does not
|
|
have color changing capabilities.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ncurses_color_content</function></member>
|
|
<member><function>ncurses_start_color</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
|
|
-->
|