Project

General

Profile

Scol standard library package  0.3.1
Common and usefull functions for all Scol applications
console.pkg File Reference

Easy Console API. More...

Classes

struct  CONSOLE
 Internal structure. You should not call it directly, use API instead ! More...

Typedefs

typedef struct mkCONSOLE CONSOLE

Functions

 console_addFromFile (csl)
 console_CBload (objload, csl, p)
 console_CBmenu (a, tuple)
 console_CBpopup (objtext, tuple, str)
 console_CBsave (objsave, csl, w)
 console_clear (csl)
 Clear a console.
 console_click (win, csl, x, y, btn)
 console_create (chn, x, y, w, h, flag)
 Initialize the console and create the graphical user interface.
 console_crMenu (csl)
 console_crPopup (csl, title, flag)
 console_destroy (csl)
 Destroy a console.
 console_destroy2 (a, csl)
 console_getContent (csl)
 Return the content of a console.
 console_getLineNum (csl)
 console_getLineNum_old ()
 console_getMessageNumber (csl)
 Return the total message number.
 console_goToLine (csl, line)
 console_gotoline (csl, line)
 Scroll the graphical interface to a line.
 console_paint (o, csl)
 console_print (csl, msg)
 Add (print) a message in the given console.
 console_printtxt (csl)
 Try to print (on the default printer) the content of a console This function should NOT be used !
 console_resize (win, csl, w, h)
 console_save (csl, w)
 Save the content of a console in a file. If the file will be overwritten, if any.
 console_save2 (csl)
 console_setTitle (csl, title)
 Change the title of a console.

Variables

var CONSOLE_HIDE_LINENUM = 0
proto console_printtxt = fun [CONSOLE] I
proto console_save = fun [CONSOLE W] I
var CONSOLE_SHOW_LINENUM = 1
typeof csl_last = CONSOLE
var csl_linecount = 0

Detailed Description

Easy Console API.

Author
Scol team
Version
0.2

This API provides an high level method to easily include a console.

Create and manage a simple text window (console) to display any message. Several Console can be used in a same application.

For the application users, a contextual menu is available by right clicking in the bottom of the graphical user interface (below the text field).