WARNING: USE THIS SOFTWARE AT YOUR OWN RISK! THIS IS EXPERIMENTAL SOFTWARE NOT INTENDED FOR PRODUCTION USE! Zuble is currently an early stage prototype. As such Zuble is minimally tested and inherently unstable. It is provided for experimental, development, and demonstration purposes only. Zuble QML Types   |  Zuble C++ Classes   |  Zuble Overview
Zuble  0.1
Zuble Framework C++/QML extension API
Public Member Functions | Protected Attributes | List of all members
Zbl::ZblResource Class Reference

Represents a binary resource file created by Qt's resource complier. More...

#include <ZblResource.h>

Public Member Functions

 ZblResource (const char *uri, int versionMajor, int versionMinor, const char *fileName)
 
virtual ~ZblResource ()
 
bool validate ()
 
const QString & uri () const
 returns the Resource file's uri More...
 
int versionMajor () const
 returns the Resource file's major version number More...
 
int versionMinor () const
 returns the Resource file's minor version number More...
 
const QString & fileName () const
 returns the Resource file's file name More...
 
bool isLoaded () const
 determines if the resource has already been loaded More...
 
bool load ()
 

Protected Attributes

QString m_uri
 Resource uri. More...
 
int m_versionMajor
 Resource major version number. More...
 
int m_versionMinor
 Resource minor version number. More...
 
QString m_fileName
 Resource file name. More...
 
bool m_loaded
 true if the resource has been loaded, false otherwise More...
 

Detailed Description

Represents a binary resource file created by Qt's resource complier.

Binary resource files can be mapped, which makes them known to Zuble, and then subsequently registered, which makes them known to QML documents.

Binary resources must be located on the Qt library path. The resource uri will form the root of the resource path in the resource tree.

Definition at line 45 of file ZblResource.h.

Constructor & Destructor Documentation

◆ ZblResource()

Zbl::ZblResource::ZblResource ( const char *  uri,
int  versionMajor,
int  versionMinor,
const char *  fileName 
)
explicit

Definition at line 35 of file ZblResource.cpp.

◆ ~ZblResource()

Zbl::ZblResource::~ZblResource ( )
virtual

Definition at line 50 of file ZblResource.cpp.

Member Function Documentation

◆ fileName()

const QString& Zbl::ZblResource::fileName ( ) const
inline

returns the Resource file's file name

Definition at line 82 of file ZblResource.h.

Referenced by Zbl::ZblCog::registerResource().

◆ isLoaded()

bool Zbl::ZblResource::isLoaded ( ) const
inline

determines if the resource has already been loaded

Returns

Definition at line 89 of file ZblResource.h.

◆ load()

bool Zbl::ZblResource::load ( )

Definition at line 73 of file ZblResource.cpp.

Referenced by isLoaded(), and Zbl::ZblCog::registerResource().

◆ uri()

const QString& Zbl::ZblResource::uri ( ) const
inline

returns the Resource file's uri

Definition at line 64 of file ZblResource.h.

◆ validate()

bool Zbl::ZblResource::validate ( )

Definition at line 55 of file ZblResource.cpp.

Referenced by Zbl::ZblCog::mapResource(), and Zbl::ZblCog::registerResource().

◆ versionMajor()

int Zbl::ZblResource::versionMajor ( ) const
inline

returns the Resource file's major version number

Definition at line 70 of file ZblResource.h.

◆ versionMinor()

int Zbl::ZblResource::versionMinor ( ) const
inline

returns the Resource file's minor version number

Definition at line 76 of file ZblResource.h.

Member Data Documentation

◆ m_fileName

QString Zbl::ZblResource::m_fileName
protected

Resource file name.

Definition at line 118 of file ZblResource.h.

Referenced by fileName(), load(), and validate().

◆ m_loaded

bool Zbl::ZblResource::m_loaded
protected

true if the resource has been loaded, false otherwise

Definition at line 123 of file ZblResource.h.

Referenced by isLoaded(), and load().

◆ m_uri

QString Zbl::ZblResource::m_uri
protected

Resource uri.

Definition at line 103 of file ZblResource.h.

Referenced by load(), and uri().

◆ m_versionMajor

int Zbl::ZblResource::m_versionMajor
protected

Resource major version number.

Definition at line 108 of file ZblResource.h.

Referenced by versionMajor().

◆ m_versionMinor

int Zbl::ZblResource::m_versionMinor
protected

Resource minor version number.

Definition at line 113 of file ZblResource.h.

Referenced by versionMinor().


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