Utils Namespace Reference

Namespace for all various functions that don't belong to any class. More...

Namespaces
namespace	FS
	Namespace for general filesystem functions for cross-platform compatability.
Functions
void	flush_events ()
	Flush GUI events that may still be pending in the main loop.
void	calculate_center (int width, int height, int &x, int &y)
	Calculate center of screen coordinates for a window.
Glib::ustring	io_error_to_str (const IO::Code &code)
	Map an I/O error code into a string error message.
Glib::ustring	exception_string (const Glib::ustring &reason, const Glib::ustring &file, int line)
	Format an exception string for a file and line.
Glib::ustring	to_string (int val)
	Convert an int to string.
Glib::ustring	extract_block_id (const Glib::ustring str)
	Extract a text block's ID from a full string.
Glib::ustring	extract_block_description (const Glib::ustring &str)
	Extract a text block's description from a full string.

---

Detailed Description

Namespace for all various functions that don't belong to any class.

---

Function Documentation

void Utils::calculate_center	(	int	width,
		int	height,
		int &	x,
		int &	y
	)

Calculate center of screen coordinates for a window.

Parameters:

	width	The width of the window
	height	The height of the window
	x	The calculated x-coordinate
	y	The calculated y-coordinate

Glib::ustring Utils::exception_string	(	const Glib::ustring &	reason,
		const Glib::ustring &	file,
		int	line
	)

Format an exception string for a file and line.

Parameters:

	reason	The exception's reason for being raised
	file	The file where this exception originated from
	line	The line where this exception occurred

Returns:

The formatted string to display

Glib::ustring Utils::extract_block_description

(

const Glib::ustring &

str

)

Extract a text block's description from a full string.

Parameters:

str

The full string

Returns:

The extracted description

Glib::ustring Utils::extract_block_id

(

const Glib::ustring

str

)

Extract a text block's ID from a full string.

Parameters:

str

The full string

Returns:

The extracted ID

Glib::ustring Utils::io_error_to_str

(

const IO::Code &

code

)

Map an I/O error code into a string error message.

Parameters:

code

the IO::Code to translate

Returns:

The string error message

Glib::ustring Utils::to_string

(

int

val

)

Convert an int to string.

Parameters:

val

The int value

Returns:

String containing the value

---