Skip to content
This repository
Browse code

Change readme markdown syntax to appease Github

  • Loading branch information...
commit 8cb89ff49ea1fb22fe59cd34e8dd12dd120ab626 1 parent 89d1ae2
Brian White authored

Showing 1 changed file with 40 additions and 40 deletions. Show diff stats Hide diff stats

  1. +40 40 README.md
80 README.md
Source Rendered
@@ -44,13 +44,13 @@ node-ncurses exposes only one class: **Window**.
44 44 Module Functions
45 45 ----------------
46 46
47   -* **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.
  47 +* **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.
48 48
49   -* **colorFg**(<_Integer_>colorPair) - _Integer_ - Returns the foreground color currently set for the given color pair number.
  49 +* **colorFg**(< _Integer_ >colorPair) - _Integer_ - Returns the foreground color currently set for the given color pair number.
50 50
51   -* **colorBg**(<_Integer_>colorPair) - _Integer_ - Returns the background color currently set for the given color pair number.
  51 +* **colorBg**(< _Integer_ >colorPair) - _Integer_ - Returns the background color currently set for the given color pair number.
52 52
53   -* **setEscDelay**(<_Integer_>delay) - _(void)_ - Sets the duration (in milliseconds) to wait after ESC is pressed.
  53 +* **setEscDelay**(< _Integer_ >delay) - _(void)_ - Sets the duration (in milliseconds) to wait after ESC is pressed.
54 54
55 55 * **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.
56 56
@@ -120,27 +120,27 @@ Module Properties
120 120 Window Events
121 121 -------------
122 122
123   -* **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.).
  123 +* **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.).
124 124
125 125
126 126 Window Functions
127 127 ----------------
128 128
129   -* **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.
  129 +* **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.
130 130
131   -* **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.
  131 +* **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.
132 132
133   -* **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.
  133 +* **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.
134 134
135   -* **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.
  135 +* **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.
136 136
137   -* **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.
  137 +* **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.
138 138
139   -* **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.
  139 +* **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.
140 140
141   -* **standout**(<_Boolean_>enable) - _Result_ - If enable is _true_, the standout _Attribute_ is enabled. Otherwise, it is disabled.
  141 +* **standout**(< _Boolean_ >enable) - _Result_ - If enable is _true_, the standout _Attribute_ is enabled. Otherwise, it is disabled.
142 142
143   -* **syncok**(<_Boolean_>autoSyncUp) - _Result_ - If autoSyncUp is _true_, **syncup**() is automatically called whenever there is a change in this window.
  143 +* **syncok**(< _Boolean_ >autoSyncUp) - _Result_ - If autoSyncUp is _true_, **syncup**() is automatically called whenever there is a change in this window.
144 144
145 145 * **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.
146 146
@@ -156,47 +156,47 @@ Window Functions
156 156
157 157 * **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**).
158 158
159   -* **move**(<_Integer_>row, <_Integer_>column) - _(void)_ - Moves the window to the given row and column.
  159 +* **move**(< _Integer_ >row, < _Integer_ >column) - _(void)_ - Moves the window to the given row and column.
160 160
161 161 * **refresh**() - _Result_ - Update the physical screen to match that of the virtual screen.
162 162
163   -* **frame**([<_String_>header[, <_String_>footer]]) - _(void)_ - Draws a frame around the window and calls **label**() with the optional arguments.
  163 +* **frame**([< _String_ >header[, < _String_ >footer]]) - _(void)_ - Draws a frame around the window and calls **label**() with the optional arguments.
164 164
165   -* **boldframe**([<_String_>header[, <_String_>footer]]) - _(void)_ - Same as **frame**(), except the frame is highlighted.
  165 +* **boldframe**([< _String_ >header[, < _String_ >footer]]) - _(void)_ - Same as **frame**(), except the frame is highlighted.
166 166
167   -* **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.
  167 +* **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.
168 168
169   -* **centertext**(<_Integer_>row, <_String_>text) - _(void)_ - Display a centered string at the given row.
  169 +* **centertext**(< _Integer_ >row, < _String_ >text) - _(void)_ - Display a centered string at the given row.
170 170
171   -* **cursor**(<_Integer_>row, <_Integer_>column) - _Result_ - Moves the cursor to the given row and column.
  171 +* **cursor**(< _Integer_ >row, < _Integer_ >column) - _Result_ - Moves the cursor to the given row and column.
172 172
173 173 * **insertln**() - _Result_ - Inserts an empty row above the current row.
174 174
175   -* **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.
  175 +* **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.
176 176
177   -* **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.
  177 +* **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.
178 178
179   -* **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.
  179 +* **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.
180 180
181   -* **attron**(<_Attributes_>attrs) - _Result_ - Switch on the specified window attributes.
  181 +* **attron**(< _Attributes_ >attrs) - _Result_ - Switch on the specified window attributes.
182 182
183   -* **attroff**(<_Attributes_>attrs) - _Result_ - Switch off the specified window attributes.
  183 +* **attroff**(< _Attributes_ >attrs) - _Result_ - Switch off the specified window attributes.
184 184
185   -* **attrset**(<_Attributes_>attrs) - _Result_ - Sets the window's attributes to be exactly that of the attributes specified.
  185 +* **attrset**(< _Attributes_ >attrs) - _Result_ - Sets the window's attributes to be exactly that of the attributes specified.
186 186
187 187 * **attrget**() - _Attributes_ - Get the window's current set of attributes.
188 188
189   -* **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).
  189 +* **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).
190 190
191   -* **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.
  191 +* **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.
192 192
193 193 * **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**).
194 194
195 195 * **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**).
196 196
197   -* **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**).
  197 +* **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**).
198 198
199   -* **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**).
  199 +* **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**).
200 200
201 201 * **erase**() - _Result_ - Copies blanks to every position in the window, clearing the screen.
202 202
@@ -208,33 +208,33 @@ Window Functions
208 208
209 209 * **delch**() - _Result_ - Deletes the character under the cursor.
210 210
211   -* **delch**(<_Integer_>row, <_Integer_>column) - _Result_ - Moves the cursor to the given row and column and then deletes the character under the cursor.
  211 +* **delch**(< _Integer_ >row, < _Integer_ >column) - _Result_ - Moves the cursor to the given row and column and then deletes the character under the cursor.
212 212
213 213 * **deleteln**() - _Result_ - Deletes the current row.
214 214
215   -* **scroll**([<_Integer_>nLines=1]) - _Result_ - Scrolls nLines lines. Positive values scroll up and negative values scroll down.
  215 +* **scroll**([< _Integer_ >nLines=1]) - _Result_ - Scrolls nLines lines. Positive values scroll up and negative values scroll down.
216 216
217   -* **setscrreg**(<_Integer_>startRow, <_Integer_>endRow) - _Result_ - Sets the scrolling region of a window bounded by startRow and endRow (both inclusive).
  217 +* **setscrreg**(< _Integer_ >startRow, < _Integer_ >endRow) - _Result_ - Sets the scrolling region of a window bounded by startRow and endRow (both inclusive).
218 218
219   -* **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.
  219 +* **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.
220 220
221   -* **is\_linetouched**(<_Integer_>row) - _Boolean_ - Indicates whether row has been marked as modified.
  221 +* **is\_linetouched**(< _Integer_ >row) - _Boolean_ - Indicates whether row has been marked as modified.
222 222
223   -* **redrawln**(<_Integer_>startRow, <_Integer_>nRows) - _Result_ - Redraws nRows rows starting at startRow.
  223 +* **redrawln**(< _Integer_ >startRow, < _Integer_ >nRows) - _Result_ - Redraws nRows rows starting at startRow.
224 224
225 225 * **touch**() - _Result_ - Marks the entire window as having been modified.
226 226
227 227 * **untouch**() - _Result_ - Marks the entire window as having been unmodified.
228 228
229   -* **resize**(<_Integer_>rows, <_Integer_>columns) - _Result_ - Resizes the window to have the given number of rows and columns.
  229 +* **resize**(< _Integer_ >rows, < _Integer_ >columns) - _Result_ - Resizes the window to have the given number of rows and columns.
230 230
231   -* **print**(<_String_>text) - _Result_ - Writes text at the current cursor position.
  231 +* **print**(< _String_ >text) - _Result_ - Writes text at the current cursor position.
232 232
233   -* **print**(<_Integer_>row, <_Integer_>column, <_String_>text) - _Result_ - Moves the cursor to the given row and column and writes text.
  233 +* **print**(< _Integer_ >row, < _Integer_ >column, < _String_ >text) - _Result_ - Moves the cursor to the given row and column and writes text.
234 234
235   -* **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.
  235 +* **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.
236 236
237   -* **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.
  237 +* **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.
238 238
239 239 * **close**() - _Result_ - Destroys the window and any of its children. **Only** call this **once** and when you are completely finished with the window.
240 240

0 comments on commit 8cb89ff

Please sign in to comment.
Something went wrong with that request. Please try again.