HOM_AssetGalleryDataSource Class Reference

#include <HOM_AssetGalleryDataSource.h>

Public Member Functions
	HOM_AssetGalleryDataSource (const char *source_identifier, const char *args=nullptr)
virtual	~HOM_AssetGalleryDataSource ()
int	__hash__ ()
std::string	__repr__ () const
bool	isValid () const
bool	isReadOnly () const
std::string	sourceIdentifier () const
std::string	sourceArgs () const
std::string	infoHtml () const
void	startTransaction () const
void	endTransaction (bool commit=true) const
std::vector< std::string >	itemIds () const
std::vector< std::string >	updatedItemIds ()
std::vector< std::string >	childItemIds (const char *parent)
std::string	sourceTypeName (const char *item_id=nullptr) const
std::string	typeName (const char *item_id) const
std::string	label (const char *item_id) const
HOM_BinaryString	thumbnail (const char *item_id) const
int64	creationDate (const char *item_id) const
int64	modificationDate (const char *item_id) const
bool	isStarred (const char *item_id) const
std::string	colorTag (const char *item_id) const
std::vector< std::string >	tags (const char *item_id) const
	SWIGOUT (%ignore opaqueMetadata)
UT_Options	opaqueMetadata (const char *item_id) const
std::string	filePath (const char *item_id) const
bool	ownsFile (const char *item_id) const
HOM_BinaryString	blindData (const char *item_id) const
std::string	status (const char *item_id) const
std::string	parentId (const char *item_id) const
std::string	prepareItemForUse (const char *item_id) const
bool	setLabel (const char *item_id, const char *label)
bool	setThumbnail (const char *item_id, HOM_BinaryString thumbnail)
bool	setModificationDate (const char *item_id, int64 timestamp)
bool	setIsStarred (const char *item_id, bool isstarred)
bool	setColorTag (const char *item_id, const char *color_tag)
bool	setMetadata (const char *item_id, const std::map< std::string, hboost::any > &metadata)
bool	setFilePath (const char *item_id, const char *file_path)
bool	setOwnsFile (const char *item_id, bool owns_file)
bool	setBlindData (const char *item_id, HOM_BinaryString data)
bool	setParentId (const char *item_id, const char *parent_item_id)
bool	createTag (const char *tag)
bool	deleteTag (const char *tag, bool delete_if_assigned)
bool	addTag (const char *item_id, const char *tag)
bool	removeTag (const char *item_id, const char *tag)
std::string	generateItemFilePath (const char *item_id, const char *file_ext)
std::string	addItem (const char *label, const char *file_path=nullptr, HOM_BinaryString thumbnail=HOM_BinaryString(), const char *type_name="asset", HOM_BinaryString blind_data=HOM_BinaryString(), int64 creation_date=0, const char *parent_id=nullptr)
bool	markItemsForDeletion (const std::vector< std::string > &item_ids)
bool	unmarkItemsForDeletion (const std::vector< std::string > &item_ids)
bool	saveAs (const char *source_identifier)
void *	_asVoidPointer ()

Detailed Description

Definition at line 19 of file HOM_AssetGalleryDataSource.h.

Constructor & Destructor Documentation

HOM_AssetGalleryDataSource::HOM_AssetGalleryDataSource	(	const char *	source_identifier,
		const char *	args = nullptr
	)

virtual HOM_AssetGalleryDataSource::~HOM_AssetGalleryDataSource ( )

inlinevirtual

Definition at line 24 of file HOM_AssetGalleryDataSource.h.

Member Function Documentation

int HOM_AssetGalleryDataSource::__hash__

(

)

std::string HOM_AssetGalleryDataSource::__repr__

(

)

const

void* HOM_AssetGalleryDataSource::_asVoidPointer ( )

inline

Definition at line 93 of file HOM_AssetGalleryDataSource.h.

std::string HOM_AssetGalleryDataSource::addItem	(	const char *	label,
		const char *	file_path = nullptr,
		HOM_BinaryString	thumbnail = HOM_BinaryString(),
		const char *	type_name = "asset",
		HOM_BinaryString	blind_data = HOM_BinaryString(),
		int64	creation_date = 0,
		const char *	parent_id = nullptr
	)

bool HOM_AssetGalleryDataSource::addTag	(	const char *	item_id,
		const char *	tag
	)

HOM_BinaryString HOM_AssetGalleryDataSource::blindData

(

const char *

item_id

)

const

std::vector<std::string> HOM_AssetGalleryDataSource::childItemIds

(

const char *

parent

)

std::string HOM_AssetGalleryDataSource::colorTag

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::createTag

(

const char *

tag

)

int64 HOM_AssetGalleryDataSource::creationDate

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::deleteTag	(	const char *	tag,
		bool	delete_if_assigned
	)

void HOM_AssetGalleryDataSource::endTransaction

(

bool

commit = true

)

const

std::string HOM_AssetGalleryDataSource::filePath

(

const char *

item_id

)

const

std::string HOM_AssetGalleryDataSource::generateItemFilePath	(	const char *	item_id,
		const char *	file_ext
	)

std::string HOM_AssetGalleryDataSource::infoHtml

(

)

const

bool HOM_AssetGalleryDataSource::isReadOnly

(

)

const

bool HOM_AssetGalleryDataSource::isStarred

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::isValid

(

)

const

std::vector<std::string> HOM_AssetGalleryDataSource::itemIds

(

)

const

std::string HOM_AssetGalleryDataSource::label

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::markItemsForDeletion

(

const std::vector< std::string > &

item_ids

)

int64 HOM_AssetGalleryDataSource::modificationDate

(

const char *

item_id

)

const

UT_Options HOM_AssetGalleryDataSource::opaqueMetadata

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::ownsFile

(

const char *

item_id

)

const

std::string HOM_AssetGalleryDataSource::parentId

(

const char *

item_id

)

const

std::string HOM_AssetGalleryDataSource::prepareItemForUse

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::removeTag	(	const char *	item_id,
		const char *	tag
	)

bool HOM_AssetGalleryDataSource::saveAs

(

const char *

source_identifier

)

bool HOM_AssetGalleryDataSource::setBlindData	(	const char *	item_id,
		HOM_BinaryString	data
	)

bool HOM_AssetGalleryDataSource::setColorTag	(	const char *	item_id,
		const char *	color_tag
	)

bool HOM_AssetGalleryDataSource::setFilePath	(	const char *	item_id,
		const char *	file_path
	)

bool HOM_AssetGalleryDataSource::setIsStarred	(	const char *	item_id,
		bool	isstarred
	)

bool HOM_AssetGalleryDataSource::setLabel	(	const char *	item_id,
		const char *	label
	)

bool HOM_AssetGalleryDataSource::setMetadata	(	const char *	item_id,
		const std::map< std::string, hboost::any > &	metadata
	)

bool HOM_AssetGalleryDataSource::setModificationDate	(	const char *	item_id,
		int64	timestamp
	)

bool HOM_AssetGalleryDataSource::setOwnsFile	(	const char *	item_id,
		bool	owns_file
	)

bool HOM_AssetGalleryDataSource::setParentId	(	const char *	item_id,
		const char *	parent_item_id
	)

bool HOM_AssetGalleryDataSource::setThumbnail	(	const char *	item_id,
		HOM_BinaryString	thumbnail
	)

std::string HOM_AssetGalleryDataSource::sourceArgs

(

)

const

std::string HOM_AssetGalleryDataSource::sourceIdentifier

(

)

const

std::string HOM_AssetGalleryDataSource::sourceTypeName

(

const char *

item_id = nullptr

)

const

void HOM_AssetGalleryDataSource::startTransaction

(

)

const

std::string HOM_AssetGalleryDataSource::status

(

const char *

item_id

)

const

HOM_AssetGalleryDataSource::SWIGOUT

(

%ignore

opaqueMetadata

)

std::vector<std::string> HOM_AssetGalleryDataSource::tags

(

const char *

item_id

)

const

HOM_BinaryString HOM_AssetGalleryDataSource::thumbnail

(

const char *

item_id

)

const

std::string HOM_AssetGalleryDataSource::typeName

(

const char *

item_id

)

const

bool HOM_AssetGalleryDataSource::unmarkItemsForDeletion

(

const std::vector< std::string > &

item_ids

)

std::vector<std::string> HOM_AssetGalleryDataSource::updatedItemIds

(

)

---

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

• HOM/HOM_AssetGalleryDataSource.h