Ref/ncurses-Phpdoc专题

ncurses_addch

Add character at current position and advance cursor

说明

int ncurses_addch ( int $ch )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

ch

ncurses_addchnstr

Add attributed string with specified length at current position

说明

int ncurses_addchnstr ( string $s , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

s

n

ncurses_addchstr

Add attributed string at current position

说明

int ncurses_addchstr ( string $s )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

s

ncurses_addnstr

Add string with specified length at current position

说明

int ncurses_addnstr ( string $s , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

s

n

ncurses_addstr

Output text at current position

说明

int ncurses_addstr ( string $text )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

text

ncurses_assume_default_colors

Define default colors for color 0

说明

int ncurses_assume_default_colors ( int $fg , int $bg )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

fg

bg

ncurses_attroff

Turn off the given attributes

说明

int ncurses_attroff ( int $attributes )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

attributes

ncurses_attron

Turn on the given attributes

说明

int ncurses_attron ( int $attributes )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

attributes

ncurses_attrset

Set given attributes

说明

int ncurses_attrset ( int $attributes )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

attributes

ncurses_baudrate

Returns baudrate of terminal

说明

int ncurses_baudrate ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_beep

Let the terminal beep

说明

int ncurses_beep ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

ncurses_beep sends an audible alert (bell) and if its not possible flashes the screen.

参见

ncurses_flash

ncurses_bkgd

Set background property for terminal screen

说明

int ncurses_bkgd ( int $attrchar )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

attrchar

ncurses_bkgdset

Control screen background

说明

void ncurses_bkgdset ( int $attrchar )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

attrchar

ncurses_border

Draw a border around the screen using attributed characters

说明

int ncurses_border ( int $left , int $right , int $top , int $bottom , int $tl_corner , int $tr_corner , int $bl_corner , int $br_corner )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Draws the specified lines and corners around the main window.

Use ncurses_wborder for borders around subwindows!

参数

Every parameter expects 0 to draw a line or 1 to skip it.

left

right

top

bottom

tl_corner
Top left corner

tr_corner
Top right corner

bl_corner
Bottom left corner

br_corner
Bottom right corner

参见

ncurses_wborder

ncurses_bottom_panel

Moves a visible panel to the bottom of the stack

说明

int ncurses_bottom_panel ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

ncurses_can_change_color

Checks if terminal color definitions can be changed

说明

bool ncurses_can_change_color ( void )

Checks whether the terminal has color capabilities and whether the programmer can change color definitions using ncurses_init_color. ncurses must be initialized using ncurses_init before calling this function.

参数

此函数没有参数。

返回值

Return true if the programmer can change color definitions, false otherwise.

参见

ncurses_has_colors
ncurses_init_color
ncurses_start_color

ncurses_cbreak

Switch off input buffering

说明

bool ncurses_cbreak ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Disables line buffering and character processing (interrupt and flow control characters are unaffected), making characters typed by the user immediately available to the program.

返回值

Returns true or NCURSES_ERR if any error occurred.

参见

ncurses_nocbreak

ncurses_clear

Clear screen

说明

bool ncurses_clear ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Clears the screen completely without setting blanks.

Note: ncurses_clear clears the screen without setting blanks, which have the current background rendition. To clear screen with blanks, use ncurses_erase.

返回值

成功时返回 true，或者在失败时返回 false。

参见

ncurses_erase

ncurses_clrtobot

Clear screen from current position to bottom

说明

bool ncurses_clrtobot ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Erases all lines from cursor to end of screen and creates blanks. Blanks created by ncurses_clrtobot have the current background rendition.

返回值

成功时返回 true，或者在失败时返回 false。

参见

ncurses_clear
ncurses_clrtoeol

ncurses_clrtoeol

Clear screen from current position to end of line

说明

bool ncurses_clrtoeol ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Erases the current line from cursor position to the end. Blanks created by ncurses_clrtoeol have the current background rendition.

返回值

成功时返回 true，或者在失败时返回 false。

参见

ncurses_clear
ncurses_clrtobot

ncurses_color_content

Retrieves RGB components of a color

说明

int ncurses_color_content ( int $color , int &$r , int &$g , int &$b )

Retrieves the red, green, and blue components for the given color definition. Terminal color capabilities must be initialized with ncurses_start_color prior to calling this function.

参数

color
The number of the color to retrieve information for. May be one of the pre-defined color constants.

r
A reference to which to return the red component of the color. The value returned to the reference will be between 0 and 1000.

g
A reference to which to return the green component of the color. The value returned to the reference will be between 0 and 1000.

b
A reference to which to return the blue component of the color. The value returned to the reference will be between 0 and 1000.

返回值

Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized.

参见

ncurses_init_color
ncurses_start_color

ncurses_color_set

Set active foreground and background colors

说明

int ncurses_color_set ( int $pair )

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 ncurses_start_color beforehand.

ncurses uses color pairs to specify both foreground and background colors. Use ncurses_init_pair to define a color pair.

参数

pair
The color pair from which to get the foreground and background colors to set as the active colors.

返回值

Returns -1 on success, and 0 on failure.

范例

示例 #1 Writing a string with a specified color to the screen

<?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();
?>

参见

ncurses_init_pair
ncurses_start_color

ncurses_curs_set

Set cursor state

说明

int ncurses_curs_set ( int $visibility )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

visibility

ncurses_def_prog_mode

Saves terminals (program) mode

说明

bool ncurses_def_prog_mode ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Saves the current terminal modes for program (in curses) for use by ncurses_reset_prog_mode.

返回值

Returns false on success, otherwise true.

参见

ncurses_reset_prog_mode

ncurses_def_shell_mode

Saves terminals (shell) mode

说明

bool ncurses_def_shell_mode ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Saves the current terminal modes for shell (not in curses) for use by ncurses_reset_shell_mode.

返回值

Returns false on success, true otherwise.

参见

ncurses_reset_shell_mode

ncurses_define_key

Define a keycode

说明

int ncurses_define_key ( string $definition , int $keycode )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

definition

keycode

ncurses_del_panel

Remove panel from the stack and delete it (but not the associated window)

说明

bool ncurses_del_panel ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

ncurses_delay_output

Delay output on terminal using padding characters

说明

int ncurses_delay_output ( int $milliseconds )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

milliseconds

ncurses_delch

Delete character at current position, move rest of line left

说明

bool ncurses_delch ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Deletes the character under the cursor. All characters to the right of the cursor on the same line are moved to the left one position and the last character on the line is filled with a blank. The cursor position does not change.

返回值

Returns false on success, true otherwise.

参见

ncurses_deleteln

ncurses_deleteln

Delete line at current position, move rest of screen up

说明

bool ncurses_deleteln ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Deletes the current line under cursor position. All lines below the current line are moved up one line. The bottom line of window is cleared. Cursor position does not change.

返回值

Returns false on success, otherwise true.

参见

ncurses_delch

ncurses_delwin

Delete a ncurses window

说明

bool ncurses_delwin ( resource $window )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_doupdate

Write all prepared refreshes to terminal

说明

bool ncurses_doupdate ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Compares the virtual screen to the physical screen and updates the physical screen. This way is more effective than using multiple refresh calls.

返回值

成功时返回 true，或者在失败时返回 false。

ncurses_echo

Activate keyboard input echo

说明

bool ncurses_echo ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Enables echo mode. All characters typed by user are echoed by ncurses_getch.

返回值

Returns false on success, true if any error occurred.

参见

ncurses_noecho to disable echo mode

ncurses_echochar

Single character output including refresh

说明

int ncurses_echochar ( int $character )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

character

ncurses_end

Stop using ncurses, clean up the screen

说明

int ncurses_end ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_erase

Erase terminal screen

说明

bool ncurses_erase ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Fills the terminal screen with blanks.

Created blanks have the current background rendition, set by ncurses_bkgd.

返回值

成功时返回 true，或者在失败时返回 false。

参见

ncurses_bkgd
ncurses_clear

ncurses_erasechar

Returns current erase character

说明

string ncurses_erasechar ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns the current erase character.

返回值

The current erase char, as a string.

参见

ncurses_killchar

ncurses_filter

Set LINES for iniscr() and newterm() to 1

说明

void ncurses_filter ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_flash

Flash terminal screen (visual bell)

说明

bool ncurses_flash ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Flashes the screen, and if its not possible, sends an audible alert (bell).

返回值

Returns false on success, otherwise true.

参见

ncurses_beep

ncurses_flushinp

Flush keyboard input buffer

说明

bool ncurses_flushinp ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Throws away any typeahead that has been typed and has not yet been read by your program.

返回值

Returns false on success, otherwise true.

ncurses_getch

Read a character from keyboard

说明

int ncurses_getch ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_getmaxyx

Returns the size of a window

说明

void ncurses_getmaxyx ( resource $window , int &$y , int &$x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Gets the horizontal and vertical size of the given window into the given variables.

Variables must be passed as reference, so they are updated when the user changes the terminal size.

参数

window
The measured window

y
This will be set to the window height

x
This will be set to the window width

返回值

没有返回值。

ncurses_getmouse

Reads mouse event

说明

bool ncurses_getmouse ( array &$mevent )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

ncurses_getmouse reads mouse event out of queue.

参数

mevent
Event options will be delivered in this parameter which has to be an array, passed by reference (see example below).

On success an associative array with following keys will be delivered:

"id" : Id to distinguish multiple devices
"x" : screen relative x-position in character cells
"y" : screen relative y-position in character cells
"z" : currently not supported
"mmask" : Mouse action

返回值

Returns false if a mouse event is actually visible in the given window, otherwise returns true.

范例

示例 #1 ncurses_getmouse example

<?php
switch (ncurses_getch()){
  case NCURSES_KEY_MOUSE:
    if (!ncurses_getmouse($mevent)){
      if ($mevent["mmask"] & NCURSES_MOUSE_BUTTON1_PRESSED){
        $mouse_x = $mevent["x"]; // Save mouse position
        $mouse_y = $mevent["y"];
      }
    }
  break;

  default:
    /* .... */
}
?>

参见

ncurses_ungetmouse

ncurses_getyx

Returns the current cursor position for a window

说明

void ncurses_getyx ( resource $window , int &$y , int &$x )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

y

x

ncurses_halfdelay

Put terminal into halfdelay mode

说明

int ncurses_halfdelay ( int $tenth )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

tenth

ncurses_has_colors

Checks if terminal has color capabilities

说明

bool ncurses_has_colors ( void )

Checks whether the terminal has color capabilities. This function can be used to write terminal-independent programs. ncurses must be initialized using ncurses_init before calling this function.

参数

此函数没有参数。

返回值

Return true if the terminal has color capabilities, false otherwise.

范例

示例 #1 Writing a string with a specified color to the screen

<?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();
?>

参见

ncurses_can_change_color
ncurses_start_color

ncurses_has_ic

Check for insert- and delete-capabilities

说明

bool ncurses_has_ic ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Checks whether the terminal has insert and delete capabilities.

返回值

Returns true if the terminal has insert/delete-capabilities, false otherwise.

参见

ncurses_has_il

ncurses_has_il

Check for line insert- and delete-capabilities

说明

bool ncurses_has_il ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Checks whether the terminal has insert- and delete-line-capabilities.

返回值

Returns true if the terminal has insert/delete-line capabilities, false otherwise.

参见

ncurses_has_ic

ncurses_has_key

Check for presence of a function key on terminal keyboard

说明

int ncurses_has_key ( int $keycode )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

keycode

ncurses_hide_panel

Remove panel from the stack, making it invisible

说明

int ncurses_hide_panel ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

ncurses_hline

Draw a horizontal line at current position using an attributed character and max. n characters long

说明

int ncurses_hline ( int $charattr , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

charattr

n

ncurses_inch

Get character and attribute at current position

说明

string ncurses_inch ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns the character from the current position.

返回值

Returns the character, as a string.

ncurses_init_color

Define a terminal color

说明

int ncurses_init_color ( int $color , int $r , int $g , int $b )

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.

Color capabilities must be supported by the terminal and initialized using ncurses_start_color prior to calling this function. In addition, the terminal must have color changing capabilities; use ncurses_can_change_color to check for this.

参数

color
The identification number of the color to redefine. It may be one of the default color constants.

r
A color value, between 0 and 1000, for the red component.

g
A color value, between 0 and 1000, for the green component.

b
A color value, between 0 and 1000, for the blue component.

返回值

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.

参见

ncurses_color_content
ncurses_start_color

ncurses_init_pair

Define a color pair

说明

int ncurses_init_pair ( int $pair , int $fg , int $bg )

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.

Color capabilities must be initialized using ncurses_start_color before calling this function. The first color pair (color pair 0) is assumed to be white on black by default, but can be changed using ncurses_assume_default_colors.

参数

pair
The number of the color pair to define.

fg
The foreground color for the color pair. May be one of the pre-defined colors or one defined by ncurses_init_color if the terminal has color changing capabilities.

bg
The background color for the color pair. May be one of the pre-defined colors or one defined by ncurses_init_color if the terminal has color changing capabilities.

返回值

Returns -1 if the function was successful, and 0 if ncurses or color support were not initialized.

注释

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 ncurses_init_color.

范例

示例 #1 Writing a string with a specified color to the screen

<?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();
?>

参见

ncurses_pair_content
ncurses_start_color

ncurses_init

Initialize ncurses

说明

void ncurses_init ( void )

Initializes the ncurses interface. This function must be used before any other ncurses function call.

Note that ncurses_end must be called before exiting from the program, or the terminal will not be restored to its proper non-visual mode.

参数

此函数没有参数。

返回值

没有返回值。

参见

ncurses_end

ncurses_insch

Insert character moving rest of line including character at current position

说明

int ncurses_insch ( int $character )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

character

ncurses_insdelln

Insert lines before current line scrolling down (negative numbers delete and scroll up)

说明

int ncurses_insdelln ( int $count )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

count

ncurses_insertln

Insert a line, move rest of screen down

说明

int ncurses_insertln ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Inserts a new line above the current line. The bottom line will be lost.

ncurses_insstr

Insert string at current position, moving rest of line right

说明

int ncurses_insstr ( string $text )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

text

ncurses_instr

Reads string from terminal screen

说明

int ncurses_instr ( string &$buffer )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Reads a string from the terminal screen and returns the number of characters read from the current character position until end of line.

参数

buffer
The characters. Attributes will be stripped.

返回值

Returns the number of characters.

ncurses_isendwin

Ncurses is in endwin mode, normal screen output may be performed

说明

bool ncurses_isendwin ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Checks if ncurses is in endwin mode.

返回值

Returns true, if ncurses_end has been called without any subsequent calls to ncurses_wrefresh, false otherwise.

参见

ncurses_end
ncurses_wrefresh

ncurses_keyok

Enable or disable a keycode

说明

int ncurses_keyok ( int $keycode , bool $enable )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

keycode

enable

ncurses_keypad

Turns keypad on or off

说明

int ncurses_keypad ( resource $window , bool $bf )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

bf

ncurses_killchar

Returns current line kill character

说明

string ncurses_killchar ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns the current line kill character.

返回值

Returns the kill character, as a string.

参见

ncurses_erasechar

ncurses_longname

Returns terminals description

说明

string ncurses_longname ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns a verbose description of the terminal.

返回值

Returns the description, as a string truncated to 128 characters. On errors, returns null.

参见

ncurses_termname

ncurses_meta

Enables/Disable 8-bit meta key information

说明

int ncurses_meta ( resource $window , bool $8bit )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

8bit

ncurses_mouse_trafo

Transforms coordinates

说明

bool ncurses_mouse_trafo ( int &$y , int &$x , bool $toscreen )

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

toscreen

ncurses_mouseinterval

Set timeout for mouse button clicks

说明

int ncurses_mouseinterval ( int $milliseconds )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

milliseconds

ncurses_mousemask

Sets mouse options

说明

int ncurses_mousemask ( int $newmask , int &$oldmask )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Sets mouse events to be reported. By default no mouse events will be reported.

Mouse events are represented by NCURSES_KEY_MOUSE in the ncurses_wgetch input stream. To read the event data and pop the event of queue, call ncurses_getmouse.

参数

newmask
Mouse mask options can be set with the following predefined constants:

NCURSES_BUTTON1_PRESSED
NCURSES_BUTTON1_RELEASED
NCURSES_BUTTON1_CLICKED
NCURSES_BUTTON1_DOUBLE_CLICKED
NCURSES_BUTTON1_TRIPLE_CLICKED
NCURSES_BUTTON2_PRESSED
NCURSES_BUTTON2_RELEASED
NCURSES_BUTTON2_CLICKED
NCURSES_BUTTON2_DOUBLE_CLICKED
NCURSES_BUTTON2_TRIPLE_CLICKED
NCURSES_BUTTON3_PRESSED
NCURSES_BUTTON3_RELEASED
NCURSES_BUTTON3_CLICKED
NCURSES_BUTTON3_DOUBLE_CLICKED
NCURSES_BUTTON3_TRIPLE_CLICKED
NCURSES_BUTTON4_PRESSED
NCURSES_BUTTON4_RELEASED
NCURSES_BUTTON4_CLICKED
NCURSES_BUTTON4_DOUBLE_CLICKED
NCURSES_BUTTON4_TRIPLE_CLICKED
NCURSES_BUTTON_SHIFT>
NCURSES_BUTTON_CTRL
NCURSES_BUTTON_ALT
NCURSES_ALL_MOUSE_EVENTS
NCURSES_REPORT_MOUSE_POSITION

As a side effect, setting a zero mousemask in newmask turns off the mouse pointer. Setting a non zero value turns mouse pointer on.

oldmask
This will be set to the previous value of the mouse event mask.

返回值

Returns the mask of reportable events. On complete failure, it returns 0.

范例

示例 #1 ncurses_mousemask example

<?php
$newmask = NCURSES_BUTTON1_CLICKED + NCURSES_BUTTON1_RELEASED;
$mask = ncurses_mousemask($newmask, $oldmask);
if ($mask & $newmask){
    printf("All specified mouse options will be supported\n");
}
?>

参见

ncurses_getch
ncurses_getmouse
ncurses_ungetmouse

ncurses_move_panel

Moves a panel so that its upper-left corner is at [startx, starty]

说明

int ncurses_move_panel ( resource $panel , int $startx , int $starty )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

startx

starty

ncurses_move

Move output position

说明

int ncurses_move ( int $y , int $x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

ncurses_mvaddch

Move current position and add character

说明

int ncurses_mvaddch ( int $y , int $x , int $c )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

c

ncurses_mvaddchnstr

Move position and add attributed string with specified length

说明

int ncurses_mvaddchnstr ( int $y , int $x , string $s , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

s

n

ncurses_mvaddchstr

Move position and add attributed string

说明

int ncurses_mvaddchstr ( int $y , int $x , string $s )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

s

ncurses_mvaddnstr

Move position and add string with specified length

说明

int ncurses_mvaddnstr ( int $y , int $x , string $s , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

s

n

ncurses_mvaddstr

Move position and add string

说明

int ncurses_mvaddstr ( int $y , int $x , string $s )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

s

ncurses_mvcur

Move cursor immediately

说明

int ncurses_mvcur ( int $old_y , int $old_x , int $new_y , int $new_x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

old_y

old_x

new_y

new_x

ncurses_mvdelch

Move position and delete character, shift rest of line left

说明

int ncurses_mvdelch ( int $y , int $x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

ncurses_mvgetch

Move position and get character at new position

说明

int ncurses_mvgetch ( int $y , int $x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

ncurses_mvhline

Set new position and draw a horizontal line using an attributed character and max. n characters long

说明

int ncurses_mvhline ( int $y , int $x , int $attrchar , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

attrchar

n

ncurses_mvinch

Move position and get attributed character at new position

说明

int ncurses_mvinch ( int $y , int $x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

ncurses_mvvline

Set new position and draw a vertical line using an attributed character and max. n characters long

说明

int ncurses_mvvline ( int $y , int $x , int $attrchar , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

y

x

attrchar

n

ncurses_mvwaddstr

Add string at new position in window

说明

int ncurses_mvwaddstr ( resource $window , int $y , int $x , string $text )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

window

y

x

text

ncurses_napms

Sleep

说明

int ncurses_napms ( int $milliseconds )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

milliseconds

ncurses_new_panel

Create a new panel and associate it with window

说明

resource ncurses_new_panel ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_newpad

Creates a new pad (window)

说明

resource ncurses_newpad ( int $rows , int $cols )

Warning

本函数还未编写文档，仅有参数列表。

参数

rows

cols

ncurses_newwin

Create a new window

说明

resource ncurses_newwin ( int $rows , int $cols , int $y , int $x )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Creates a new window to draw elements in.

When creating additional windows, remember to use ncurses_getmaxyx to check for available space, as terminal size is individual and may vary.

参数

rows
Number of rows

cols
Number of columns

y
y-coordinate of the origin

x
x-coordinate of the origin

返回值

Returns a resource ID for the new window.

ncurses_nl

Translate newline and carriage return / line feed

说明

bool ncurses_nl ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_nocbreak

Switch terminal to cooked mode

说明

bool ncurses_nocbreak ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns terminal to normal (cooked) mode. Initially the terminal may or may not be in cbreak mode as the mode is inherited. Therefore a program should call ncurses_cbreak and ncurses_nocbreak explicitly.

返回值

Returns true if any error occurred, otherwise false.

参见

ncurses_cbreak

ncurses_noecho

Switch off keyboard input echo

说明

bool ncurses_noecho ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Prevents echoing of user typed characters.

返回值

Returns true if any error occurred, false otherwise.

参见

ncurses_echo
ncurses_getch

ncurses_nonl

Do not translate newline and carriage return / line feed

说明

bool ncurses_nonl ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_noqiflush

Do not flush on signal characters

说明

void ncurses_noqiflush ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_noraw

Switch terminal out of raw mode

说明

bool ncurses_noraw ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Switches the terminal out of raw mode. Raw mode is similar to cbreak mode, in that characters typed are immediately passed through to the user program. The difference is that in raw mode, the interrupt, quit, suspend and flow control characters are all passed through uninterpreted, instead of generating a signal.

返回值

Returns true if any error occurred, otherwise false.

参见

ncurses_raw
ncurses_cbreak
ncurses_nocbreak

ncurses_pair_content

Retrieves foreground and background colors of a color pair

说明

int ncurses_pair_content ( int $pair , int &$f , int &$b )

Retrieves the foreground and background colors that constitute the given color pair. Terminal color capabilities must be initialized with ncurses_start_color prior to calling this function.

参数

pair
The number of the color pair to retrieve information for.

f
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 ncurses_init_color if the terminal supports color changing.

b
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 ncurses_init_color if the terminal supports color changing.

返回值

Returns -1 if the function was successful, and 0 if ncurses or terminal color capabilities have not been initialized.

参见

ncurses_init_pair
ncurses_start_color

ncurses_panel_above

Returns the panel above panel

说明

resource ncurses_panel_above ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

返回值

If panel is null, returns the bottom panel in the stack.

ncurses_panel_below

Returns the panel below panel

说明

resource ncurses_panel_below ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

参数

If panel is null, returns the top panel in the stack.

ncurses_panel_window

Returns the window associated with panel

说明

resource ncurses_panel_window ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

ncurses_pnoutrefresh

Copies a region from a pad into the virtual screen

说明

int ncurses_pnoutrefresh ( resource $pad , int $pminrow , int $pmincol , int $sminrow , int $smincol , int $smaxrow , int $smaxcol )

Warning

本函数还未编写文档，仅有参数列表。

参数

pad

pminrow

pmincol

sminrow

smincol

smaxrow

smaxcol

ncurses_prefresh

Copies a region from a pad into the virtual screen

说明

int ncurses_prefresh ( resource $pad , int $pminrow , int $pmincol , int $sminrow , int $smincol , int $smaxrow , int $smaxcol )

Warning

本函数还未编写文档，仅有参数列表。

参数

pad

pminrow

pmincol

sminrow

smincol

smaxrow

smaxcol

ncurses_putp

Apply padding information to the string and output it

说明

int ncurses_putp ( string $text )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

text

ncurses_qiflush

Flush on signal characters

说明

void ncurses_qiflush ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_raw

Switch terminal into raw mode

说明

bool ncurses_raw ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Places the terminal in raw mode. Raw mode is similar to cbreak mode, in that characters typed are immediately passed through to the user program. The difference is that in raw mode, the interrupt, quit, suspend and flow control characters are all passed through uninterpreted, instead of generating a signal.

返回值

Returns true if any error occurred, otherwise false.

参见

ncurses_noraw
ncurses_cbreak
ncurses_nocbreak

ncurses_refresh

Refresh screen

说明

int ncurses_refresh ( int $ch )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

ch

ncurses_replace_panel

Replaces the window associated with panel

说明

int ncurses_replace_panel ( resource $panel , resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

window

ncurses_reset_prog_mode

Resets the prog mode saved by def_prog_mode

说明

int ncurses_reset_prog_mode ( void )

Warning

本函数还未编写文档，仅有参数列表。

ncurses_reset_shell_mode

Resets the shell mode saved by def_shell_mode

说明

int ncurses_reset_shell_mode ( void )

Warning

本函数还未编写文档，仅有参数列表。

ncurses_resetty

Restores saved terminal state

说明

bool ncurses_resetty ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Restores the terminal state, which was previously saved by calling ncurses_savetty.

返回值

Always returns false.

参见

ncurses_savetty

ncurses_savetty

Saves terminal state

说明

bool ncurses_savetty ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Saves the current terminal state. The saved terminal state can be restored with ncurses_resetty.

返回值

Always returns false.

参见

ncurses_resetty

ncurses_scr_dump

Dump screen content to file

说明

int ncurses_scr_dump ( string $filename )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

filename

ncurses_scr_init

Initialize screen from file dump

说明

int ncurses_scr_init ( string $filename )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

filename

ncurses_scr_restore

Restore screen from file dump

说明

int ncurses_scr_restore ( string $filename )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

filename

ncurses_scr_set

Inherit screen from file dump

说明

int ncurses_scr_set ( string $filename )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

filename

ncurses_scrl

Scroll window content up or down without changing current position

说明

int ncurses_scrl ( int $count )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

count

ncurses_show_panel

Places an invisible panel on top of the stack, making it visible

说明

int ncurses_show_panel ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

ncurses_slk_attr

Returns current soft label key attribute

说明

int ncurses_slk_attr ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns the current soft label key attribute.

返回值

The attribute, as an integer.

ncurses_slk_attroff

Turn off the given attributes for soft function-key labels

说明

int ncurses_slk_attroff ( int $intarg )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

intarg

ncurses_slk_attron

Turn on the given attributes for soft function-key labels

说明

int ncurses_slk_attron ( int $intarg )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

intarg

ncurses_slk_attrset

Set given attributes for soft function-key labels

说明

int ncurses_slk_attrset ( int $intarg )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

intarg

ncurses_slk_clear

Clears soft labels from screen

说明

bool ncurses_slk_clear ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

The function ncurses_slk_clear clears soft label keys from screen.

返回值

Returns true on errors, false otherwise.

ncurses_slk_color

Sets color for soft label keys

说明

int ncurses_slk_color ( int $intarg )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

intarg

ncurses_slk_init

Initializes soft label key functions

说明

bool ncurses_slk_init ( int $format )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Initializes soft label key functions

This function must be called before ncurses_init or ncurses_newwin is called.

参数

format
If ncurses_init eventually uses a line from stdscr to emulate the soft labels, then this parameter determines how the labels are arranged of the screen.

0 indicates a 3-2-3 arrangement of the labels, 1 indicates a 4-4 arrangement and 2 indicates the PC like 4-4-4 mode, but in addition an index line will be created.

返回值

成功时返回 true，或者在失败时返回 false。

ncurses_slk_noutrefresh

Copies soft label keys to virtual screen

说明

bool ncurses_slk_noutrefresh ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_slk_refresh

Copies soft label keys to screen

说明

int ncurses_slk_refresh ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Copies soft label keys from virtual screen to physical screen.

ncurses_slk_restore

Restores soft label keys

说明

int ncurses_slk_restore ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Restores the soft label keys after ncurses_slk_clear has been performed.

ncurses_slk_set

Sets function key labels

说明

bool ncurses_slk_set ( int $labelnr , string $label , int $format )

Warning

本函数还未编写文档，仅有参数列表。

参数

labelnr

label

format

ncurses_slk_touch

Forces output when ncurses_slk_noutrefresh is performed

说明

int ncurses_slk_touch ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Forces all the soft labels to be output the next time a ncurses_slk_noutrefresh is performed.

ncurses_standend

Stop using 'standout' attribute

说明

int ncurses_standend ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_standout

Start using 'standout' attribute

说明

int ncurses_standout ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_start_color

Initializes color functionality

说明

int ncurses_start_color ( void )

Initializes color functionality in ncurses. This function must be called before any color manipulation functions are called and after ncurses_init is called. It is good practice to call this function right after ncurses_init.

参数

此函数没有参数。

返回值

Returns 0 on success, or -1 if the color table could not be allocated or ncurses was not initialized.

范例

示例 #1 Writing a string with a specified color to the screen

<?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();
?>

参见

ncurses_can_change_color
ncurses_has_colors

ncurses_termattrs

Returns a logical OR of all attribute flags supported by terminal

说明

bool ncurses_termattrs ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_termname

Returns terminals (short)-name

说明

string ncurses_termname ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Returns terminals shortname.

返回值

Returns the shortname of the terminal, truncated to 14 characters. On errors, returns null.

参见

ncurses_longname

ncurses_timeout

Set timeout for special key sequences

说明

void ncurses_timeout ( int $millisec )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

millisec

ncurses_top_panel

Moves a visible panel to the top of the stack

说明

int ncurses_top_panel ( resource $panel )

Warning

本函数还未编写文档，仅有参数列表。

参数

panel

ncurses_typeahead

Specify different filedescriptor for typeahead checking

说明

int ncurses_typeahead ( int $fd )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

fd

ncurses_ungetch

Put a character back into the input stream

说明

int ncurses_ungetch ( int $keycode )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

keycode

ncurses_ungetmouse

Pushes mouse event to queue

说明

bool ncurses_ungetmouse ( array $mevent )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Pushes a KEY_MOUSE event onto the input queue and associates with this event the given state data and screen-relative character cell coordinates, specified in mevent.

参数

mevent
An associative array specifying the event options:

"id" : Id to distinguish multiple devices
"x" : screen relative x-position in character cells
"y" : screen relative y-position in character cells
"z" : currently not supported
"mmask" : Mouse action

返回值

Returns false on success, true otherwise.

参见

ncurses_getmouse

ncurses_update_panels

Refreshes the virtual screen to reflect the relations between panels in the stack

说明

void ncurses_update_panels ( void )

Warning

本函数还未编写文档，仅有参数列表。

ncurses_use_default_colors

Assign terminal default colors to color id -1

说明

bool ncurses_use_default_colors ( void )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

ncurses_use_env

Control use of environment information about terminal size

说明

void ncurses_use_env ( bool $flag )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

flag

ncurses_use_extended_names

Control use of extended names in terminfo descriptions

说明

int ncurses_use_extended_names ( bool $flag )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

flag

ncurses_vidattr

Display the string on the terminal in the video attribute mode

说明

int ncurses_vidattr ( int $intarg )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

intarg

ncurses_vline

Draw a vertical line at current position using an attributed character and max. n characters long

说明

int ncurses_vline ( int $charattr , int $n )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

charattr

n

ncurses_waddch

Adds character at current position in a window and advance cursor

说明

int ncurses_waddch ( resource $window , int $ch )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ch

ncurses_waddstr

Outputs text at current postion in window

说明

int ncurses_waddstr ( resource $window , string $str [, int $n ] )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

str

n

ncurses_wattroff

Turns off attributes for a window

说明

int ncurses_wattroff ( resource $window , int $attrs )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

attrs

ncurses_wattron

Turns on attributes for a window

说明

int ncurses_wattron ( resource $window , int $attrs )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

attrs

ncurses_wattrset

Set the attributes for a window

说明

int ncurses_wattrset ( resource $window , int $attrs )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

attrs

ncurses_wborder

Draws a border around the window using attributed characters

说明

int ncurses_wborder ( resource $window , int $left , int $right , int $top , int $bottom , int $tl_corner , int $tr_corner , int $bl_corner , int $br_corner )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Draws the specified lines and corners around the passed window.

Use ncurses_border for borders around the main window.

参数

Each parameter expects 0 to draw a line and 1 to skip it.

window
The window on which we operate

left

right

top

bottom

tl_corner
Top left corner

tr_corner
Top right corner

bl_corner
Bottom left corner

br_corner
Bottom right corner

参见

ncurses_border

ncurses_wclear

Clears window

说明

int ncurses_wclear ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_wcolor_set

Sets windows color pairings

说明

int ncurses_wcolor_set ( resource $window , int $color_pair )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

color_pair

ncurses_werase

Erase window contents

说明

int ncurses_werase ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_wgetch

Reads a character from keyboard (window)

说明

int ncurses_wgetch ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_whline

Draws a horizontal line in a window at current position using an attributed character and max. n characters long

说明

int ncurses_whline ( resource $window , int $charattr , int $n )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

charattr

n

ncurses_wmouse_trafo

Transforms window/stdscr coordinates

说明

bool ncurses_wmouse_trafo ( resource $window , int &$y , int &$x , bool $toscreen )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

x

y

toscreen

ncurses_wmove

Moves windows output position

说明

int ncurses_wmove ( resource $window , int $y , int $x )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

y

x

ncurses_wnoutrefresh

Copies window to virtual screen

说明

int ncurses_wnoutrefresh ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_wrefresh

Refresh window on terminal screen

说明

int ncurses_wrefresh ( resource $window )

Warning

此函数是实验性的。此函数的表象，包括名称及其相关文档都可能在未来的 PHP 发布版本中未通知就被修改。使用本函数风险自担。

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_wstandend

End standout mode for a window

说明

int ncurses_wstandend ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_wstandout

Enter standout mode for a window

说明

int ncurses_wstandout ( resource $window )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

ncurses_wvline

Draws a vertical line in a window at current position using an attributed character and max. n characters long

说明

int ncurses_wvline ( resource $window , int $charattr , int $n )

Warning

本函数还未编写文档，仅有参数列表。

参数

window

charattr

n

ncurses_addch — Add character at current position and advance cursor
ncurses_addchnstr — Add attributed string with specified length at current position
ncurses_addchstr — Add attributed string at current position
ncurses_addnstr — Add string with specified length at current position
ncurses_addstr — Output text at current position
ncurses_assume_default_colors — Define default colors for color 0
ncurses_attroff — Turn off the given attributes
ncurses_attron — Turn on the given attributes
ncurses_attrset — Set given attributes
ncurses_baudrate — Returns baudrate of terminal
ncurses_beep — Let the terminal beep
ncurses_bkgd — Set background property for terminal screen
ncurses_bkgdset — Control screen background
ncurses_border — Draw a border around the screen using attributed characters
ncurses_bottom_panel — Moves a visible panel to the bottom of the stack
ncurses_can_change_color — Checks if terminal color definitions can be changed
ncurses_cbreak — Switch off input buffering
ncurses_clear — Clear screen
ncurses_clrtobot — Clear screen from current position to bottom
ncurses_clrtoeol — Clear screen from current position to end of line
ncurses_color_content — Retrieves RGB components of a color
ncurses_color_set — Set active foreground and background colors
ncurses_curs_set — Set cursor state
ncurses_def_prog_mode — Saves terminals (program) mode
ncurses_def_shell_mode — Saves terminals (shell) mode
ncurses_define_key — Define a keycode
ncurses_del_panel — Remove panel from the stack and delete it (but not the associated window)
ncurses_delay_output — Delay output on terminal using padding characters
ncurses_delch — Delete character at current position, move rest of line left
ncurses_deleteln — Delete line at current position, move rest of screen up
ncurses_delwin — Delete a ncurses window
ncurses_doupdate — Write all prepared refreshes to terminal
ncurses_echo — Activate keyboard input echo
ncurses_echochar — Single character output including refresh
ncurses_end — Stop using ncurses, clean up the screen
ncurses_erase — Erase terminal screen
ncurses_erasechar — Returns current erase character
ncurses_filter — Set LINES for iniscr() and newterm() to 1
ncurses_flash — Flash terminal screen (visual bell)
ncurses_flushinp — Flush keyboard input buffer
ncurses_getch — Read a character from keyboard
ncurses_getmaxyx — Returns the size of a window
ncurses_getmouse — Reads mouse event
ncurses_getyx — Returns the current cursor position for a window
ncurses_halfdelay — Put terminal into halfdelay mode
ncurses_has_colors — Checks if terminal has color capabilities
ncurses_has_ic — Check for insert- and delete-capabilities
ncurses_has_il — Check for line insert- and delete-capabilities
ncurses_has_key — Check for presence of a function key on terminal keyboard
ncurses_hide_panel — Remove panel from the stack, making it invisible
ncurses_hline — Draw a horizontal line at current position using an attributed character and max. n characters long
ncurses_inch — Get character and attribute at current position
ncurses_init_color — Define a terminal color
ncurses_init_pair — Define a color pair
ncurses_init — Initialize ncurses
ncurses_insch — Insert character moving rest of line including character at current position
ncurses_insdelln — Insert lines before current line scrolling down (negative numbers delete and scroll up)
ncurses_insertln — Insert a line, move rest of screen down
ncurses_insstr — Insert string at current position, moving rest of line right
ncurses_instr — Reads string from terminal screen
ncurses_isendwin — Ncurses is in endwin mode, normal screen output may be performed
ncurses_keyok — Enable or disable a keycode
ncurses_keypad — Turns keypad on or off
ncurses_killchar — Returns current line kill character
ncurses_longname — Returns terminals description
ncurses_meta — Enables/Disable 8-bit meta key information
ncurses_mouse_trafo — Transforms coordinates
ncurses_mouseinterval — Set timeout for mouse button clicks
ncurses_mousemask — Sets mouse options
ncurses_move_panel — Moves a panel so that its upper-left corner is at [startx, starty]
ncurses_move — Move output position
ncurses_mvaddch — Move current position and add character
ncurses_mvaddchnstr — Move position and add attributed string with specified length
ncurses_mvaddchstr — Move position and add attributed string
ncurses_mvaddnstr — Move position and add string with specified length
ncurses_mvaddstr — Move position and add string
ncurses_mvcur — Move cursor immediately
ncurses_mvdelch — Move position and delete character, shift rest of line left
ncurses_mvgetch — Move position and get character at new position
ncurses_mvhline — Set new position and draw a horizontal line using an attributed character and max. n characters long
ncurses_mvinch — Move position and get attributed character at new position
ncurses_mvvline — Set new position and draw a vertical line using an attributed character and max. n characters long
ncurses_mvwaddstr — Add string at new position in window
ncurses_napms — Sleep
ncurses_new_panel — Create a new panel and associate it with window
ncurses_newpad — Creates a new pad (window)
ncurses_newwin — Create a new window
ncurses_nl — Translate newline and carriage return / line feed
ncurses_nocbreak — Switch terminal to cooked mode
ncurses_noecho — Switch off keyboard input echo
ncurses_nonl — Do not translate newline and carriage return / line feed
ncurses_noqiflush — Do not flush on signal characters
ncurses_noraw — Switch terminal out of raw mode
ncurses_pair_content — Retrieves foreground and background colors of a color pair
ncurses_panel_above — Returns the panel above panel
ncurses_panel_below — Returns the panel below panel
ncurses_panel_window — Returns the window associated with panel
ncurses_pnoutrefresh — Copies a region from a pad into the virtual screen
ncurses_prefresh — Copies a region from a pad into the virtual screen
ncurses_putp — Apply padding information to the string and output it
ncurses_qiflush — Flush on signal characters
ncurses_raw — Switch terminal into raw mode
ncurses_refresh — Refresh screen
ncurses_replace_panel — Replaces the window associated with panel
ncurses_reset_prog_mode — Resets the prog mode saved by def_prog_mode
ncurses_reset_shell_mode — Resets the shell mode saved by def_shell_mode
ncurses_resetty — Restores saved terminal state
ncurses_savetty — Saves terminal state
ncurses_scr_dump — Dump screen content to file
ncurses_scr_init — Initialize screen from file dump
ncurses_scr_restore — Restore screen from file dump
ncurses_scr_set — Inherit screen from file dump
ncurses_scrl — Scroll window content up or down without changing current position
ncurses_show_panel — Places an invisible panel on top of the stack, making it visible
ncurses_slk_attr — Returns current soft label key attribute
ncurses_slk_attroff — Turn off the given attributes for soft function-key labels
ncurses_slk_attron — Turn on the given attributes for soft function-key labels
ncurses_slk_attrset — Set given attributes for soft function-key labels
ncurses_slk_clear — Clears soft labels from screen
ncurses_slk_color — Sets color for soft label keys
ncurses_slk_init — Initializes soft label key functions
ncurses_slk_noutrefresh — Copies soft label keys to virtual screen
ncurses_slk_refresh — Copies soft label keys to screen
ncurses_slk_restore — Restores soft label keys
ncurses_slk_set — Sets function key labels
ncurses_slk_touch — Forces output when ncurses_slk_noutrefresh is performed
ncurses_standend — Stop using 'standout' attribute
ncurses_standout — Start using 'standout' attribute
ncurses_start_color — Initializes color functionality
ncurses_termattrs — Returns a logical OR of all attribute flags supported by terminal
ncurses_termname — Returns terminals (short)-name
ncurses_timeout — Set timeout for special key sequences
ncurses_top_panel — Moves a visible panel to the top of the stack
ncurses_typeahead — Specify different filedescriptor for typeahead checking
ncurses_ungetch — Put a character back into the input stream
ncurses_ungetmouse — Pushes mouse event to queue
ncurses_update_panels — Refreshes the virtual screen to reflect the relations between panels in the stack
ncurses_use_default_colors — Assign terminal default colors to color id -1
ncurses_use_env — Control use of environment information about terminal size
ncurses_use_extended_names — Control use of extended names in terminfo descriptions
ncurses_vidattr — Display the string on the terminal in the video attribute mode
ncurses_vline — Draw a vertical line at current position using an attributed character and max. n characters long
ncurses_waddch — Adds character at current position in a window and advance cursor
ncurses_waddstr — Outputs text at current postion in window
ncurses_wattroff — Turns off attributes for a window
ncurses_wattron — Turns on attributes for a window
ncurses_wattrset — Set the attributes for a window
ncurses_wborder — Draws a border around the window using attributed characters
ncurses_wclear — Clears window
ncurses_wcolor_set — Sets windows color pairings
ncurses_werase — Erase window contents
ncurses_wgetch — Reads a character from keyboard (window)
ncurses_whline — Draws a horizontal line in a window at current position using an attributed character and max. n characters long
ncurses_wmouse_trafo — Transforms window/stdscr coordinates
ncurses_wmove — Moves windows output position
ncurses_wnoutrefresh — Copies window to virtual screen
ncurses_wrefresh — Refresh window on terminal screen
ncurses_wstandend — End standout mode for a window
ncurses_wstandout — Enter standout mode for a window
ncurses_wvline — Draws a vertical line in a window at current position using an attributed character and max. n characters long