---

tffc.h File Reference

This is standard tffc headers. More...

#include <curses.h>
#include <panel.h>
#include "basetypes.h"
#include "error_tffc.h"
#include "input.h"
#include "inputw.h"
#include "labels.h"
#include "menurt.h"
#include "msgboxes.h"
#include "scroll.h"
#include "xmem.h"

Defines
#define	TFFC_VERSION   "0.9.1"
	This is TFFC Version number. More...
#define	WIN_WIDTH(win)   (win->_maxx)
	Return width size of window win. More...
#define	WIN_HEIGHT(win)   (win->_maxy)
	Return height size of window win. More...
#define	WIN_XPOS(win)   (win->_begx)
	Return where window win begin in ``X'' position on screen. More...
#define	WIN_YPOS(win)   (win->_begy)
	Return where window win begin in ``Y'' position on screen. More...
#define	ESC_KEY   27
	This is alias for ESC key. More...
#define	BACKSPACE_KEY   8
	This is alias for BackSpace key ('\b'). More...
#define	TAB_KEY   9
	This is alias for Tab key ('\t'). More...
#define	REDRAW_KEY   12
	This is alias for NoN key ('\f'). More...
#define	ENTER_KEY   13
	This is alias for Enter key ('\r'). More...
#define	RETURN   ENTER_KEY
#define	CTRL_F   6
	This is alias for 'Ctrl' + 'f' key. More...
#define	CTRL_P   16
	This is alias for 'Ctrl' + 'p' key. More...
#define	CTRL_T   20
	This is alias for 'Ctrl' + 't' key. More...
#define	CTRL_V   22
	This is alias for 'Ctrl' + 'v' key. More...
#define	CTRL_X   24
	This is alias for 'Ctrl' + 'x' key. More...
#define	CTRL_Y   25
	This is alias for 'Ctrl' + 'y' key. More...
#define	_TFFC_USE_LDAT_
	This is definition for using `ldat` struct in ``window_to_file'' routines. More...
#define	create_box_win(win, panel, lines, cols, y_pos, x_pos, box_color_pair, color_pair, use_centr)
#define	create_nobox_win(win, panel, lines, cols, y_pos, x_pos, box_color_pair, color_pair, use_centr)
#define	del_box_win(win, panel)   {del_panel (panel); delwin (win); }
Functions
void	draw_desktop (void)
	draw_desktop. More...
void	colorwin (WINDOW *win)
	colorwin. More...
void	coloreol (void)
	coloreol. More...
void	standardcolors (int color)
	standartcolors. More...
uchar	chtype_to_ascii (chtype ch_type)
void	window_to_file (WINDOW *win, char *file)
	window_to_file. More...
void	start_tffc (int col, int min_lines, int min_cols)
	start_tffc. More...
void	hide_tffc (void)
	hide_tffc. More...
void	unhide_tffc (int drawdesktop)
	unhide_tffc. More...
void	exit_tffc (void)
	exit_tffc. More...
int	doupdate_t (void)
	doupdate_t. More...
void	update_panels_t (void)
	update_panels_t. More...
int	wgetch_t (WINDOW *win)
	wgetch_t. More...
void	refresh_screen (void)
	refresh_screen. More...
void	stdwinset (WINDOW *win)
	stdwinset. More...
char *	string_va (const char *fmt,...)
	string_va. More...
void	about_tffc (void)
	about_tffc. More...
Variables
int	tffc_initialized
	This param has `TRUE` or `FALSE` if tffc (curses) run. More...
int	STDATTR
	Attribute variables. More...
int	HIGHATTR
	Yellow words on the dark Blue background. More...
int	BOXATTR
	Light Blue words on dark Blue background. More...
int	ACTIVEATTR
	Blue words on the dark blue background. More...
int	BARSTDATTR
	Light Green words on dark Blue background. More...
int	BARHIGHATTR
	Yellow words on the Black background. More...
int	DLGTEXTATTR
	Light Blue words on the Black background. More...
int	DLGBOXATTR
	Black words on the light Blue background. More...
int	DLGHIGHATTR
	Blue words on the cyan background. More...
int	DESCATTR
	Red words on the cyan background. More...
int	STATUSBARATTR
	Black words on the cyan background. More...
int	PTRATTR
	Yellow words on the dark blue background. More...
int	FIELDATTR
	Green words on the blue background. More...
int	ERRBOXATTR
	Blue words on the white background. More...
int	ERRTXTATTR
	White words on the red background. More...
int	ERRRESATTR
	Yellow words on the red background. More...
int	GROUPATTR
	Red words on the white background. More...
int	GETCHATTR
	White words on the cyan background. More...
int	INSATTR
	Black words on the white background. More...
int	SHADOWATTR
	Yellow words on the white background. More...
int	UNKNATTR
	Black ont the black background. More...

---

Detailed Description

This is standard tffc headers.

Author:

Igor Bujna

Date:

Pá èec 26 09:59:28 CEST 2002

Version:

0.9.1

---

Define Documentation

#define _TFFC_USE_LDAT_

This is definition for using `ldat` struct in ``window_to_file'' routines.

#define BACKSPACE_KEY   8

This is alias for BackSpace key ('\b').

#define create_box_win (  win, panel, lines, cols, y_pos, x_pos, box_color_pair, color_pair, use_centr    )

Value: {if(use_centr == TRUE) \ win = newwin (lines, cols, (LINES - (lines)) / (y_pos), (COLS - (cols))/ (x_pos)); \ else win = newwin (lines, cols, y_pos, x_pos); \ panel = new_panel (win); \ stdwinset (win); \ wtimeout (win, -1); \ wattrset (win, box_color_pair); \ colorwin (win); \ box (win, ACS_VLINE, ACS_HLINE); \ wattrset (win, color_pair); } Parameters: win  It's pointer to current window panel  It's pointer to current panel lines  It's number of lines cols  It's number of cols y_pos  Box start in current y position on screen x_pos  Box start in current x position on screen box_color_pair  It's color of pair for current box color_pair  It's color of pair for current box use_centr  TRUE or FALSE if curent box will be in centrum on the screen This definitions create box on screen in the current position.

#define create_nobox_win (  win, panel, lines, cols, y_pos, x_pos, box_color_pair, color_pair, use_centr    )

Value: {if(use_centr == TRUE) \ win = newwin (lines, cols, (LINES - (lines)) / (y_pos), (COLS - (cols))/ (x_pos)); \ else win = newwin (lines, cols, y_pos, x_pos); \ panel = new_panel (win); \ stdwinset (win); \ wtimeout (win, -1); \ wattrset (win, box_color_pair); \ colorwin (win); \ wattrset (win, color_pair); } Parameters: win  It's pointer to current window panel  It's pointer to current panel lines  It's number of lines cols  It's number of cols y_pos  Box start in current y position on screen x_pos  Box start in current x position on screen box_color_pair  It's color of pair for current box color_pair  It's color of pair for current box use_centr  TRUE or FALSE if curent box will be in centrum on the screen This definitions create box on screen in the current position.

#define CTRL_F   6

This is alias for 'Ctrl' + 'f' key.

#define CTRL_P   16

This is alias for 'Ctrl' + 'p' key.

#define CTRL_T   20

This is alias for 'Ctrl' + 't' key.

#define CTRL_V   22

This is alias for 'Ctrl' + 'v' key.

#define CTRL_X   24

This is alias for 'Ctrl' + 'x' key.

#define CTRL_Y   25

This is alias for 'Ctrl' + 'y' key.

#define del_box_win (  win, panel    )     {del_panel (panel); delwin (win); }

Parameters: win  Pointer for current window panel  Pointer for current panel This definitions del current panel and current window.

#define ENTER_KEY   13

This is alias for Enter key ('\r').

#define ESC_KEY   27

This is alias for ESC key.

#define REDRAW_KEY   12

This is alias for NoN key ('\f').

#define RETURN   ENTER_KEY

#define TAB_KEY   9

This is alias for Tab key ('\t').

#define TFFC_VERSION   "0.9.1"

This is TFFC Version number.

#define WIN_HEIGHT (  win    )     (win->_maxy)

Return height size of window win.

#define WIN_WIDTH (  win    )     (win->_maxx)

Return width size of window win.

#define WIN_XPOS (  win    )     (win->_begx)

Return where window win begin in ``X'' position on screen.

#define WIN_YPOS (  win    )     (win->_begy)

Return where window win begin in ``Y'' position on screen.

---

Function Documentation

void about_tffc (  void    )

about_tffc. Parameters: void  Returns: void This routines print about this functions (version, authors and etc).

uchar chtype_to_ascii (  chtype    ch_type )

void coloreol (  void    )

coloreol. Parameters: void  Returns: void Routines for clearing from cursor position to end of line.

void colorwin (  WINDOW *    win )

colorwin. Parameters: win  Pointer to current window Returns: void For some reason, the ncurses box routine does not color its inside. It would therefore be better to call this routine before drawing the box.

int doupdate_t (  void    )

doupdate_t. Parameters: void  Returns: int This routines is similar like doupdate. It's for using with clock_* func

void draw_desktop (  void    )

draw_desktop. Parameters: void  Returns: void Function draw the basic desktop common to my screen-oriented programs. It's redrawing screen from lines(y-position) 1 to (LINES - 2).

void exit_tffc (  void    )

exit_tffc. Parameters: void  Returns: void This routines must call last if you exit from program. This routines call erase, update_panels, doupdate, endwin routines.

void hide_tffc (  void    )

hide_tffc. Parameters: void  Returns: void This routines hide every windows etc.

void refresh_screen (  void    )

refresh_screen. Parameters: void  Returns: void It's for a new redrawing the basic screen.

void standardcolors (  int    color )

standartcolors. Parameters: color  TRUE or FALSE for use color terminal Returns: void Routines for standart pair of colors. Parameter ``color'' will determine whether color is important. If ``color'' is TRUE and you have color terminal, you will have coloring pair. After you can use is standart Attribute variables(colors set). You must call this routines after start_color().

void start_tffc (  int    col, int    min_lines, int    min_cols )

start_tffc. Parameters: col  min_lines  min_cols  Returns: void This routines must first call when initializing program. This routines test if everything ok with yours TERM setting. This routines start curses routines initscr. This routines test if yours terminal has least ``min_cols'' columns and ``min_lines'' lines. After this test if ``col'' is TRUE we can start coloring in yours terminal.

void stdwinset (  WINDOW *    win )

stdwinset. Parameters: win  Pointer to current window Returns: void This routines sets the standard window setting like keypad(TRUE), meta(TRUE), scollok(TRUE) and notimeout(FALSE) for window ``win''.

char* string_va (  const char *    fmt, ...    )

string_va. Parameters: fmt  Returns: char This routines i can used to format/create string from several parameters without using additional storage (output variable). In other words, ``string_va(fmt,....)'' equals to ``sprintf(str,...)'' without need of ``str'', because we ``str'' return.

void unhide_tffc (  int    drawdesktop )

unhide_tffc. Parameters: drawdesktop  TRUE or FALSE for first use draw_desktop func Returns: void This routines unhide back every windows etc. and redraw screen.

void update_panels_t (  void    )

update_panels_t. Parameters: void  Returns: void This routines is similar like update_panels. It's for using with clock_* func

int wgetch_t (  WINDOW *    win )

wgetch_t. Parameters: win  Pointer to current window Returns: int Return give character This routines is similar like wgetch. It's for using with clock_* func

void window_to_file (  WINDOW *    win, char *    file )

window_to_file. Parameters: win  Pointer to current window file  Name of output file Returns: void This routines put window ``win'' to text file ``file''.

---

Variable Documentation

int ACTIVEATTR

Blue words on the dark blue background.

int BARHIGHATTR

Yellow words on the Black background.

int BARSTDATTR

Light Green words on dark Blue background.

int BOXATTR

Light Blue words on dark Blue background.

int DESCATTR

Red words on the cyan background.

int DLGBOXATTR

Black words on the light Blue background.

int DLGHIGHATTR

Blue words on the cyan background.

int DLGTEXTATTR

Light Blue words on the Black background.

int ERRBOXATTR

Blue words on the white background.

int ERRRESATTR

Yellow words on the red background.

int ERRTXTATTR

White words on the red background.

int FIELDATTR

Green words on the blue background.

int GETCHATTR

White words on the cyan background.

int GROUPATTR

Red words on the white background.

int HIGHATTR

Yellow words on the dark Blue background.

int INSATTR

Black words on the white background.

int PTRATTR

Yellow words on the dark blue background.

int SHADOWATTR

Yellow words on the white background.

int STATUSBARATTR

Black words on the cyan background.

int STDATTR

Attribute variables. There are standart attribute variables - colors set.

int tffc_initialized

This param has `TRUE` or `FALSE` if tffc (curses) run.

int UNKNATTR

Black ont the black background.

---