Module aprint [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

main
int aprint::main(int argc,char **argv)

cls (version 1)
void aprint::cls()

cls (version 2)
void aprint::cls(int n)

cll (version 1)
void aprint::cll()

cll (version 2)
void aprint::cll(int n)

locate
void aprint::locate(int row,int col)

save
void aprint::save()

restore
void aprint::restore()

hide
void aprint::hide()

show
void aprint::show()

moveUp
void aprint::moveUp(int n)

moveDown
void aprint::moveDown(int n)

moveRight
void aprint::moveRight(int n)

moveLeft
void aprint::moveLeft(int n)

font
void aprint::font(int n)

reset
void aprint::reset()

bold
void aprint::bold()

faint
void aprint::faint()

normal
void aprint::normal()

blink
void aprint::blink()

inv
void aprint::inv()

color (version 1)
void aprint::color(int c)

color (version 2)
void aprint::color(unsigned char r,unsigned char g,unsigned char b)

bgcolor (version 1)
void aprint::bgcolor(int c)

bgcolor (version 2)
void aprint::bgcolor(unsigned char r,unsigned char g,unsigned char b)

colorHigh
void aprint::colorHigh(int c)

bgcolorHigh
void aprint::bgcolorHigh(int c)

rotate
void aprint::rotate()

loadstat
void aprint::loadstat(float state,int size)

command (version 1)
void aprint::command(char c)

command (version 2)
void aprint::command(int n,char c)

command (version 3)
void aprint::command(int n,int m,char c)

Motivation

Static Methods

main

Runs aprint as if it would be called from the command-line.

See Commandline-Interface.

Signature:

int aprint::main(int argc,char **argv)

Parameters:

Type	Name	Direction	Description
int	argc		The number of command-line parameters.
char **	argv	[IN]	The command-line parameters.

Return value:
Exit status.

cls (version 1)

Clears the screen.

Signature:

void aprint::cls()

Code: toggle

void aprint::cls()
{
    cls(2);
}

cls (version 2)

Clears the screen.

Signature:

void aprint::cls(int n)

Parameters:

Type	Name	Direction	Description
int	n		Parameter.

Code: toggle

void aprint::cls(int n)
{
    command(n,'J');
}

cll (version 1)

Clears the screen.

Signature:

void aprint::cll()

Code: toggle

void aprint::cll()
{
    cll(2);
}

cll (version 2)

Clears the screen.

Signature:

void aprint::cll(int n)

Parameters:

Type	Name	Direction	Description
int	n		Parameter.

Code: toggle

void aprint::cll(int n)
{
    command(n,'K');
}

locate

Places the cursor at line row and column col.

Signature:

void aprint::locate(int row,int col)

Parameters:

Type	Name	Direction	Description
int	row		Number of the line.
int	col		Number of the column.

Code: toggle

void aprint::locate(int row,int col)
{
    command(row,col,'H');
}

save

Stores the current position of the cursor.

Signature:

void aprint::save()

Code: toggle

void aprint::save()
{
    command('s');
}

restore

Restores the position of the cursor to the last stored position.

Signature:

void aprint::restore()

Code: toggle

void aprint::restore()
{
    command('u');
}

hide

Hides the cursor.

Signature:

void aprint::hide()

Code: toggle

void aprint::hide()
{
    printf("%c[?25l",27);
}

show

Shows the cursor (makes the cursor visible).

Signature:

void aprint::show()

Code: toggle

void aprint::show()
{
    printf("%c[?25h",27);
}

moveUp

Moves the cursor.

Signature:

void aprint::moveUp(int n)

Parameters:

Type	Name	Direction	Description
int	n		Distance

Code: toggle

void aprint::moveUp(int n)
{
    command(n,'A');
}

moveDown

Moves the cursor.

Signature:

void aprint::moveDown(int n)

Parameters:

Type	Name	Direction	Description
int	n		Distance

Code: toggle

void aprint::moveDown(int n)
{
    command(n,'B');
}

moveRight

Moves the cursor.

Signature:

void aprint::moveRight(int n)

Parameters:

Type	Name	Direction	Description
int	n		Distance

Code: toggle

void aprint::moveRight(int n)
{
    command(n,'C');
}

moveLeft

Moves the cursor.

Signature:

void aprint::moveLeft(int n)

Parameters:

Type	Name	Direction	Description
int	n		Distance

Code: toggle

void aprint::moveLeft(int n)
{
    command(n,'D');
}

font

Selects a font.

Signature:

void aprint::font(int n)

Parameters:

Type	Name	Direction	Description
int	n		Number of the font.

Code: toggle

void aprint::font(int n)
{
    command(n,'m');
}

reset

Resets the font.

Signature:

void aprint::reset()

Code: toggle

void aprint::reset()
{
    command(0,'m');
}

bold

Bold font.

Signature:

void aprint::bold()

Code: toggle

void aprint::bold()
{
    command(1,'m');
}

faint

Faint font.

Signature:

void aprint::faint()

Code: toggle

void aprint::faint()
{
    command(2,'m');
}

normal

Normal font.

Signature:

void aprint::normal()

Code: toggle

void aprint::normal()
{
    command(22,'m');
}

blink

Blinking font.

Signature:

void aprint::blink()

Code: toggle

void aprint::blink()
{
    command(5,'m');
}

inv

Font with inverted colors.

Signature:

void aprint::inv()

Code: toggle

void aprint::inv()
{
    command(7,'m');
}

color (version 1)

Sets the foreground color.

Signature:

void aprint::color(int c)

Parameters:

Type	Name	Direction	Description
int	c		Color index.

Code: toggle

void aprint::color(int c)
{
    command(30+c,'m');
}

color (version 2)

Sets the foreground color.

Signature:

void aprint::color(unsigned char r,unsigned char g,unsigned char b)

Parameters:

Type	Name	Direction	Description
unsigned char	r		red.
unsigned char	g		green.
unsigned char	b		blue.

Code: toggle

void aprint::color(unsigned char r,unsigned char g,unsigned char b)
{
    printf("%c[%d;2;%d;%d;%dm",27,38,r,g,b);
}

bgcolor (version 1)

Sets the background color.

Signature:

void aprint::bgcolor(int c)

Parameters:

Type	Name	Direction	Description
int	c		Color index.

Code: toggle

void aprint::bgcolor(int c)
{
    command(40+c,'m');
}

bgcolor (version 2)

Sets the background color.

Signature:

void aprint::bgcolor(unsigned char r,unsigned char g,unsigned char b)

Parameters:

Type	Name	Direction	Description
unsigned char	r		red.
unsigned char	g		green.
unsigned char	b		blue.

Code: toggle

void aprint::bgcolor(unsigned char r,unsigned char g,unsigned char b)
{
    printf("%c[%d;2;%d;%d;%dm",27,48,r,g,b);
}

colorHigh

Sets the foreground color.

Signature:

void aprint::colorHigh(int c)

Parameters:

Type	Name	Direction	Description
int	c		Color index.

Code: toggle

void aprint::colorHigh(int c)
{
    command(90+c,'m');
}

bgcolorHigh

Sets the background color.

Signature:

void aprint::bgcolorHigh(int c)

Parameters:

Type	Name	Direction	Description
int	c		Color index.

Code: toggle

void aprint::bgcolorHigh(int c)
{
    command(100+c,'m');
}

rotate

Prints a simple animation.

Signature:

void aprint::rotate()

Code: toggle

void aprint::rotate()
{
    char ch[5]="-/|\\";
    static int p=0;
    ++p%=4;
    printf("%c",ch[p]);
    command(1,'D');
    fflush(stdout);
}

loadstat

Prints a progress bar.

Signature:

void aprint::loadstat(float state,int size)

Parameters:

Type	Name	Direction	Description
float	state		Progress state, a value between 0.0 and 1.0.
int	size		The size of the progress bar in characters.

Code: toggle

void aprint::loadstat(float state,int size)
{
    int pos=size*state;
    for(int i=0;i');
        else printf("%c",'-');
    }
    command(size,'D');
    fflush(stdout);
}

command (version 1)

Prints a command.

Signature:

void aprint::command(char c)

Parameters:

Type	Name	Direction	Description
char	c		Command.

Code: toggle

void aprint::command(char c)
{
    printf("%c[%c",27,c);
}

command (version 2)

Prints a command.

Signature:

void aprint::command(int n,char c)

Parameters:

Type	Name	Direction	Description
int	n		Parameter.
char	c		Command.

Code: toggle

void aprint::command(int n,char c)
{
    printf("%c[%d%c",27,n,c);
}

command (version 3)

Prints a command.

Signature:

void aprint::command(int n,int m,char c)

Parameters:

Type	Name	Direction	Description
int	n		Parameter.
int	m		Parameter.
char	c		Command.

Code: toggle

void aprint::command(int n,int m,char c)
{
    printf("%c[%d;%d%c",27,n,m,c);
}