CVocatraInfo Class Reference

Vocatra Information class This class provides information and help methods about Vocatra. More...

#include <vocatrainfo.H>

List of all members.

Static Public Member Functions
static void	PrintUsage (const bool &bPrintHelp=true)
	Print Usage function.
static void	PrintHelp ()
	Print Help function.
static void	PrintVersion ()
	Print Version function.
static const char *	GetName ()
	Get Name function.
static const char *	GetOrderMode ()
	Get Order Mode function.
static const char *	GetRandomMode ()
	Get Random Mode function.
static const char *	GetAlphabeticalMode ()
	Get Alphabetical Mode function This function returns the string from the alphabetical mode.
static const char *	GetLeftLang ()
	Get Left Language function.
static const char *	GetRightLang ()
	Get Right Language function.
Static Private Member Functions
static std::string	breakString (const std::string &str, const bool &bIndent=false)
	Static helper function.

---

Detailed Description

Vocatra Information class This class provides information and help methods about Vocatra.

---

Member Function Documentation

std::string CVocatraInfo::breakString	(	const std::string &	str,
		const bool &	bIndent = false
	)			[static, private]

Static helper function.

This function breaks a string into lines with the length of <= 70 characters.

Parameters:

	str	this string will be broken into lines
	bIndent	If true, indent new lines with 49 spaces. (needed to create man page)

Returns:

string with added
characters and optinal indentation.

Referenced by PrintHelp().

const char * CVocatraInfo::GetAlphabeticalMode

(

)

[static]

Get Alphabetical Mode function This function returns the string from the alphabetical mode.

Default: alphabetical

Referenced by CVocOptions::Parse().

const char * CVocatraInfo::GetLeftLang

(

)

[static]

Get Left Language function.

This function returns the string from the left language. Default: left

Referenced by CVocOptions::Parse().

const char * CVocatraInfo::GetName

(

)

[static]

Get Name function.

This function returns the package name. Default: vocatra

Referenced by CVocFile::AppendVocabulary(), CVocTrainer::Init(), CVocOptions::Parse(), CVocAdmin::printBits(), PrintHelp(), PrintUsage(), and PrintVersion().

const char * CVocatraInfo::GetOrderMode

(

)

[static]

Get Order Mode function.

This function returns the string from the order mode. Default: order

Referenced by CVocOptions::Parse().

const char * CVocatraInfo::GetRandomMode

(

)

[static]

Get Random Mode function.

This function returns the string from the random mode. Default: random

Referenced by CVocOptions::Parse().

const char * CVocatraInfo::GetRightLang

(

)

[static]

Get Right Language function.

This function returns the string from the right language. Default: right

Referenced by CVocOptions::Parse().

void CVocatraInfo::PrintHelp

(

)

[static]

Print Help function.

This function prints the help to the stdout.

References breakString(), GetName(), and PrintUsage().

Referenced by CVocOptions::Parse().

void CVocatraInfo::PrintUsage

(

const bool &

bPrintHelp = true

)

[static]

Print Usage function.

This function prints the usage string to the stdout.

Parameters:

bPrintHelp

prints "try vocatra --help ..."-string if true

References GetName().

Referenced by CVocOptions::Parse(), and PrintHelp().

void CVocatraInfo::PrintVersion

(

)

[static]

Print Version function.

This function prints the version number to the stdout.

References GetName().

Referenced by CVocOptions::Parse().

---

The documentation for this class was generated from the following files:

• vocatrainfo.H
• vocatrainfo.cpp