GammaRay::Util Namespace Reference

GammaRay utilities. More...

Functions
QString	addressToString (const void *p)
bool	descendantOf (const QObject *ascendant, const QObject *object)
QString	displayString (const QObject *object)
void	drawTransparencyPattern (QPainter *painter, const QRect &rect, int squareSize=8)
QString	enumToString (const QVariant &value, const char *typeName=0, QObject *object=0)
template<typename T >
T *	findParentOfType (QObject *object)
QVariant	iconForObject (QObject *object)

Detailed Description

GammaRay utilities.

Function Documentation

QString GammaRay::Util::addressToString

(

const void *

p)

Returns a string version (as a hex number starting with "0x") of the memory address p.

Parameters

p	is a pointer to an address in memory.

Returns

a QString containing the human readable address string.

bool GammaRay::Util::descendantOf	(	const QObject *	ascendant,
		const QObject *	object
	)

Determines if the QObject obj is a descendant of the QObject ascendant.

Parameters

ascendant	is a pointer to a QObject.
object	is a pointer to a QObject.

Returns

true if obj is a descendant of ascendant; false otherwise.

QString GammaRay::Util::displayString

(

const QObject *

object)

Returns a human readable string name of the specified QObject.

Parameters

object

is a pointer to a valid QObject.

Returns

a QString containing the human readable display string.

void GammaRay::Util::drawTransparencyPattern	(	QPainter *	painter,
		const QRect &	rect,
		int	squareSize = 8
	)

Draws a transparency pattern, i.e. the common checkerboard pattern into rect.

size The size of the individual checkerboard squares.

QString GammaRay::Util::enumToString	(	const QVariant &	value,
		const char *	typeName = 0,
		QObject *	object = 0
	)

Translates an enum or flag value into a human readable text.

Parameters

value	The numerical value. Type information from the QVariant are used to find the corresponding QMetaEnum.
typeName	Use this if the value has type int (e.g. the case for QMetaProperty::read).
object	Additional QObject to search for QMetaEnums.

Returns

a QString containing the string version of the specified value.

template<typename T >

T* GammaRay::Util::findParentOfType

(

QObject *

object)

Finds the parent QObject of the specified type T, if such exists.

Parameters

object

is a pointer to a QObject.

Returns

zero on failure; else a pointer to a data type T.

QVariant GammaRay::Util::iconForObject

(

QObject *

object)

Returns an icon for the given object. In normal operation a QIcon is returned containing the icon most closely associated with the data type pointed to by object

Parameters

object

is a pointer to a QObject.

Returns

on failure QVariant() is returned; else a QIcon