GCF::ContentLoadEvent Class Reference

Contains parameters that describe a content-load event

#include <GCF3/Component>

.

Public Member Functions
bool	isPreContentLoad () const
bool	isPostContentLoad () const
void	setContentFile (const QString &fileName)
QString	contentFile () const

Member Function Documentation

bool GCF::ContentLoadEvent::isPreContentLoad

(

)

const

Returns

true if this class describes a pre-content load event, false otherwise.

See Also

GCF::Component::contentLoadEvent()

bool GCF::ContentLoadEvent::isPostContentLoad

(

)

const

Returns

true if this class describes a post-content load event, false otherwise.

See Also

GCF::Component::contentLoadEvent()

void GCF::ContentLoadEvent::setContentFile

(

const QString &

fileName

)

Use this function to set the content file for loading.

Parameters

fileName

name of the content file to load.

Note

the fileName is either absolute or relative to the location of the executable. If no name is passed then the content file is assumed to be a XML file in component's name (GCF::Component::name()) stored in the content directory (GCF::contentDirectory())

This function should only be used if isPreContentLoad() returns true.

See Also

GCF::Component::contentLoadEvent()

QString GCF::ContentLoadEvent::contentFile

(

)

const

Returns

When isPreContentLoad() returns true, the function returns name of the content file set via the setContentFile() method. When isPostContentLoad() returns true, the function returns name of the content file that was actually used to load the content.

See Also

GCF::Component::contentLoadEvent()