mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-15 16:38:54 +00:00
14af302c9c
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@334762 c90b9560-bf6c-de11-be94-00142212c4b1
103 lines
3.2 KiB
XML
103 lines
3.2 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id="function.ncurses-pair-content" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ncurses_pair_content</refname>
|
|
<refpurpose>Retrieves foreground and background colors of a color pair</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ncurses_pair_content</methodname>
|
|
<methodparam><type>int</type><parameter>pair</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter role="reference">f</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter role="reference">b</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Retrieves the foreground and background colors that constitute the given
|
|
color pair. Terminal color capabilities must be initialized with
|
|
<function>ncurses_start_color</function> prior to calling this function.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>pair</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The number of the color pair to retrieve information for.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>f</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A reference to which to return the foreground color of the color
|
|
pair. The information returned will be a color number referring to
|
|
one of the
|
|
<link linkend="ncurses.colorconsts">pre-defined colors</link> or a
|
|
color defined previously by
|
|
<function>ncurses_init_color</function> if the terminal supports
|
|
color changing.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>b</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A reference to which to return the background color of the color
|
|
pair. The information returned will be a color number referring to
|
|
one of the
|
|
<link linkend="ncurses.colorconsts">pre-defined colors</link> or a
|
|
color defined previously by
|
|
<function>ncurses_init_color</function> if the terminal supports
|
|
color changing.
|
|
</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.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ncurses_init_pair</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
|
|
-->
|