A list of well-known metdata that a format understands. The list is ordered. More...

#include <IMG_Metadata.h>

Classes
struct	Item

Public Types
using	Scope = IMG_MetadataItem::Scope

using	Storage = IMG_MetadataItem::Storage

using	TypeInfo = IMG_MetadataItem::TypeInfo

using	MenuCreator = UT_Array< std::pair< const char , const char >>

Public Member Functions
	IMG_MetadataOptions ()=default

	IMG_MetadataOptions (std::initializer_list< Item > init)

void	append (const Item &item)

void	append (const UT_StringHolder &name, const IMG_MetadataItem &item)

void	dump () const
	Debug printing. More...

bool	save (UT_JSONWriter &w) const


exint	size () const

int	index (const UT_StringRef &name) const

Item &	get (int idx)

const Item &	get (int idx) const

Item &	operator[] (int idx)

const Item &	operator[] (int idx) const

Item &	get (const UT_StringRef &name)

const Item &	get (const UT_StringRef &name) const

Item &	operator[] (const UT_StringRef &name)

const Item &	operator[] (const UT_StringRef &name) const


int	menuIndex (int parm_index, const UT_StringRef &menu_token) const

int	menuIndex (const UT_StringRef &parm_name, const UT_StringRef &menu_token) const


UT_StringHolder	menuToken (int parm_index, int menu_index) const

UT_StringHolder	menuToken (const UT_StringRef &name, int idx) const

UT_StringHolder	menuLabel (int parm_index, int menu_index) const

UT_StringHolder	menuLabel (const UT_StringRef &name, int idx) const

using	const_iterator = UT_Array< Item >::const_iterator

const_iterator	begin () const

const_iterator	end () const

Detailed Description

A list of well-known metdata that a format understands. The list is ordered.

Definition at line 370 of file IMG_Metadata.h.

Member Typedef Documentation

using IMG_MetadataOptions::const_iterator = UT_Array<Item>::const_iterator

Iteration interface

Definition at line 454 of file IMG_Metadata.h.

using IMG_MetadataOptions::MenuCreator = UT_Array<std::pair<const char *, const char *>>

Definition at line 377 of file IMG_Metadata.h.

using IMG_MetadataOptions::Scope = IMG_MetadataItem::Scope

Definition at line 373 of file IMG_Metadata.h.

using IMG_MetadataOptions::Storage = IMG_MetadataItem::Storage

Definition at line 374 of file IMG_Metadata.h.

using IMG_MetadataOptions::TypeInfo = IMG_MetadataItem::TypeInfo

Definition at line 375 of file IMG_Metadata.h.

Constructor & Destructor Documentation

IMG_MetadataOptions::IMG_MetadataOptions ( )

explicitdefault

IMG_MetadataOptions::IMG_MetadataOptions ( std::initializer_list< Item > init )

inlineexplicit

Definition at line 408 of file IMG_Metadata.h.

Member Function Documentation

void IMG_MetadataOptions::append ( const Item & item )

inline

Definition at line 413 of file IMG_Metadata.h.

void IMG_MetadataOptions::append	(	const UT_StringHolder &	name,
		const IMG_MetadataItem &	item
	)

inline

Definition at line 414 of file IMG_Metadata.h.

const_iterator IMG_MetadataOptions::begin ( void ) const

inline

Iteration interface

Definition at line 455 of file IMG_Metadata.h.

void IMG_MetadataOptions::dump ( ) const

Debug printing.

const_iterator IMG_MetadataOptions::end ( void ) const

inline

Iteration interface

Definition at line 456 of file IMG_Metadata.h.

Item& IMG_MetadataOptions::get ( int idx )

inline

Lookup item

Definition at line 424 of file IMG_Metadata.h.

const Item& IMG_MetadataOptions::get ( int idx ) const

inline

Lookup item

Definition at line 425 of file IMG_Metadata.h.

Item& IMG_MetadataOptions::get ( const UT_StringRef & name )

inline

Lookup item

Definition at line 428 of file IMG_Metadata.h.

const Item& IMG_MetadataOptions::get ( const UT_StringRef & name ) const

inline

Lookup item

Definition at line 429 of file IMG_Metadata.h.

int IMG_MetadataOptions::index ( const UT_StringRef & name ) const

Lookup item

int IMG_MetadataOptions::menuIndex	(	int	parm_index,
		const UT_StringRef &	menu_token
	)		const

Find the corresponding menu index for the value of a given parameter

int IMG_MetadataOptions::menuIndex	(	const UT_StringRef &	parm_name,
		const UT_StringRef &	menu_token
	)		const

inline

Find the corresponding menu index for the value of a given parameter

Definition at line 438 of file IMG_Metadata.h.

UT_StringHolder IMG_MetadataOptions::menuLabel	(	int	parm_index,
		int	menu_index
	)		const

Get the token/label from the menu of a given parameter

UT_StringHolder IMG_MetadataOptions::menuLabel	(	const UT_StringRef &	name,
		int	idx
	)		const

inline

Get the token/label from the menu of a given parameter

Definition at line 448 of file IMG_Metadata.h.

UT_StringHolder IMG_MetadataOptions::menuToken	(	int	parm_index,
		int	menu_index
	)		const

Get the token/label from the menu of a given parameter

UT_StringHolder IMG_MetadataOptions::menuToken	(	const UT_StringRef &	name,
		int	idx
	)		const

inline

Get the token/label from the menu of a given parameter

Definition at line 445 of file IMG_Metadata.h.

Item& IMG_MetadataOptions::operator[] ( int idx )

inline

Lookup item

Definition at line 426 of file IMG_Metadata.h.

const Item& IMG_MetadataOptions::operator[] ( int idx ) const

inline

Lookup item

Definition at line 427 of file IMG_Metadata.h.

Item& IMG_MetadataOptions::operator[] ( const UT_StringRef & name )

inline

Lookup item

Definition at line 430 of file IMG_Metadata.h.

const Item& IMG_MetadataOptions::operator[] ( const UT_StringRef & name ) const

inline

Lookup item

Definition at line 431 of file IMG_Metadata.h.

bool IMG_MetadataOptions::save ( UT_JSONWriter & w ) const

exint IMG_MetadataOptions::size ( void ) const

inline

Lookup item

Definition at line 422 of file IMG_Metadata.h.

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

IMG/IMG_Metadata.h

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation