Philip Olson wrote:
> Agreed, and I think it would be well worth it to document this extension.
I've gone ahead and documented the color-related functions in the ncurses extension, for starters.
Please let me know if there's anything I should fix! Thanks, Keito
Index: constants.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/constants.xml,v retrieving revision 1.6 diff -u -r1.6 constants.xml --- constants.xml 26 Jan 2008 14:49:36 -0000 1.6 +++ constants.xml 5 Apr 2009 04:52:29 -0000 @@ -6,7 +6,7 @@ <section xml:id="ncurses.errconsts"> <title>Error codes</title> <para> - On error ncurses functions return NCURSES_ERR. + On error ncurses functions return -1. </para> </section> <section xml:id="ncurses.colorconsts"> Index: versions.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/versions.xml,v retrieving revision 1.1 diff -u -r1.1 versions.xml --- versions.xml 2 Nov 2008 04:50:40 -0000 1.1 +++ versions.xml 5 Apr 2009 04:52:29 -0000 @@ -4,166 +4,166 @@ Do NOT translate this file --> <versions> - <function name='ncurses_addch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_addchnstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_addchstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_addnstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_addstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_assume_default_colors' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_attroff' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_attron' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_attrset' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_baudrate' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_beep' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_bkgd' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_bkgdset' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_border' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_bottom_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_can_change_color' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_cbreak' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_clear' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_clrtobot' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_clrtoeol' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_color_content' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_color_set' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_curs_set' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_def_prog_mode' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_def_shell_mode' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_define_key' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_del_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_delay_output' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_delch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_deleteln' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_delwin' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_doupdate' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_echo' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_echochar' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_end' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_erase' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_erasechar' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_filter' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_flash' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_flushinp' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_getch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_getmaxyx' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_getmouse' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_getyx' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_halfdelay' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_has_colors' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_has_ic' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_has_il' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_has_key' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_hide_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_hline' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_inch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_init' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_init_color' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_init_pair' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_insch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_insdelln' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_insertln' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_insstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_instr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_isendwin' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_keyok' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_keypad' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_killchar' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_longname' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_meta' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mouse_trafo' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mouseinterval' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mousemask' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_move' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_move_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvaddch' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvaddchnstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvaddchstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvaddnstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvaddstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvcur' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvdelch' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvgetch' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvhline' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvinch' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvvline' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_mvwaddstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_napms' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_new_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_newpad' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_newwin' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_nl' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_nocbreak' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_noecho' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_nonl' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_noqiflush' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_noraw' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_pair_content' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_panel_above' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_panel_below' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_panel_window' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_pnoutrefresh' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_prefresh' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_putp' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_qiflush' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_raw' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_refresh' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_replace_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_reset_prog_mode' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_reset_shell_mode' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_resetty' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_savetty' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_scr_dump' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_scr_init' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_scr_restore' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_scr_set' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_scrl' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_show_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_attr' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_attroff' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_attron' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_attrset' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_clear' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_color' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_init' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_noutrefresh' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_refresh' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_restore' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_set' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_slk_touch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_standend' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_standout' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_start_color' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_termattrs' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_termname' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_timeout' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_top_panel' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_typeahead' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_ungetch' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_ungetmouse' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_update_panels' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_use_default_colors' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_use_env' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_use_extended_names' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_vidattr' from='PHP 4 >= 4.0.7, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_vline' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_waddch' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_waddstr' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wattroff' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wattron' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wattrset' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wborder' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wclear' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wcolor_set' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_werase' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wgetch' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_whline' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wmouse_trafo' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wmove' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wnoutrefresh' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wrefresh' from='PHP 4 >= 4.2.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wstandend' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wstandout' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> - <function name='ncurses_wvline' from='PHP 4 >= 4.3.0, PHP 5, PECL ncurses >= 1.0.0'/> + <function name='ncurses_addch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_addchnstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_addchstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_addnstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_addstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_assume_default_colors' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_attroff' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_attron' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_attrset' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_baudrate' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_beep' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_bkgd' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_bkgdset' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_border' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_bottom_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_can_change_color' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_cbreak' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_clear' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_clrtobot' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_clrtoeol' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_color_content' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_color_set' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_curs_set' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_def_prog_mode' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_def_shell_mode' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_define_key' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_del_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_delay_output' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_delch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_deleteln' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_delwin' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_doupdate' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_echo' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_echochar' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_end' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_erase' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_erasechar' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_filter' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_flash' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_flushinp' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_getch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_getmaxyx' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_getmouse' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_getyx' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_halfdelay' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_has_colors' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_has_ic' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_has_il' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_has_key' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_hide_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_hline' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_inch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_init' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_init_color' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_init_pair' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_insch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_insdelln' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_insertln' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_insstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_instr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_isendwin' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_keyok' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_keypad' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_killchar' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_longname' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_meta' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mouse_trafo' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mouseinterval' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mousemask' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_move' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_move_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvaddch' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvaddchnstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvaddchstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvaddnstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvaddstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvcur' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvdelch' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvgetch' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvhline' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvinch' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvvline' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_mvwaddstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_napms' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_new_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_newpad' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_newwin' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_nl' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_nocbreak' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_noecho' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_nonl' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_noqiflush' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_noraw' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_pair_content' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_panel_above' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_panel_below' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_panel_window' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_pnoutrefresh' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_prefresh' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_putp' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_qiflush' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_raw' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_refresh' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_replace_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_reset_prog_mode' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_reset_shell_mode' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_resetty' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_savetty' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_scr_dump' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_scr_init' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_scr_restore' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_scr_set' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_scrl' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_show_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_attr' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_attroff' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_attron' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_attrset' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_clear' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_color' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_init' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_noutrefresh' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_refresh' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_restore' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_set' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_slk_touch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_standend' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_standout' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_start_color' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_termattrs' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_termname' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_timeout' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_top_panel' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_typeahead' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_ungetch' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_ungetmouse' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_update_panels' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_use_default_colors' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_use_env' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_use_extended_names' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_vidattr' from='PHP 4 >= 4.0.7, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_vline' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_waddch' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_waddstr' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wattroff' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wattron' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wattrset' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wborder' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wclear' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wcolor_set' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_werase' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wgetch' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_whline' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wmouse_trafo' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wmove' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wnoutrefresh' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wrefresh' from='PHP 4 >= 4.2.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wstandend' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wstandout' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> + <function name='ncurses_wvline' from='PHP 4 >= 4.3.0, PHP 5 < 5.3.0, PECL ncurses >= 1.0.0'/> </versions> <!-- Keep this comment at the end of the file Index: functions/ncurses-can-change-color.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-can-change-color.xml,v retrieving revision 1.5 diff -u -r1.5 ncurses-can-change-color.xml --- functions/ncurses-can-change-color.xml 20 Jun 2007 22:25:02 -0000 1.5 +++ functions/ncurses-can-change-color.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-can-change-color" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_can_change_color</refname> - <refpurpose>Check if we can change terminals colors </refpurpose> + <refpurpose>Checks if terminal color definitions can be changed</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -13,15 +13,29 @@ </methodsynopsis> &warn.experimental.func; <para> - Tells whether the terminal has color capabilities and whether the - programmer can change the colors. + Checks whether the terminal has color capabilities and whether the + programmer can change color definitions using <function>ncurses_init_color</function>. + ncurses must be initialized using <function>ncurses_init</function> before calling this function. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Return &true; if the terminal has color capabilities and you can change - the colors, &false; otherwise. + Return &true; if the programmer can change color definitions, &false; otherwise. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_has_colors</function></member> + <member><function>ncurses_init_color</function></member> + <member><function>ncurses_start_color</function></member> + </simplelist> </para> </refsect1> </refentry> Index: functions/ncurses-color-content.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-color-content.xml,v retrieving revision 1.5 diff -u -r1.5 ncurses-color-content.xml --- functions/ncurses-color-content.xml 20 Jun 2007 22:25:02 -0000 1.5 +++ functions/ncurses-color-content.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-color-content" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_color_content</refname> - <refpurpose>Gets the RGB value for color</refpurpose> + <refpurpose>Retrieves RGB components of a color</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -14,7 +14,10 @@ <methodparam><type>int</type><parameter role="reference">g</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">b</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <para> + Retrieves the red, green, and blue components for the given color definition. Terminal color capabilities must + be initialized with <function>ncurses_start_color</function> prior to calling this function. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,6 +27,7 @@ <term><parameter>color</parameter></term> <listitem> <para> + The number of the color to retrieve information for. May be one of the pre-defined color constants. </para> </listitem> </varlistentry> @@ -31,6 +35,8 @@ <term><parameter>r</parameter></term> <listitem> <para> + A reference to which to return the red component of the color. The value returned to the reference will be + between 0 and 1000. </para> </listitem> </varlistentry> @@ -38,6 +44,8 @@ <term><parameter>g</parameter></term> <listitem> <para> + A reference to which to return the green component of the color. The value returned to the reference will be + between 0 and 1000. </para> </listitem> </varlistentry> @@ -45,12 +53,29 @@ <term><parameter>b</parameter></term> <listitem> <para> + A reference to which to return the blue component of the color. The value returned to the reference will be + between 0 and 1000. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized. + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_init_color</function></member> + <member><function>ncurses_start_color</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file Index: functions/ncurses-color-set.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-color-set.xml,v retrieving revision 1.6 diff -u -r1.6 ncurses-color-set.xml --- functions/ncurses-color-set.xml 20 Jun 2007 22:25:02 -0000 1.6 +++ functions/ncurses-color-set.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-color-set" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_color_set</refname> - <refpurpose>Set fore- and background color </refpurpose> + <refpurpose>Set active foreground and background colors</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -12,7 +12,15 @@ <methodparam><type>int</type><parameter>pair</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - &warn.undocumented.func; + <para> + Sets the active foreground and background colors. Any characters written after this function is invoked will + have these colors. This function requires terminal colors to be supported and + initialized using <function>ncurses_start_color</function> beforehand. + </para> + <para> + ncurses uses color pairs to specify both foreground and background colors. Use <function>ncurses_init_pair</function> + to define a color pair. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -22,12 +30,58 @@ <term><parameter>pair</parameter></term> <listitem> <para> + The color pair from which to get the foreground and background colors to set as the active colors. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns -1 on success, and 0 on failure. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Writing a string with a specified color to the screen</title> + <programlisting role="php"> +<![CDATA[ +<?php +ncurses_init(); + +// If the terminal supports colors, initialize and set active color +if (ncurses_has_colors()) { + ncurses_start_color(); + ncurses_init_pair(1, NCURSES_COLOR_YELLOW, NCURSES_COLOR_BLUE); + ncurses_color_set(1); +} + +// Write a string at specified location +ncurses_mvaddstr(10, 10, "Hello world! Yellow on blue text!"); + +// Flush output to screen +ncurses_refresh(); + +ncurses_end(); +?> +]]> + </programlisting> + </example> + </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 Index: functions/ncurses-has-colors.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-has-colors.xml,v retrieving revision 1.7 diff -u -r1.7 ncurses-has-colors.xml --- functions/ncurses-has-colors.xml 7 Aug 2007 08:06:59 -0000 1.7 +++ functions/ncurses-has-colors.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-has-colors" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_has_colors</refname> - <refpurpose>Check if terminal has colors </refpurpose> + <refpurpose>Checks if terminal has color capabilities</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -13,13 +13,48 @@ </methodsynopsis> &warn.experimental.func; <para> - Checks whether the terminal has color capacities. + Checks whether the terminal has color capabilities. This function can be used to write terminal-independent programs. + ncurses must be initialized using <function>ncurses_init</function> before calling this function. </para> </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; <para> - Return &true; if the terminal has color capacities, &false; otherwise. + Return &true; if the terminal has color capabilities, &false; otherwise. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Writing a string with a specified color to the screen</title> + <programlisting role="php"> +<![CDATA[ +<?php +ncurses_init(); + +// If the terminal supports colors, initialize and set active color +if (ncurses_has_colors()) { + ncurses_start_color(); + ncurses_init_pair(1, NCURSES_COLOR_YELLOW, NCURSES_COLOR_BLUE); + ncurses_color_set(1); +} + +// Write a string at specified location +ncurses_mvaddstr(10, 10, "Hello world! Yellow on blue text!"); + +// Flush output to screen +ncurses_refresh(); + +ncurses_end(); +?> +]]> + </programlisting> + </example> </para> </refsect1> <refsect1 role="seealso"> @@ -27,6 +62,7 @@ <para> <simplelist> <member><function>ncurses_can_change_color</function></member> + <member><function>ncurses_start_color</function></member> </simplelist> </para> </refsect1> Index: functions/ncurses-init-color.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-init-color.xml,v retrieving revision 1.6 diff -u -r1.6 ncurses-init-color.xml --- functions/ncurses-init-color.xml 20 Jun 2007 22:25:03 -0000 1.6 +++ functions/ncurses-init-color.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-init-color" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_init_color</refname> - <refpurpose>Set new RGB value for color </refpurpose> + <refpurpose>Define a terminal color</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -15,7 +15,16 @@ <methodparam><type>int</type><parameter>b</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - &warn.undocumented.func; + <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; @@ -25,6 +34,7 @@ <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> @@ -32,6 +42,7 @@ <term><parameter>r</parameter></term> <listitem> <para> + A color value, between 0 and 1000, for the red component. </para> </listitem> </varlistentry> @@ -39,6 +50,7 @@ <term><parameter>g</parameter></term> <listitem> <para> + A color value, between 0 and 1000, for the green component. </para> </listitem> </varlistentry> @@ -46,12 +58,29 @@ <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 -1 if the function was successful, and 0 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 Index: functions/ncurses-init-pair.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-init-pair.xml,v retrieving revision 1.6 diff -u -r1.6 ncurses-init-pair.xml --- functions/ncurses-init-pair.xml 20 Jun 2007 22:25:03 -0000 1.6 +++ functions/ncurses-init-pair.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-init-pair" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_init_pair</refname> - <refpurpose>Allocate a color pair </refpurpose> + <refpurpose>Define a color pair</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -14,7 +14,16 @@ <methodparam><type>int</type><parameter>bg</parameter></methodparam> </methodsynopsis> &warn.experimental.func; - &warn.undocumented.func; + <para> + Defines or redefines the given color pair to have the given foreground and background colors. + If the color pair was previously initialized, the screen is refreshed and all occurrences of it are + changed to reflect the new definition. + </para> + <para> + Color capabilities must be initialized using <function>ncurses_start_color</function> before calling this function. + The first color pair (color pair 0) is assumed to be white on black (or whatever color pair the terminal defines before + colors have been initialized), and cannot be changed. + </para> </refsect1> <refsect1 role="parameters"> &reftitle.parameters; @@ -24,6 +33,7 @@ <term><parameter>pair</parameter></term> <listitem> <para> + The number of the color pair to define. </para> </listitem> </varlistentry> @@ -31,6 +41,8 @@ <term><parameter>fg</parameter></term> <listitem> <para> + The foreground color for the color pair. May be one of the pre-defined colors or one defined by + <function>ncurses_init_color</function> if the terminal has color changing capabilities. </para> </listitem> </varlistentry> @@ -38,12 +50,67 @@ <term><parameter>bg</parameter></term> <listitem> <para> + The background color for the color pair. May be one of the pre-defined colors or one defined by + <function>ncurses_init_color</function> if the terminal has color changing capabilities. </para> </listitem> </varlistentry> </variablelist> </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns -1 if the function was successful, and 0 if ncurses or color support were not initialized. + </para> + </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + <para> + Note that color changing capabilities are not required for + defining color pairs of pre-existing colors, but only for changing definitions (red, green, and blue components) + of colors themselves per <function>ncurses_init_color</function>. + </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Writing a string with a specified color to the screen</title> + <programlisting role="php"> +<![CDATA[ +<?php +ncurses_init(); + +// If the terminal supports colors, initialize and set active color +if (ncurses_has_colors()) { + ncurses_start_color(); + ncurses_init_pair(1, NCURSES_COLOR_YELLOW, NCURSES_COLOR_BLUE); + ncurses_color_set(1); +} + +// Write a string at specified location +ncurses_mvaddstr(10, 10, "Hello world! Yellow on blue text!"); + +// Flush output to screen +ncurses_refresh(); + +ncurses_end(); +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_pair_content</function></member> + <member><function>ncurses_start_color</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file Index: functions/ncurses-init.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-init.xml,v retrieving revision 1.8 diff -u -r1.8 ncurses-init.xml --- functions/ncurses-init.xml 20 Jun 2007 22:25:03 -0000 1.8 +++ functions/ncurses-init.xml 5 Apr 2009 04:52:29 -0000 @@ -13,9 +13,17 @@ </methodsynopsis> &warn.experimental.func; <para> - Initializes the ncurses interface and must be used before any other + Initializes the ncurses interface. This function must be used before any other ncurses function call. </para> + <para> + Note that <function>ncurses_end</function> must be called before exiting from the program, or the terminal will not + be restored to its proper non-visual mode. + </para> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; </refsect1> <refsect1 role="returnvalues"> &reftitle.returnvalues; @@ -23,6 +31,14 @@ &return.void; </para> </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_end</function></member> + </simplelist> + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file Index: functions/ncurses-pair-content.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-pair-content.xml,v retrieving revision 1.5 diff -u -r1.5 ncurses-pair-content.xml --- functions/ncurses-pair-content.xml 20 Jun 2007 22:25:03 -0000 1.5 +++ functions/ncurses-pair-content.xml 5 Apr 2009 04:52:29 -0000 @@ -3,7 +3,7 @@ <refentry xml:id="function.ncurses-pair-content" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_pair_content</refname> - <refpurpose>Gets the RGB value for color</refpurpose> + <refpurpose>Retrieves foreground and background colors of a color pair</refpurpose> </refnamediv> <refsect1 role="description"> &reftitle.description; @@ -13,7 +13,10 @@ <methodparam><type>int</type><parameter role="reference">f</parameter></methodparam> <methodparam><type>int</type><parameter role="reference">b</parameter></methodparam> </methodsynopsis> - &warn.undocumented.func; + <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; @@ -23,6 +26,7 @@ <term><parameter>pair</parameter></term> <listitem> <para> + The number of the color pair to retrieve information for. </para> </listitem> </varlistentry> @@ -30,6 +34,9 @@ <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 pre-defined colors or a color defined previously by + <function>ncurses_init_color</function> if the terminal supports color changing. </para> </listitem> </varlistentry> @@ -37,12 +44,30 @@ <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 pre-defined colors 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 -1 if the function was successful, and 0 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 Index: functions/ncurses-start-color.xml =================================================================== RCS file: /repository/phpdoc/en/reference/ncurses/functions/ncurses-start-color.xml,v retrieving revision 1.6 diff -u -r1.6 ncurses-start-color.xml --- functions/ncurses-start-color.xml 20 Jun 2007 22:25:03 -0000 1.6 +++ functions/ncurses-start-color.xml 5 Apr 2009 04:52:29 -0000 @@ -3,8 +3,9 @@ <refentry xml:id="function.ncurses-start-color" xmlns="http://docbook.org/ns/docbook"> <refnamediv> <refname>ncurses_start_color</refname> - <refpurpose>Start using colors </refpurpose> + <refpurpose>Initializes color functionality</refpurpose> </refnamediv> + <refsect1 role="description"> &reftitle.description; <methodsynopsis> @@ -12,8 +13,66 @@ <void/> </methodsynopsis> &warn.experimental.func; - &warn.undocumented.func; + <para> + Initializes color functionality in ncurses. This function must be called before any color manipulation functions are called + and after <function>ncurses_init</function> is called. + It is good practice to call this function right after <function>ncurses_init</function>. + </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + &no.function.parameters; + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns 0 on success, -1 if the color table could not be allocated or ncurses was not initialized. + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Writing a string with a specified color to the screen</title> + <programlisting role="php"> +<![CDATA[ +<?php +ncurses_init(); + +// If the terminal supports colors, initialize and set active color +if (ncurses_has_colors()) { + ncurses_start_color(); + ncurses_init_pair(1, NCURSES_COLOR_YELLOW, NCURSES_COLOR_BLUE); + ncurses_color_set(1); +} + +// Write a string at specified location +ncurses_mvaddstr(10, 10, "Hello world! Yellow on blue text!"); + +// Flush output to screen +ncurses_refresh(); + +ncurses_end(); +?> +]]> + </programlisting> + </example> + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>ncurses_can_change_color</function></member> + <member><function>ncurses_has_colors</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file