README in ncursesw-1.4.3 vs README in ncursesw-1.4.4

- old
+ new

@@ -3,10 +3,12 @@ This directory contains a ruby module for accessing the FSF's ncurses library. (C) 2002, 2003, 2004 Tobias Peters <t-peters@users.berlios.de> (C) 2004 Simon Kaczor <skaczor@cox.net> (C) 2005 2006 Tobias Herzke <t-peters@users.berlios.de> +(C) 2013 2014 Gaute Hope <eg@gaute.vetsj.com> +(C) 2013 2014 Sup developers This module is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. @@ -35,11 +37,11 @@ global variables and constants of the ncurses library. These are mapped to a Ruby Module named "Ncurses": Functions and external variables are implemented as singleton functions of the Module Ncurses. -This README is organized into the following parts: +This README is organized into the following parts: - Overview - Installation and Usage - External Variables - Constants - Functions (and their Interfaces) @@ -98,11 +100,11 @@ One of these external variables, ESCDELAY, is also settable with a ruby method (Ncurses.ESCDELAY=). Another external variable, Ncurses.RESIZEDELAY is introduced by this wrapper. -It contains the maximum milliseconds delay with which terminal resizesings are +It contains the maximum milliseconds delay with which terminal resizesings are recognized. Constants ========= (static C Preprocessor macros) @@ -141,11 +143,11 @@ "by reference"; but arrays are passed by reference, so that you can see the changes to them. Attention: some macro-only functions like getsyx accept variables of type int, but, being macros, they write values to their arguments. Thus, they also need empty array arguments when called from ruby. -Example: +Example: color_pair_number = 4 foreground_color = [] background_color = [] if (Ncurses.pair_content(color_pair_number, foreground_color, background_color) != Ncurses::ERR) @@ -202,11 +204,11 @@ module Ncurses class WINDOW; end class SCREEN; end class MEVENT; end - module Panel + module Panel class PANEL; end end module Form class FORM; end class FIELD; end @@ -265,11 +267,11 @@ ================ The form library was wrapped inside the Ncurses:Form module. All form functions are implemented as module functions on the module Ncurses::Form. In addition, all function for which the first -parameter is one of the objects are also implemented as an instance +parameter is one of the objects are also implemented as an instance method of the respective class. For example, instead of calling post_form(form), you can use form.post_form(). Three objects are defined in the Ncurses:Form module: 1. FORM @@ -297,11 +299,11 @@ ================ The menu library was wrapped inside the Ncurses:Menu module. All menu functions are implemented as module functions in the module Ncurses::Menu. In addition, all functions for which the first -parameter is one of the objects are also implemented as an instance +parameter is one of the objects are also implemented as an instance method of the respective class. For example, instead of calling post_menu(menu), you can use menu.post_menu(). Two objects are defined in the Ncurses:Menu module: 1. MENU @@ -328,10 +330,10 @@ The C library function setlocale is not technically an Ncurses function. However, it is used by many ncurses programs, and for this purpose, a wrapper for this function is also included in ncurses-ruby. The function is implemented as a module function Ncurses.ruby, and -expects two arguments, an Integer and a String. It returns a string. +expects two arguments, an Integer and a String. It returns a string. The constants that can be used as the Integer argument are also wrapped as constants in the Ncurses module. See the manual page for setlocale for documentation of this function. Ncurses and Ruby Threads