Dokumentace prostoru jmen ResourceHandlerFunctions

Funkce pro resource handlery. ...

Funkce
bool	locateFile (QString &filename)
	Najit soubor podle jmena.
bool	locateFileInDir (const QDir &dir, QString &filename, int depth=0)
	Najit soubor v adresari a podadresarich.
bool	loadXml (const QString &name, QDomElement &rootEl, bool checkAttrName, const QString &rootElTagName="")
	Nacist xml soubor podle jmena.
bool	saveXml (const QString &filename, const QDomDocument &doc)
	Ulozit xml dokument.
QString	attrNameValueFromName (const QString &name)
	Prevest obecne jmeno na hodnotu predpokladanou v atributu name.
QString	filenameFromName (const QString &name)
	Prevest obecne jmeno na jmeno souboru.
bool	getSubElement (const QDomElement &el, QDomElement &subEl, const QString &subElTagName, bool successIfMissing=false)
	Najit podelement podle jmena.
bool	getStringAttr (const QDomElement &el, QString &attr, const QString &attrName, bool successIfMissing=false)
	Precist stringovou hodnotu atributu.
bool	getIntAttr (const QDomElement &el, int &attr, const QString &attrName, bool successIfMissing=false)
	Precist integer hodnotu atributu.
bool	getAttrsXY (const QDomElement &el, int &x, int &y)
	Precist hodnotu atributu x,y.
void	showError (const QString &message)
	Zobrazit chybu.
void	showError (const QString &message, const QString &filename, const QDomElement &el=QDomElement())
	Zobrazit chybu, ktera se vyskytla v souboru filename.
void	showError (const QString &message, const QDomElement &el, const QString &filename="")
	Zobrazit chybu, ktera se vyskytla v elementu el.
QString	nodePath (const QDomNode &el, const QString &delimiter=" > ")
	Zkostruovat cestu v xml souboru k elementu el.
QString	tr (const char *sourceText, const char *comment=0, int n=-1)
	Prelozit.

---

Detailní popis

Funkce pro resource handlery.

 * Nekolik funkci zamerenych na zpracovani XML, souboru na disku a hlaseni chyb. Mezi hlavni casti patri:

• hledani souboru
• parsovani xml
• ukladani xml
• hlaseni chyb

---

Dokumentace funkcí

QString ResourceHandlerFunctions::attrNameValueFromName

(

const QString &

name

)

Prevest obecne jmeno na hodnotu predpokladanou v atributu name.

Obecne jmeno muze byt jmeno objektu, souboru, nebo cela cesta. Pokud obsahuje name priponu xml souboru nebo cestu, tyto kusy se odstrani.

Parametry:

name

jmeno objektu, souboru, nebo cela cesta

Návratová hodnota:

Predpokladane jmeno objektu.

Tuto funkci volají...

QString ResourceHandlerFunctions::filenameFromName

(

const QString &

name

)

Prevest obecne jmeno na jmeno souboru.

Obecne jmeno muze byt jmeno objektu, souboru, nebo cela cesta. V prvnim pripade se k name prida pripona xml souboru, jinak vraci name.

Parametry:

name

jmeno objektu, souboru, nebo cela cesta

Návratová hodnota:

Predpokladane jmeno souboru.

Tuto funkci volají...

bool ResourceHandlerFunctions::getAttrsXY	(	const QDomElement &	el,
		int &	x,
		int &	y
	)

Precist hodnotu atributu x,y.

Ziska integer hodnoty atributu x,y. Atributy nesmi chybet.

Parametry:

	el	element, jehoz atributy nas zajimaji
[out]	x	hodnota atributu x
[out]	y	hodnota atributu y

Návratová hodnota:

Uspech operace.

Viz také:

getIntAttr()

Tato funkce volá...

Tuto funkci volají...

bool ResourceHandlerFunctions::getIntAttr	(	const QDomElement &	el,
		int &	attr,
		const QString &	attrName,
		bool	successIfMissing
	)

Precist integer hodnotu atributu.

Pokusi se ziskat hodnotu atributu attrName elementu el a prevest ji na integer. Pokud nastane chyba, sam zobrazuje relevantni informace.

Parametry:

	el	element, o jehoz atribut mame zajem
[out]	attr	hodnota atributu
	attrName	jmeno atributu, ktery hledame
	successIfMissing	jestli ma uspet pokud atribut uplne chybi

Návratová hodnota:

Uspech operace.

Vracené hodnoty:

	true	hodnota atributu nactena (nebo chybi a successIfMissing je true)
	false	hodnota atributu nelze interpretovat jako int (nebo chybi a successIfMissing je false)

Tato funkce volá...

Tuto funkci volají...

bool ResourceHandlerFunctions::getStringAttr	(	const QDomElement &	el,
		QString &	attr,
		const QString &	attrName,
		bool	successIfMissing
	)

Precist stringovou hodnotu atributu.

Pokusi se ziskat hodnotu atributu attrName elementu el. Pokud nastane chyba, sam zobrazuje relevantni informace.

Parametry:

	el	element, o jehoz atribut mame zajem
[out]	attr	hodnota atributu
	attrName	jmeno atributu, ktery hledame
	successIfMissing	jestli ma uspet pokud atribut uplne chybi

Návratová hodnota:

Uspech operace.

Vracené hodnoty:

	true	hodnota atributu nactena (nebo chybi a successIfMissing je true )
	false	chybi a successIfMissing je false

Tato funkce volá...

Tuto funkci volají...

bool ResourceHandlerFunctions::getSubElement	(	const QDomElement &	el,
		QDomElement &	subEl,
		const QString &	subElTagName,
		bool	successIfMissing
	)

Najit podelement podle jmena.

Pokusi se ziskat podelement elementu el. Pokud element neexistuje, sam zobrazuje relevantni informace. Pokud subelement chybi, subEl je nastaven jako nulovy (isNull()).

Parametry:

	el	element, o jehoz podelement mame zajem
[out]	subEl	nalezeny (ci nulovy) podelement
	subElTagName	jmeno podelementu, ktery hledame
	successIfMissing	jestli ma uspet pokud element uplne chybi

Návratová hodnota:

Uspech operace.

Vracené hodnoty:

	true	podelement nalezen a vracen v subEl
	false	podelement chybi

Tato funkce volá...

bool ResourceHandlerFunctions::loadXml	(	const QString &	name,
		QDomElement &	rootEl,
		bool	checkAttrName,
		const QString &	rootElTagName
	)

Nacist xml soubor podle jmena.

Pokusi se najit a otevrit xml soubor. Provadi kontroly:

• hodnota atributu name v korenovem elementu
• jmeno korenoveho elementu Pokud nastane chyba, sam zobrazuje relevantni informace.

  Parametry:

  	name	jmeno objektu, souboru, nebo cela cesta
  [out]	rootEl	korenovy element nove otevreneho xml dokumentu
  	checkAttrName	zda se ma kontrolovat hodnota atributu name podle name (viz attrNameValueFromName())
  	rootElTagName	predpokladane jmeno korenoveho elementu

  Návratová hodnota:

  Uspech operace.

  Vracené hodnoty:

  	true	dokument nacten (korenovy element ulozen v rootEl)
  	false	dokument nenacten

Tato funkce volá...

Tuto funkci volají...

bool ResourceHandlerFunctions::locateFile

(

QString &

filename

)

Najit soubor podle jmena.

Pokusi se najit zadany soubor v domovskem adresari, v adresarich uvedenych v SEARCH_PATHS a vsech podadresarich az do hloubky SEARCH_DEPTH. Preskakuje skryte adresare. Pokud nastane chyba, sam zobrazuje relevantni informace.

Parametry:

[in,out]

filename

jmeno souboru nebo uplna cesta

Návratová hodnota:

Uspech operace.

Vracené hodnoty:

	true	Soubor nalezen (cesta ulozena v filename)
	false	Soubor nenalezen.

Tato funkce volá...

Tuto funkci volají...

bool ResourceHandlerFunctions::locateFileInDir	(	const QDir &	dir,
		QString &	filename,
		int	depth
	)

Najit soubor v adresari a podadresarich.

Pokusi se najit zadany soubor v adresari dir a vsech podadresarich az do hloubky SEARCH_DEPTH. Preskakuje skryte adresare.

Parametry:

	dir	soubor, ktery se ma prohledat
[in,out]	filename	jmeno souboru
	depth	dosazena hloubka

Návratová hodnota:

Uspech operace.

Vracené hodnoty:

	true	Soubor nalezen (cesta ulozena v filename)
	false	Soubor nenalezen.

Tuto funkci volají...

QString ResourceHandlerFunctions::nodePath	(	const QDomNode &	node,
		const QString &	delimiter
	)

Zkostruovat cestu v xml souboru k elementu el.

Zkonstruuje (textove) cestu k xml uzlu node. Cesta uzlu jsou jmena nadrazenych elementu az ke koreni xml stromu.

Parametry:

	node	uzel jehoz cesta nas zajima
	delimiter	oddelovac jednotlivych elementu cesty

Návratová hodnota:

Zkonstruovana cesta uzlu.

Tuto funkci volají...

bool ResourceHandlerFunctions::saveXml	(	const QString &	filename,
		const QDomDocument &	doc
	)

Ulozit xml dokument.

Pokusi se otevrit a vyprazdnit soubor filename. Pote do nej vypise xml dokument doc. Pokud nastane chyba, sam zobrazuje relevantni informace.

Parametry:

	filename	cesta k souboru
	doc	xml dokument, ktery ma byt ulozen

Návratová hodnota:

Uspech operace.

Vracené hodnoty:

	true	dokument ulozen
	false	dokument nelze ulozit

Tato funkce volá...

Tuto funkci volají...

void ResourceHandlerFunctions::showError	(	const QString &	message,
		const QDomElement &	el,
		const QString &	filename
	)

Zobrazit chybu, ktera se vyskytla v elementu el.

Zobrazi chybove hlaseni korespondujici s urcitym xml elementem el. Vypisuje cestu k elementu.

Parametry:

	message	textovy popis chyby
	el	xml element, ve kterem chyba nastala
	filename	pripadne jmeno souboru, ve kterem chyba nastala

Viz také:

nodePath()

Tato funkce volá...

Tuto funkci volají...

void ResourceHandlerFunctions::showError	(	const QString &	message,
		const QString &	filename,
		const QDomElement &	el
	)

Zobrazit chybu, ktera se vyskytla v souboru filename.

Zobrazi chybove hlaseni korespondujici s urcitym souborem filename.

Parametry:

	message	textovy popis chyby
	filename	jmeno souboru, ve kterem se chyba vyskytla
	el	pripadne xml element, ve kterem chyba nastala

Tato funkce volá...

void ResourceHandlerFunctions::showError

(

const QString &

message

)

Zobrazit chybu.

Zobrazi dialogove okno se zpravou message.

Parametry:

message

textovy popis chyby

Viz také:

QMessageBox::critical()

Tato funkce volá...

Tuto funkci volají...

QString ResourceHandlerFunctions::tr	(	const char *	sourceText,
		const char *	comment = 0,
		int	n = -1
	)			[inline]

Prelozit.

Viz také:

QObject::tr()