UIDocument Class Reference

#include <UIDocument.h>

Inheritance diagram for UIDocument:

Public Member Functions
	DECLARE_ASSET (UIDocument, Asset)
	UIDocument ()
virtual	~UIDocument ()
virtual void	Create () override
virtual void	LoadStream (Stream &stream, Platform platform) override
virtual void	SaveStream (Stream &stream, Platform platform) override
virtual bool	Import (const std::string &path, ImportOptions *options) override
virtual void	GatherProperties (std::vector< Property > &outProps) override
virtual glm::vec4	GetTypeColor () override
virtual const char *	GetTypeName () override
virtual const char *	GetTypeImportExt () override
void	SetXmlSource (const std::string &xml)
Widget *	Instantiate ()
void	Mount (Widget *parent)
void	Unmount ()
Widget *	FindById (const std::string &id) const
std::vector< Widget * >	FindByClass (const std::string &className) const
Widget *	GetRootWidget () const
void	SetData (const std::string &key, const std::string &value)
const std::string &	GetData (const std::string &key) const
void	SetCallback (const std::string &elementId, const std::string &eventName, const std::string &funcName)
void	SetCallbackRef (const std::string &elementId, const std::string &eventName, int luaRef)
void	Tick ()
const std::string &	GetXmlSource () const
const std::string &	GetBasePath () const
void	SetBasePath (const std::string &basePath)
const std::string &	GetSourceFilePath () const
void	SetSourceFilePath (const std::string &path)
Public Member Functions inherited from Asset
	DECLARE_FACTORY_MANAGER (Asset)
	DECLARE_FACTORY (Asset, Asset)
	DECLARE_OBJECT (Asset, Object)
	Asset ()
virtual	~Asset ()
virtual void	Destroy ()
virtual void	Copy (Asset *srcAsset)
const std::string &	GetName () const
bool	IsLoaded () const
bool	IsRefCounted () const
int32_t	GetRefCount () const
bool	IsEmbedded () const
void	SetEmbedded (bool embed)
bool	IsEngineAsset () const
void	SetEngineAsset (bool engineAsset)
void	SetName (const std::string &name)
void	IncrementRefCount ()
void	DecrementRefCount ()
void	LoadFile (const char *path, AsyncLoadRequest *request=nullptr)
void	LoadEmbedded (const EmbeddedFile *embeddedAsset, AsyncLoadRequest *request=nullptr)
void	SaveFile (const char *path, Platform platform)
virtual bool	ShouldSnapshotForPie () const
bool	IsTransient () const
void	SetTransient (bool transient)
uint64_t	GetUuid () const
void	SetUuid (uint64_t uuid)
void	EnsureUuid ()
void	WriteHeader (Stream &stream)
Public Member Functions inherited from Object
virtual	~Object ()=default
virtual const char *	RuntimeName () const =0
virtual const char *	RuntimeParentName () const =0
virtual RuntimeId	InstanceRuntimeId () const =0
virtual Object *	QueryInterface (RuntimeId id) const
virtual bool	Is (RuntimeId id) const
virtual bool	Is (const char *name) const
virtual bool	DrawCustomProperty (Property &prop)
template<typename T >
T *	As () const
virtual bool	Equals (const Object *rhs) const

Additional Inherited Members
Static Public Member Functions inherited from Asset
static AssetHeader	ReadHeader (Stream &stream)
static std::string	GetNameFromPath (const std::string &path)
static std::string	GetDirectoryFromPath (const std::string &path)
static const char *	GetNameFromTypeId (TypeId id)
static TypeId	GetTypeIdFromName (const char *name)
Static Public Member Functions inherited from Object
static const char *	ClassRuntimeName ()
Protected Attributes inherited from Asset
uint32_t	mVersion = 0
TypeId	mType = INVALID_TYPE_ID
uint64_t	mUuid = 0
bool	mEmbedded = false
bool	mLoaded = false
bool	mEnableRefCount = true
bool	mEngineAsset = false
bool	mTransient = false
std::string	mName = "Asset"
int32_t	mRefCount = 0

Constructor & Destructor Documentation

UIDocument()

UIDocument::UIDocument

(

)

~UIDocument()

UIDocument::~UIDocument ( )

virtual

Member Function Documentation

Create()

void UIDocument::Create ( )

overridevirtual

Reimplemented from Asset.

DECLARE_ASSET()

UIDocument::DECLARE_ASSET	(	UIDocument	,
		Asset
	)

FindByClass()

std::vector< Widget * > UIDocument::FindByClass

(

const std::string &

className

)

const

FindById()

Widget * UIDocument::FindById

(

const std::string &

id

)

const

GatherProperties()

void UIDocument::GatherProperties ( std::vector< Property > &  outProps )

overridevirtual

Reimplemented from Asset.

GetBasePath()

const std::string & UIDocument::GetBasePath ( ) const

inline

GetData()

const std::string & UIDocument::GetData

(

const std::string &

key

)

const

GetRootWidget()

Widget * UIDocument::GetRootWidget

(

)

const

GetSourceFilePath()

const std::string & UIDocument::GetSourceFilePath ( ) const

inline

GetTypeColor()

glm::vec4 UIDocument::GetTypeColor ( )

overridevirtual

Reimplemented from Asset.

GetTypeImportExt()

const char * UIDocument::GetTypeImportExt ( )

overridevirtual

Reimplemented from Asset.

GetTypeName()

const char * UIDocument::GetTypeName ( )

overridevirtual

Reimplemented from Asset.

GetXmlSource()

const std::string & UIDocument::GetXmlSource ( ) const

inline

Import()

bool UIDocument::Import ( const std::string &  path, ImportOptions *  options  )

overridevirtual

Reimplemented from Asset.

Instantiate()

Widget * UIDocument::Instantiate

(

)

LoadStream()

void UIDocument::LoadStream ( Stream &  stream, Platform  platform  )

overridevirtual

Reimplemented from Asset.

Mount()

void UIDocument::Mount

(

Widget *

parent

)

SaveStream()

void UIDocument::SaveStream ( Stream &  stream, Platform  platform  )

overridevirtual

Reimplemented from Asset.

SetBasePath()

void UIDocument::SetBasePath ( const std::string &  basePath )

inline

SetCallback()

void UIDocument::SetCallback	(	const std::string &	elementId,
		const std::string &	eventName,
		const std::string &	funcName
	)

SetCallbackRef()

void UIDocument::SetCallbackRef	(	const std::string &	elementId,
		const std::string &	eventName,
		int	luaRef
	)

SetData()

void UIDocument::SetData	(	const std::string &	key,
		const std::string &	value
	)

SetSourceFilePath()

void UIDocument::SetSourceFilePath ( const std::string &  path )

inline

SetXmlSource()

void UIDocument::SetXmlSource ( const std::string &  xml )

inline

Tick()

void UIDocument::Tick

(

)

Unmount()

void UIDocument::Unmount

(

)

---

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

• Engine/Source/Engine/UI/UIDocument.h
• Engine/Source/Engine/UI/UIDocument.cpp