metadb_display_field_provider Class Reference

#include <metadb.h>

Inheritance diagram for metadb_display_field_provider:

service_base

List of all members.

Public Types

typedef
metadb_display_field_provider 
t_interface_entrypoint
typedef
metadb_display_field_provider 
t_interface
typedef service_base t_interface_parent

Public Member Functions

virtual t_uint32 get_field_count ()=0
 Returns number of fields provided by this metadb_display_field_provider implementation.
virtual void get_field_name (t_uint32 index, pfc::string_base &out)=0
 Returns name of specified field provided by this metadb_display_field_provider implementation.
virtual bool process_field (t_uint32 index, metadb_handle *handle, titleformat_text_out *out)=0

Static Public Attributes

static const GUID class_guid = { 0x5923fa2a, 0x504b, 0x4022, { 0xb2, 0x86, 0x0, 0x22, 0x75, 0x38, 0x45, 0x5e } }


Member Typedef Documentation

Reimplemented from service_base.


Member Function Documentation

virtual t_uint32 metadb_display_field_provider::get_field_count (  )  [pure virtual]

Returns number of fields provided by this metadb_display_field_provider implementation.

virtual void metadb_display_field_provider::get_field_name ( t_uint32  index,
pfc::string_base out 
) [pure virtual]

Returns name of specified field provided by this metadb_display_field_provider implementation.

virtual bool metadb_display_field_provider::process_field ( t_uint32  index,
metadb_handle handle,
titleformat_text_out out 
) [pure virtual]

Evaluates the specified field.

Parameters:
index Index of field being processed : 0 <= index < get_field_count().
handle Handle to item being processed. You can safely call "locked" methods on this handle to retrieve track information and such.
out Interface receiving your text output.
Returns:
Return true to indicate that the field is present so if it's enclosed in square brackets, contents of those brackets should not be skipped, false otherwise.


Member Data Documentation

const GUID metadb_display_field_provider::class_guid = { 0x5923fa2a, 0x504b, 0x4022, { 0xb2, 0x86, 0x0, 0x22, 0x75, 0x38, 0x45, 0x5e } } [static]


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

Generated on Fri Apr 25 18:49:46 2008 for foobar2000 SDK by  doxygen 1.5.5