sigmasternchen/php-doc-en
1
0
Fork 0
mirror of https://github.com/sigmasternchen/php-doc-en synced 2025-03-27 06:18:56 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
php-doc-en/reference/ncurses/constants.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

505 lines
16 KiB
XML
Raw Blame History

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<appendix xml:id="ncurses.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
&extension.constants;
<section xml:id="ncurses.errconsts">
<title>Error codes</title>
<para>
On error ncurses functions return <literal>-1</literal>.
Some functions return <literal>0</literal> on success. See the relevant
pages in the documentation for actual return values.
</para>
</section>
<section xml:id="ncurses.colorconsts">
<title>Colors</title>
<table>
<title>ncurses color constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>constant</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>NCURSES_COLOR_BLACK</constant></entry>
<entry>no color (black)</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_WHITE</constant></entry>
<entry>white</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_RED</constant></entry>
<entry>red - supported when terminal is in color mode</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_GREEN</constant></entry>
<entry>green - supported when terminal is in color mode</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_YELLOW</constant></entry>
<entry>yellow - supported when terminal is in color mode</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_BLUE</constant></entry>
<entry>blue - supported when terminal is in color mode</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_CYAN</constant></entry>
<entry>cyan - supported when terminal is in color mode</entry>
</row>
<row>
<entry><constant>NCURSES_COLOR_MAGENTA</constant></entry>
<entry>magenta - supported when terminal is in color mode</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="ncurses.keyconsts">
<title>Keys</title>
<table>
<title>ncurses key constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>constant</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>NCURSES_KEY_F0</constant> - <constant>NCURSES_KEY_F64</constant></entry>
<entry>function keys F1 - F64</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_DOWN</constant></entry>
<entry>down arrow</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_UP</constant></entry>
<entry>up arrow</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_LEFT</constant></entry>
<entry>left arrow</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_RIGHT</constant></entry>
<entry>right arrow</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_HOME</constant></entry>
<entry>home key (upward+left arrow)</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_BACKSPACE</constant></entry>
<entry>backspace</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_DL</constant></entry>
<entry>delete line</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_IL</constant></entry>
<entry>insert line</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_DC</constant></entry>
<entry>delete character</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_IC</constant></entry>
<entry>insert char or enter insert mode</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_EIC</constant></entry>
<entry>exit insert char mode</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_CLEAR</constant></entry>
<entry>clear screen</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_EOS</constant></entry>
<entry>clear to end of screen</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_EOL</constant></entry>
<entry>clear to end of line</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SF</constant></entry>
<entry>scroll one line forward</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SR</constant></entry>
<entry>scroll one line backward</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_NPAGE</constant></entry>
<entry>next page</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_PPAGE</constant></entry>
<entry>previous page</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_STAB</constant></entry>
<entry>set tab</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_CTAB</constant></entry>
<entry>clear tab</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_CATAB</constant></entry>
<entry>clear all tabs</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SRESET</constant></entry>
<entry>soft (partial) reset</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_RESET</constant></entry>
<entry>reset or hard reset</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_PRINT</constant></entry>
<entry>print</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_LL</constant></entry>
<entry>lower left</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_A1</constant></entry>
<entry>upper left of keypad</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_A3</constant></entry>
<entry>upper right of keypad</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_B2</constant></entry>
<entry>center of keypad</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_C1</constant></entry>
<entry>lower left of keypad</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_C3</constant></entry>
<entry>lower right of keypad</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_BTAB</constant></entry>
<entry>back tab</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_BEG</constant></entry>
<entry>beginning</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_CANCEL</constant></entry>
<entry>cancel</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_CLOSE</constant></entry>
<entry>close</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_COMMAND</constant></entry>
<entry>cmd (command)</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_COPY</constant></entry>
<entry>copy</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_CREATE</constant></entry>
<entry>create</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_END</constant></entry>
<entry>end</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_EXIT</constant></entry>
<entry>exit</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_FIND</constant></entry>
<entry>find</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_HELP</constant></entry>
<entry>help</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_MARK</constant></entry>
<entry>mark</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_MESSAGE</constant></entry>
<entry>message</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_MOVE</constant></entry>
<entry>move</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_NEXT</constant></entry>
<entry>next</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_OPEN</constant></entry>
<entry>open</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_OPTIONS</constant></entry>
<entry>options</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_PREVIOUS</constant></entry>
<entry>previous</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_REDO</constant></entry>
<entry>redo</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_REFERENCE</constant></entry>
<entry>ref (reference)</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_REFRESH</constant></entry>
<entry>refresh</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_REPLACE</constant></entry>
<entry>replace</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_RESTART</constant></entry>
<entry>restart</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_RESUME</constant></entry>
<entry>resume</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SAVE</constant></entry>
<entry>save</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SBEG</constant></entry>
<entry>shiftet beg (beginning)</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SCANCEL</constant></entry>
<entry>shifted cancel</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SCOMMAND</constant></entry>
<entry>shifted command</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SCOPY</constant></entry>
<entry>shifted copy</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SCREATE</constant></entry>
<entry>shifted create</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SDC</constant></entry>
<entry>shifted delete char</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SDL</constant></entry>
<entry>shifted delete line</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SELECT</constant></entry>
<entry>select</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SEND</constant></entry>
<entry>shifted end</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SEOL</constant></entry>
<entry>shifted end of line</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SEXIT</constant></entry>
<entry>shifted exit</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SFIND</constant></entry>
<entry>shifted find</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SHELP</constant></entry>
<entry>shifted help</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SHOME</constant></entry>
<entry>shifted home</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SIC</constant></entry>
<entry>shifted input</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SLEFT</constant></entry>
<entry>shifted left arrow</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SMESSAGE</constant></entry>
<entry>shifted message</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SMOVE</constant></entry>
<entry>shifted move</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SNEXT</constant></entry>
<entry>shifted next</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SOPTIONS</constant></entry>
<entry>shifted options</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SPREVIOUS</constant></entry>
<entry>shifted previous</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SPRINT</constant></entry>
<entry>shifted print</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SREDO</constant></entry>
<entry>shifted redo</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SREPLACE</constant></entry>
<entry>shifted replace</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SRIGHT</constant></entry>
<entry>shifted right arrow</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SRSUME</constant></entry>
<entry>shifted resume</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SSAVE</constant></entry>
<entry>shifted save</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_SSUSPEND</constant></entry>
<entry>shifted suspend</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_UNDO</constant></entry>
<entry>undo</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_MOUSE</constant></entry>
<entry>mouse event has occurred</entry>
</row>
<row>
<entry><constant>NCURSES_KEY_MAX</constant></entry>
<entry>maximum key value</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
<section xml:id="ncurses.mouseconsts">
<title>Mouse</title>
<table>
<title>mouse constants</title>
<tgroup cols="2">
<thead>
<row>
<entry>Constant</entry>
<entry>meaning</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>NCURSES_BUTTON1_RELEASED</constant> - <constant>NCURSES_BUTTON4_RELEASED</constant></entry>
<entry>button (1-4) released</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON1_PRESSED</constant> - <constant>NCURSES_BUTTON4_PRESSED</constant></entry>
<entry>button (1-4) pressed</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON1_CLICKED</constant> - <constant>NCURSES_BUTTON4_CLICKED</constant></entry>
<entry>button (1-4) clicked</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON1_DOUBLE_CLICKED</constant> -
<constant>NCURSES_BUTTON4_DOUBLE_CLICKED</constant></entry>
<entry>button (1-4) double clicked</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON1_TRIPLE_CLICKED</constant> -
<constant>NCURSES_BUTTON4_TRIPLE_CLICKED</constant></entry>
<entry>button (1-4) triple clicked</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON_CTRL</constant></entry>
<entry>ctrl pressed during click</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON_SHIFT</constant></entry>
<entry>shift pressed during click</entry>
</row>
<row>
<entry><constant>NCURSES_BUTTON_ALT</constant></entry>
<entry>alt pressed during click</entry>
</row>
<row>
<entry><constant>NCURSES_ALL_MOUSE_EVENTS</constant></entry>
<entry>report all mouse events</entry>
</row>
<row>
<entry><constant>NCURSES_REPORT_MOUSE_POSITION</constant></entry>
<entry>report mouse position</entry>
</row>
</tbody>
</tgroup>
</table>
</section>
</appendix>
<!-- 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
-->
Reference in a new issue View git blame Copy permalink