Chris@1: Chris@1: Chris@1: FLAC: FLAC::Metadata::Picture Class Reference Chris@1: Chris@1: Chris@1: Chris@1:
Main Page | Modules | Class Hierarchy | Alphabetical List | Class List | Directories | File List | Class Members | File Members
Chris@1:
Chris@1: FLAC::Metadata::Picture
Chris@1:

FLAC::Metadata::Picture Class Reference
Chris@1: Chris@1: [FLAC++/metadata.h: metadata object classes] Chris@1:

#include <metadata.h> Chris@1:

Chris@1:

Inheritance diagram for FLAC::Metadata::Picture: Chris@1:

Chris@1: Chris@1: FLAC::Metadata::Prototype Chris@1: Chris@1: List of all members.

Detailed Description

Chris@1: PICTURE metadata block. See the overview for more, and the format specification. Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:

Public Member Functions

 Picture (const Picture &object)
Chris@1:  Picture (const ::FLAC__StreamMetadata &object)
Chris@1:  Picture (const ::FLAC__StreamMetadata *object)
 Picture (::FLAC__StreamMetadata *object, bool copy)
Picture & operator= (const Picture &object)
Chris@1: Picture & operator= (const ::FLAC__StreamMetadata &object)
Chris@1: Picture & operator= (const ::FLAC__StreamMetadata *object)
Picture & assign (::FLAC__StreamMetadata *object, bool copy)
bool operator== (const Picture &object) const
Chris@1: bool operator== (const ::FLAC__StreamMetadata &object) const
Chris@1: bool operator== (const ::FLAC__StreamMetadata *object) const
bool operator!= (const Picture &object) const
Chris@1: bool operator!= (const ::FLAC__StreamMetadata &object) const
Chris@1: bool operator!= (const ::FLAC__StreamMetadata *object) const
::FLAC__StreamMetadata_Picture_Type get_type () const
Chris@1: const char * get_mime_type () const
Chris@1: const FLAC__byte * get_description () const
Chris@1: FLAC__uint32 get_width () const
Chris@1: FLAC__uint32 get_height () const
Chris@1: FLAC__uint32 get_depth () const
FLAC__uint32 get_colors () const
Chris@1: FLAC__uint32 get_data_length () const
Chris@1: const FLAC__byte * get_data () const
Chris@1: void set_type (::FLAC__StreamMetadata_Picture_Type type)
bool set_mime_type (const char *string)
bool set_description (const FLAC__byte *string)
Chris@1: void set_width (FLAC__uint32 value) const
Chris@1: void set_height (FLAC__uint32 value) const
Chris@1: void set_depth (FLAC__uint32 value) const
void set_colors (FLAC__uint32 value) const
bool set_data (const FLAC__byte *data, FLAC__uint32 data_length)
bool operator== (const Prototype &) const
bool operator!= (const Prototype &) const
bool is_valid () const
bool get_is_last () const
unsigned get_length () const
void set_is_last (bool)
 operator const ::FLAC__StreamMetadata * () const

Protected Member Functions

Prototype & assign_object (::FLAC__StreamMetadata *object, bool copy)
virtual void clear ()

Protected Attributes

Chris@1: ::FLAC__StreamMetadata * object_

Friends

Chris@1: class SimpleIterator
Chris@1: class Iterator
Chris@1:

Constructor & Destructor Documentation

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
FLAC::Metadata::Picture::Picture ( const Picture &  object  )  [inline]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Constructs a copy of the given object. This form always performs a deep copy.

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
FLAC::Metadata::Picture::Picture ( ::FLAC__StreamMetadata *  object,
bool  copy
)  [inline]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Constructs an object with copy control. See Prototype(::FLAC__StreamMetadata *object, bool copy).

Chris@1:

Member Function Documentation

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Picture& FLAC::Metadata::Picture::operator= ( const Picture &  object  )  [inline]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Assign from another object. Always performs a deep copy.

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Picture& FLAC::Metadata::Picture::assign ( ::FLAC__StreamMetadata *  object,
bool  copy
)  [inline]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Assigns an object with copy control. See Prototype::assign_object(::FLAC__StreamMetadata *object, bool copy).

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool FLAC::Metadata::Picture::operator== ( const Picture &  object  )  const [inline]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Check for equality, performing a deep compare by following pointers.

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool FLAC::Metadata::Picture::operator!= ( const Picture &  object  )  const [inline]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Check for inequality, performing a deep compare by following pointers.

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
::FLAC__StreamMetadata_Picture_Type FLAC::Metadata::Picture::get_type (   )  const
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Returns the type of the block.

Chris@1:

Assertions: 
 is_valid() 
Chris@1:
Chris@1: Chris@1:

Chris@1: Reimplemented from FLAC::Metadata::Prototype.

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
FLAC__uint32 FLAC::Metadata::Picture::get_colors (   )  const
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: a return value of 0 means true-color, i.e. 2^depth colors Chris@1:

Chris@1:

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool FLAC::Metadata::Picture::set_mime_type ( const char *  string  ) 
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: See FLAC__metadata_object_picture_set_mime_type(). Chris@1:

Chris@1:

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool FLAC::Metadata::Picture::set_description ( const FLAC__byte *  string  ) 
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: See FLAC__metadata_object_picture_set_description(). Chris@1:

Chris@1:

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
void FLAC::Metadata::Picture::set_colors ( FLAC__uint32  value  )  const
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: a value of 0 means true-color, i.e. 2^depth colors Chris@1:

Chris@1:

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool FLAC::Metadata::Picture::set_data ( const FLAC__byte *  data,
FLAC__uint32  data_length
) 
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: See FLAC__metadata_object_picture_set_data(). Chris@1:

Chris@1:

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Prototype& FLAC::Metadata::Prototype::assign_object ( ::FLAC__StreamMetadata *  object,
bool  copy
)  [protected, inherited]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Assigns an object with copy control. See Prototype(::FLAC__StreamMetadata *object, bool copy).

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
virtual void FLAC::Metadata::Prototype::clear (   )  [protected, virtual, inherited]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Deletes the underlying FLAC__StreamMetadata object.

Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
bool FLAC::Metadata::Prototype::get_is_last (   )  const [inherited]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Returns true if this block is the last block in a stream, else false.

Chris@1:

Assertions: 
 is_valid() 
Chris@1:
Chris@1:
Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
unsigned FLAC::Metadata::Prototype::get_length (   )  const [inherited]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Returns the stream length of the metadata block.

Chris@1:

Note:
The length does not include the metadata block header, per spec.
Chris@1:
Assertions: 
 is_valid() 
Chris@1:
Chris@1:
Chris@1:

Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
void FLAC::Metadata::Prototype::set_is_last ( bool   )  [inherited]
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1:   Chris@1: Chris@1: Chris@1:

Chris@1: Sets the "is_last" flag for the block. When using the iterators it is not necessary to set this flag; they will do it for you.

Chris@1:

Assertions: 
 is_valid() 
Chris@1:
Chris@1:
Chris@1:

The documentation for this class was generated from the following file: Chris@1: Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1:
Chris@1: Copyright (c) 2000,2001,2002,2003,2004,2005,2006,2007 Josh Coalson Chris@1: Chris@1: SourceForge.net Logo Chris@1:
Chris@1:
Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: Chris@1: