MetaPictureList represents the meta pictures inside a Metadata object. More...

Inheritance diagram for MetaPictureList:

Public Member Functions
virtual bool_t	add (MetaPicture *picture)=0
	Adds a new picture to the end of the list. More...

virtual MetaPicture *	at (int32_t index) const =0
	Returns a picture by index. More...

virtual bool_t	clear ()=0
	Removes all pictures from the collection. More...

virtual int32_t	count () const =0
	Returns the number of pictures in the list. More...

virtual bool_t	immutable () const =0
	Returns whether the object is immutable. More...

virtual bool_t	insert (int32_t itemIndex, MetaPicture *picture)=0
	Inserts a picture at the specified index in the list. More...

virtual bool_t	remove (int32_t index)=0
	Removes a picture by index. More...

virtual bool_t	setAt (int32_t itemIndex, MetaPicture *picture)=0
	Sets a new picture at the specified index. More...

Public Member Functions inherited from Reference
virtual int32_t	release () const =0
	Releases the instance. More...

virtual int32_t	retain () const =0
	Retains the instance. More...

virtual int32_t	retainCount () const =0
	Returns the current reference count. More...

Protected Member Functions
virtual	~MetaPictureList ()
	This object can be destroyed only by the library that has created it. More...

Detailed Description

MetaPictureList represents the meta pictures inside a Metadata object.

This is a modifiable and indexable collection that exists only in the context of a Metadata object and cannot be created separately from it, nor detached.

Constructor & Destructor Documentation

virtual ~MetaPictureList ( )

protectedvirtual

This object can be destroyed only by the library that has created it.

See Also: primo::Reference::release

Member Function Documentation

virtual bool_t add ( MetaPicture * picture )

pure virtual

Adds a new picture to the end of the list.

Parameters

picture [in] A pointer to a MetaPicture object. It is allowed to add a NULL item to the collection. Internally if the MetaPicture object is not NULL it is retained, so it is safe to release it after this method returns.

Returns

TRUE if the specified item is added to the collection, otherwise FALSE.

            @see Library::createMetaPicture
            @see \ref object_management "Object Management"

virtual MetaPicture* at ( int32_t index ) const

pure virtual

Returns a picture by index.

Parameters

index [in] A zero-based index.

Returns: A pointer to the MetaPicture object specified by index.

The caller is not required to release the returned object.

virtual bool_t clear ( )

pure virtual

Removes all pictures from the collection.

When removed from the collection each MetaPicture object is released.

Returns

TRUE if the collection is cleared, otherwise FALSE.

            @see \ref object_management "Object Management"

virtual int32_t count ( ) const

pure virtual

Returns the number of pictures in the list.

Returns: number of items in the collection.

virtual bool_t immutable ( ) const

pure virtual

Returns whether the object is immutable.

An immmutable object cannot be modified and all modifying methods fail to produce a result.

Returns: TRUE if the object is immutable, FALSE otherwise.

Remarks: An immutable object can be modified by the AVBlocks library.; Object immutability spreads to all nested objects. Therefore it is not possible to add/set an immutable object to a mutable object.

virtual bool_t insert	(	int32_t	itemIndex,
		MetaPicture *	picture
	)

pure virtual

Inserts a picture at the specified index in the list.

Parameters

itemIndex	[in] The index in the collection where the new item shall be inserted. This must be a valid index in the collection. Indexing starts from 0. After the new item is inserted in the collection its index is the value of the itemIndex param.
picture	[in] A pointer to the MetaPicture object that shall be inserted. It is allowed to insert a NULL value in the collection. Internally the new item is retained (if not NULL), so it is safe to release it after this method returns.

Returns: TRUE The item is inserted, FALSE otherwise.

See Also: Object Management

virtual bool_t remove ( int32_t index )

pure virtual

Removes a picture by index.

Parameters

index [in] A zero-based index of the picture that shall be removed. When the MetaPicture object is removed it is released.

Returns: TRUE if the picture is successfully removed, FALSE if there's an error.

See Also: primo::Reference::release

virtual bool_t setAt	(	int32_t	itemIndex,
		MetaPicture *	picture
	)

pure virtual

Sets a new picture at the specified index.

Parameters

itemIndex	[in] The index in the collection where the new item shall be set. This must be a valid index in the collection. Indexing starts from 0.
picture	[in] A pointer to the MetaPicture object that shall be set. It is allowed to set a NULL value to the collection. Internally the new item is retained (if not NULL), so it is safe to release it after this method returns. The old item is released (if not NULL).

Returns: TRUE if the item is set, FALSE otherwise.

See Also: Object Management

Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation