Skip to content

Commit

Permalink
Change readme markdown syntax to appease Github
Browse files Browse the repository at this point in the history
  • Loading branch information
@mscdex
mscdex committed Nov 6, 2012
1 parent 89d1ae2 commit 8cb89ff
Showing 1 changed file with 40 additions and 40 deletions.
80 changes: 40 additions & 40 deletions README.md
View file
Expand Up @@ -44,13 +44,13 @@ node-ncurses exposes only one class: **Window**.
Module Functions Module Functions
---------------- ----------------


* **colorPair**(<_Integer_>colorPair, <_Integer_>fgColor, <_Integer_>bgColor) - _Integer_ - Sets the foreground and background colors for the given color pair number. The color pair number is always returned. * **colorPair**(< _Integer_ >colorPair, < _Integer_ >fgColor, < _Integer_ >bgColor) - _Integer_ - Sets the foreground and background colors for the given color pair number. The color pair number is always returned.


* **colorFg**(<_Integer_>colorPair) - _Integer_ - Returns the foreground color currently set for the given color pair number. * **colorFg**(< _Integer_ >colorPair) - _Integer_ - Returns the foreground color currently set for the given color pair number.


* **colorBg**(<_Integer_>colorPair) - _Integer_ - Returns the background color currently set for the given color pair number. * **colorBg**(< _Integer_ >colorPair) - _Integer_ - Returns the background color currently set for the given color pair number.


* **setEscDelay**(<_Integer_>delay) - _(void)_ - Sets the duration (in milliseconds) to wait after ESC is pressed. * **setEscDelay**(< _Integer_ >delay) - _(void)_ - Sets the duration (in milliseconds) to wait after ESC is pressed.


* **cleanup**() - _(void)_ - Restores the terminal after using ncurses. This function is automatically called when the last window is closed and thus should never be used except when handling unexpected exceptions (i.e. in node.js's uncaughtException event) so that you can safely restore the terminal back to normal. * **cleanup**() - _(void)_ - Restores the terminal after using ncurses. This function is automatically called when the last window is closed and thus should never be used except when handling unexpected exceptions (i.e. in node.js's uncaughtException event) so that you can safely restore the terminal back to normal.


Expand Down Expand Up @@ -120,27 +120,27 @@ Module Properties
Window Events Window Events
------------- -------------


* **inputChar**(<_String_>char, <_Integer_>charCode, <_Boolean_>isKey) - Emitted when a key has been pressed. isKey is true when a non-character key has been presssed (e.g. ESC, arrow key, Page Up, etc.). * **inputChar**(< _String_ >char, < _Integer_ >charCode, < _Boolean_ >isKey) - Emitted when a key has been pressed. isKey is true when a non-character key has been presssed (e.g. ESC, arrow key, Page Up, etc.).




Window Functions Window Functions
---------------- ----------------


* **clearok**(<_Boolean_>clearOnRefresh) - _Result_ - If redraw is _true_, the next call to **refresh**() will clear the screen completely and redraw the entire screen from scratch. * **clearok**(< _Boolean_ >clearOnRefresh) - _Result_ - If redraw is _true_, the next call to **refresh**() will clear the screen completely and redraw the entire screen from scratch.


* **scrollok**(<_Boolean_>scroll) - _Result_ - Controls what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last row. If scroll is _true_, the window is scrolled up one line (**Note:** that in order to get the physical scrolling effect on the terminal, it is also necessary to call **idlok**()), otherwise the cursor is left at the bottom line. * **scrollok**(< _Boolean_ >scroll) - _Result_ - Controls what happens when the cursor of a window is moved off the edge of the window or scrolling region, either as a result of a newline action on the bottom line, or typing the last character of the last row. If scroll is _true_, the window is scrolled up one line (**Note:** that in order to get the physical scrolling effect on the terminal, it is also necessary to call **idlok**()), otherwise the cursor is left at the bottom line.


* **idlok**(<_Boolean_>useInsDelLine) - _Result_ - If useInsDelTerm is _true_, ncurses considers using the hardware insert/delete **line** feature of the terminal (if available). Otherwise if useInsDelTerm is _false_, hardware line insertion and deletion is disabled. This option should be enabled only if the application needs insert/delete line, for example, for a screen editor. It is disabled by default because insert/delete line tends to be visually annoying when used in applications where it isn't really needed. If insert/delete line cannot be used, ncurses redraws the changed portions of all lines. * **idlok**(< _Boolean_ >useInsDelLine) - _Result_ - If useInsDelTerm is _true_, ncurses considers using the hardware insert/delete **line** feature of the terminal (if available). Otherwise if useInsDelTerm is _false_, hardware line insertion and deletion is disabled. This option should be enabled only if the application needs insert/delete line, for example, for a screen editor. It is disabled by default because insert/delete line tends to be visually annoying when used in applications where it isn't really needed. If insert/delete line cannot be used, ncurses redraws the changed portions of all lines.


* **idcok**(<_Boolean_>useInsDelChar) - _Result_ - If useInsDelChar is _true_, ncurses considers using the hardware insert/delete **character** feature of the terminal (if available). Otherwise if useInsDelChar is _false_, ncurses no longer considers using the hardware insert/delete character feature of the terminal. Use of character insert/delete is enabled by default. * **idcok**(< _Boolean_ >useInsDelChar) - _Result_ - If useInsDelChar is _true_, ncurses considers using the hardware insert/delete **character** feature of the terminal (if available). Otherwise if useInsDelChar is _false_, ncurses no longer considers using the hardware insert/delete character feature of the terminal. Use of character insert/delete is enabled by default.


* **leaveok**(<_Boolean_>moveCursor) - _Result_ - Normally, the hardware cursor is left at the location of the window cursor being refreshed. If moveCursor is _true_, ncurses will allow the cursor to be left wherever an update happens to leave it. **It is useful for applications where the cursor is not used, since it reduces the need for cursor motions.** If possible, the cursor is made invisible when this function is called. * **leaveok**(< _Boolean_ >moveCursor) - _Result_ - Normally, the hardware cursor is left at the location of the window cursor being refreshed. If moveCursor is _true_, ncurses will allow the cursor to be left wherever an update happens to leave it. **It is useful for applications where the cursor is not used, since it reduces the need for cursor motions.** If possible, the cursor is made invisible when this function is called.


* **immedok**(<_Boolean_>immedUpdate) - _Result_ - If immedUpdate is _true_, any change in the virtual window, such as the ones caused by **addch**(), **clrtobot**(), **scroll**(), etc., automatically cause a call to **refresh**(). However, it may degrade performance considerably, due to repeated calls to **refresh**(). It is disabled by default. * **immedok**(< _Boolean_ >immedUpdate) - _Result_ - If immedUpdate is _true_, any change in the virtual window, such as the ones caused by **addch**(), **clrtobot**(), **scroll**(), etc., automatically cause a call to **refresh**(). However, it may degrade performance considerably, due to repeated calls to **refresh**(). It is disabled by default.


* **standout**(<_Boolean_>enable) - _Result_ - If enable is _true_, the standout _Attribute_ is enabled. Otherwise, it is disabled. * **standout**(< _Boolean_ >enable) - _Result_ - If enable is _true_, the standout _Attribute_ is enabled. Otherwise, it is disabled.


* **syncok**(<_Boolean_>autoSyncUp) - _Result_ - If autoSyncUp is _true_, **syncup**() is automatically called whenever there is a change in this window. * **syncok**(< _Boolean_ >autoSyncUp) - _Result_ - If autoSyncUp is _true_, **syncup**() is automatically called whenever there is a change in this window.


* **syncdown**() - _Result_ - Touches each location in the window that has been touched in any of its ancestor windows. This function is called by **refresh**(), so it should almost never be necessary to call it manually. * **syncdown**() - _Result_ - Touches each location in the window that has been touched in any of its ancestor windows. This function is called by **refresh**(), so it should almost never be necessary to call it manually.


Expand All @@ -156,47 +156,47 @@ Window Functions


* **bottom**() - _(void)_ - Send the window to the back (**stdscr** is always the bottom-most window, so this function will actually make the window the bottom-most window right above **stdscr**). * **bottom**() - _(void)_ - Send the window to the back (**stdscr** is always the bottom-most window, so this function will actually make the window the bottom-most window right above **stdscr**).


* **move**(<_Integer_>row, <_Integer_>column) - _(void)_ - Moves the window to the given row and column. * **move**(< _Integer_ >row, < _Integer_ >column) - _(void)_ - Moves the window to the given row and column.


* **refresh**() - _Result_ - Update the physical screen to match that of the virtual screen. * **refresh**() - _Result_ - Update the physical screen to match that of the virtual screen.


* **frame**([<_String_>header[, <_String_>footer]]) - _(void)_ - Draws a frame around the window and calls **label**() with the optional arguments. * **frame**([< _String_ >header[, < _String_ >footer]]) - _(void)_ - Draws a frame around the window and calls **label**() with the optional arguments.


* **boldframe**([<_String_>header[, <_String_>footer]]) - _(void)_ - Same as **frame**(), except the frame is highlighted. * **boldframe**([< _String_ >header[, < _String_ >footer]]) - _(void)_ - Same as **frame**(), except the frame is highlighted.


* **label**([<_String_>header[, <_String_>footer]]) - _(void)_ - Displays an optional centered header at the top and an optional centered footer at the bottom of the window. * **label**([< _String_ >header[, < _String_ >footer]]) - _(void)_ - Displays an optional centered header at the top and an optional centered footer at the bottom of the window.


* **centertext**(<_Integer_>row, <_String_>text) - _(void)_ - Display a centered string at the given row. * **centertext**(< _Integer_ >row, < _String_ >text) - _(void)_ - Display a centered string at the given row.


* **cursor**(<_Integer_>row, <_Integer_>column) - _Result_ - Moves the cursor to the given row and column. * **cursor**(< _Integer_ >row, < _Integer_ >column) - _Result_ - Moves the cursor to the given row and column.


* **insertln**() - _Result_ - Inserts an empty row above the current row. * **insertln**() - _Result_ - Inserts an empty row above the current row.


* **insdelln**([<_Integer_>nRows=1]) - _Result_ - If nRows > 0, then nRows rows will be inserted above the current row. If nRows < 0, then nRows rows are deleted, beginning with the current row. * **insdelln**([< _Integer_ >nRows=1]) - _Result_ - If nRows > 0, then nRows rows will be inserted above the current row. If nRows < 0, then nRows rows are deleted, beginning with the current row.


* **insstr**(<_String_>text[, <_Integer_>charLimit=-1]) - _Result_ - Insert the string into the window before the current cursor position. Insert stops at the end of the string or when charLimit has been reached. If charLimit < 0, it is ignored. * **insstr**(< _String_ >text[, < _Integer_ >charLimit=-1]) - _Result_ - Insert the string into the window before the current cursor position. Insert stops at the end of the string or when charLimit has been reached. If charLimit < 0, it is ignored.


* **insstr**(<_Integer_>row, <_Integer_>column, <_String_>text[, <_Integer_>charLimit=-1]) - _Result_ - Moves the cursor to the given row and column, then calls the above version of **insstr**() with the rest of the arguments. * **insstr**(< _Integer_ >row, < _Integer_ >column, < _String_ >text[, < _Integer_ >charLimit=-1]) - _Result_ - Moves the cursor to the given row and column, then calls the above version of **insstr**() with the rest of the arguments.


* **attron**(<_Attributes_>attrs) - _Result_ - Switch on the specified window attributes. * **attron**(< _Attributes_ >attrs) - _Result_ - Switch on the specified window attributes.


* **attroff**(<_Attributes_>attrs) - _Result_ - Switch off the specified window attributes. * **attroff**(< _Attributes_ >attrs) - _Result_ - Switch off the specified window attributes.


* **attrset**(<_Attributes_>attrs) - _Result_ - Sets the window's attributes to be exactly that of the attributes specified. * **attrset**(< _Attributes_ >attrs) - _Result_ - Sets the window's attributes to be exactly that of the attributes specified.


* **attrget**() - _Attributes_ - Get the window's current set of attributes. * **attrget**() - _Attributes_ - Get the window's current set of attributes.


* **chgat**(<_Integer_>nChars, <_Attributes_>attrs[, <_Integer_>colorPair]) - _Result_ - Changes the attributes of the next nChars characters starting at the current cursor position to have the given attributes. colorPair specifies a color to use (defaults to the Window's current color pair). * **chgat**(< _Integer_ >nChars, < _Attributes_ >attrs[, < _Integer_ >colorPair]) - _Result_ - Changes the attributes of the next nChars characters starting at the current cursor position to have the given attributes. colorPair specifies a color to use (defaults to the Window's current color pair).


* **chgat**(<_Integer_>row, <_Integer_>column, <_Integer_>nChars, <_Attributes_>attrs[, <_Integer_>colorPair]) - _Result_ - Same as the above, except the given row and column are used as the start position. * **chgat**(< _Integer_ >row, < _Integer_ >column, < _Integer_ >nChars, < _Attributes_ >attrs[, < _Integer_ >colorPair]) - _Result_ - Same as the above, except the given row and column are used as the start position.


* **box**([<_ACS\_Character_>vertChar=0[, <_ACS\_Character_>horizChar=0]]) - _Result_ - Draws a box around the window using the optional vertical and horizontal characters. If a zero is given for any of the arguments, ncurses will use the POSIX default characters instead (See **Additional notes**). * **box**([<_ACS\_Character_>vertChar=0[, <_ACS\_Character_>horizChar=0]]) - _Result_ - Draws a box around the window using the optional vertical and horizontal characters. If a zero is given for any of the arguments, ncurses will use the POSIX default characters instead (See **Additional notes**).


* **border**([<_ACS\_Character_>leftChar=0[, <_ACS\_Character_>rightChar=0[, <_ACS\_Character_>topChar=0[, <_ACS\_Character_>bottomChar=0[, <_ACS\_Character_>topLeftChar=0[, <_ACS\_Character_>topRightChar=0[, <_ACS\_Character_>bottomLeftChar=0[, <_ACS\_Character_>bottomRightChar=0]]]]]]]]) - _Result_ - Draws a border around the window using the optionally specified left, right, top, bottom, top left, top right, bottom left, bottom right characters. If any of the characters are zero, ncurses will use the POSIX default characters instead (See **Additional notes**). * **border**([<_ACS\_Character_>leftChar=0[, <_ACS\_Character_>rightChar=0[, <_ACS\_Character_>topChar=0[, <_ACS\_Character_>bottomChar=0[, <_ACS\_Character_>topLeftChar=0[, <_ACS\_Character_>topRightChar=0[, <_ACS\_Character_>bottomLeftChar=0[, <_ACS\_Character_>bottomRightChar=0]]]]]]]]) - _Result_ - Draws a border around the window using the optionally specified left, right, top, bottom, top left, top right, bottom left, bottom right characters. If any of the characters are zero, ncurses will use the POSIX default characters instead (See **Additional notes**).


* **hline**(<_Integer_>length[, <_ACS\_Character_>lineChar=0]) - _Result_ - Draws a horizontal line on the current row with the given length. lineChar specifies the character to be used when drawing the line. If lineChar is zero, ncurses will use the POSIX default characters instead (See **Additional notes**). * **hline**(< _Integer_ >length[, <_ACS\_Character_>lineChar=0]) - _Result_ - Draws a horizontal line on the current row with the given length. lineChar specifies the character to be used when drawing the line. If lineChar is zero, ncurses will use the POSIX default characters instead (See **Additional notes**).


* **vline**(<_Integer_>length[, <_ACS\_Character_>lineChar=0]) - _Result_ - Draws a vertical line on the current column with the given length. lineChar specifies the character to be used when drawing the line. If lineChar is zero, ncurses will use the POSIX default characters instead (See **Additional notes**). * **vline**(< _Integer_ >length[, <_ACS\_Character_>lineChar=0]) - _Result_ - Draws a vertical line on the current column with the given length. lineChar specifies the character to be used when drawing the line. If lineChar is zero, ncurses will use the POSIX default characters instead (See **Additional notes**).


* **erase**() - _Result_ - Copies blanks to every position in the window, clearing the screen. * **erase**() - _Result_ - Copies blanks to every position in the window, clearing the screen.


Expand All @@ -208,33 +208,33 @@ Window Functions


* **delch**() - _Result_ - Deletes the character under the cursor. * **delch**() - _Result_ - Deletes the character under the cursor.


* **delch**(<_Integer_>row, <_Integer_>column) - _Result_ - Moves the cursor to the given row and column and then deletes the character under the cursor. * **delch**(< _Integer_ >row, < _Integer_ >column) - _Result_ - Moves the cursor to the given row and column and then deletes the character under the cursor.


* **deleteln**() - _Result_ - Deletes the current row. * **deleteln**() - _Result_ - Deletes the current row.


* **scroll**([<_Integer_>nLines=1]) - _Result_ - Scrolls nLines lines. Positive values scroll up and negative values scroll down. * **scroll**([< _Integer_ >nLines=1]) - _Result_ - Scrolls nLines lines. Positive values scroll up and negative values scroll down.


* **setscrreg**(<_Integer_>startRow, <_Integer_>endRow) - _Result_ - Sets the scrolling region of a window bounded by startRow and endRow (both inclusive). * **setscrreg**(< _Integer_ >startRow, < _Integer_ >endRow) - _Result_ - Sets the scrolling region of a window bounded by startRow and endRow (both inclusive).


* **touchlines**(<_Integer_>startRow, <_Integer_>nRows[, <_Boolean_>markModified=true]) - _Result_ - Marks nRows rows starting at startRow as having been modified if markModified is true or unmodified otherwise. * **touchlines**(< _Integer_ >startRow, < _Integer_ >nRows[, < _Boolean_ >markModified=true]) - _Result_ - Marks nRows rows starting at startRow as having been modified if markModified is true or unmodified otherwise.


* **is\_linetouched**(<_Integer_>row) - _Boolean_ - Indicates whether row has been marked as modified. * **is\_linetouched**(< _Integer_ >row) - _Boolean_ - Indicates whether row has been marked as modified.


* **redrawln**(<_Integer_>startRow, <_Integer_>nRows) - _Result_ - Redraws nRows rows starting at startRow. * **redrawln**(< _Integer_ >startRow, < _Integer_ >nRows) - _Result_ - Redraws nRows rows starting at startRow.


* **touch**() - _Result_ - Marks the entire window as having been modified. * **touch**() - _Result_ - Marks the entire window as having been modified.


* **untouch**() - _Result_ - Marks the entire window as having been unmodified. * **untouch**() - _Result_ - Marks the entire window as having been unmodified.


* **resize**(<_Integer_>rows, <_Integer_>columns) - _Result_ - Resizes the window to have the given number of rows and columns. * **resize**(< _Integer_ >rows, < _Integer_ >columns) - _Result_ - Resizes the window to have the given number of rows and columns.


* **print**(<_String_>text) - _Result_ - Writes text at the current cursor position. * **print**(< _String_ >text) - _Result_ - Writes text at the current cursor position.


* **print**(<_Integer_>row, <_Integer_>column, <_String_>text) - _Result_ - Moves the cursor to the given row and column and writes text. * **print**(< _Integer_ >row, < _Integer_ >column, < _String_ >text) - _Result_ - Moves the cursor to the given row and column and writes text.


* **addstr**(<_String_>text[, <_Integer_>charLimit=-1]) - _Result_ - Writes the specified string at the current cursor position. Writing stops at the end of the string or when charLimit has been reached. If charLimit < 0, it is ignored. * **addstr**(< _String_ >text[, < _Integer_ >charLimit=-1]) - _Result_ - Writes the specified string at the current cursor position. Writing stops at the end of the string or when charLimit has been reached. If charLimit < 0, it is ignored.


* **addstr**(<_Integer_>row, <_Integer_>column, <_String_>text[, <_Integer_>charLimit=-1]) - _Result_ - Moves the cursor to the given row and column and calls the version of **addstr**() above with the rest of the arguments. * **addstr**(< _Integer_ >row, < _Integer_ >column, < _String_ >text[, < _Integer_ >charLimit=-1]) - _Result_ - Moves the cursor to the given row and column and calls the version of **addstr**() above with the rest of the arguments.


* **close**() - _Result_ - Destroys the window and any of its children. **Only** call this **once** and when you are completely finished with the window. * **close**() - _Result_ - Destroys the window and any of its children. **Only** call this **once** and when you are completely finished with the window.


Expand Down

0 comments on commit 8cb89ff

Please sign in to comment.