PLCore::Loader Class Reference

Loader class. More...

#include <Loader.h>

List of all members.

Public Member Functions
const Class &	GetClass () const
	Loader implementation class.
PLCORE_API LoaderImpl *	GetImpl ()
	Returns the loader implementation.
LoadableType *	GetType () const
	Returns the loadable type.
PLCORE_API String	GetTypeName () const
	Returns the name of the loadable type.
uint32	GetNumOfFormats ()
	Returns the number of supported formats.
String	GetFormat (uint32 nIndex)
	Returns a supported format.
PLCORE_API bool	IsFormatSupported (const String &sExtension)
	Checks if a format is supported in a list of extensions.
PLCORE_API String	GetFormats () const
	Returns the formats string.
PLCORE_API String	GetDescription () const
	Returns the description string.
PLCORE_API bool	CanLoad () const
	Returns the whether loading is supported.
PLCORE_API bool	CanSave () const
	Returns the whether saving is supported.

---

Detailed Description

Loader class.

Note:

• Implementation of the proxy design pattern

---

Member Function Documentation

const Class & PLCore::Loader::GetClass

(

)

const [inline]

Loader implementation class.

Returns:

Loader implementation class

PLCORE_API LoaderImpl* PLCore::Loader::GetImpl

(

)

Returns the loader implementation.

Returns:

The loader implementation, a null pointer on error

Note:

• If required, this method creates an instance of the loader implementation class

LoadableType * PLCore::Loader::GetType

(

)

const [inline]

Returns the loadable type.

Returns:

The loadable type, a null pointer on (terrible) error

PLCORE_API String PLCore::Loader::GetTypeName

(

)

const

Returns the name of the loadable type.

Returns:

The name of the loadable type

uint32 PLCore::Loader::GetNumOfFormats

(

)

[inline]

Returns the number of supported formats.

Returns:

The number of supported formats

String PLCore::Loader::GetFormat

(

uint32

nIndex

)

[inline]

Returns a supported format.

Parameters:

[in]

nIndex

Format index

Returns:

The requested supported format, empty string on error

PLCORE_API bool PLCore::Loader::IsFormatSupported

(

const String &

sExtension

)

Checks if a format is supported in a list of extensions.

Parameters:

[in]

sExtension

Extension of loadable

Returns:

'true' if the format is supported, else 'false'

PLCORE_API String PLCore::Loader::GetFormats

(

)

const

Returns the formats string.

Returns:

The formats string

PLCORE_API String PLCore::Loader::GetDescription

(

)

const

Returns the description string.

Returns:

The description string

PLCORE_API bool PLCore::Loader::CanLoad

(

)

const

Returns the whether loading is supported.

Returns:

'true' if loading is supported, else 'false'

PLCORE_API bool PLCore::Loader::CanSave

(

)

const

Returns the whether saving is supported.

Returns:

'true' if saving is supported, else 'false'

---

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

• Loader.h
• Loader.inl