masstagger_action Class Reference

#include <masstagger_action.h>

Inheritance diagram for masstagger_action:

service_base

List of all members.

Public Types

typedef masstagger_action t_interface_entrypoint
typedef masstagger_action t_interface
typedef service_base t_interface_parent

Public Member Functions

virtual void get_name (pfc::string_base &p_out)=0
virtual bool initialize (HWND p_parent)=0
virtual bool initialize_fromconfig (const char *p_data)=0
virtual bool configure (HWND p_parent)=0
virtual void get_display_string (pfc::string_base &p_name)=0
virtual void get_config (pfc::string_base &p_data)=0
virtual void run (const playable_location &p_location, file_info *p_info, t_size p_index, t_size p_count)=0
virtual const GUID & get_guid ()=0

Static Public Attributes

static const GUID class_guid


Member Typedef Documentation

Reimplemented from service_base.


Member Function Documentation

virtual void masstagger_action::get_name ( pfc::string_base p_out  )  [pure virtual]

Get name to display on list of available actions.

Parameters:
p_out store name in here

virtual bool masstagger_action::initialize ( HWND  p_parent  )  [pure virtual]

Initialize and show configuration with default values, if appropriate.

Parameters:
p_parent handle to parent window
Returns:
true iff succesful

virtual bool masstagger_action::initialize_fromconfig ( const char *  p_data  )  [pure virtual]

Initialize and get configuration from parameter.

Parameters:
p_data a zero-terminated string containing previously stored configuration data.
Returns:
true iff succesful

virtual bool masstagger_action::configure ( HWND  p_parent  )  [pure virtual]

Show configuration with current values.

Parameters:
parent handle to parent window
Returns:
true if display string needs to be updated.

virtual void masstagger_action::get_display_string ( pfc::string_base p_name  )  [pure virtual]

Get name to display on list of configured actions. You should include value of settings, if possible.

Parameters:
p_name store name in here

virtual void masstagger_action::get_config ( pfc::string_base p_data  )  [pure virtual]

Get current settings as zero-terminated string.

Parameters:
p_data store settings in here

virtual void masstagger_action::run ( const playable_location p_location,
file_info p_info,
t_size  p_index,
t_size  p_count 
) [pure virtual]

Apply action on file info.

Parameters:
p_location location of current item
p_info file info of current item, contains modifications from previous actions
p_index zero-based index of current item in list of processed items
p_count number of processed items

virtual const GUID& masstagger_action::get_guid (  )  [pure virtual]

Get GUID. Used for identification when storing scripts.

Returns:
your GUID


Member Data Documentation

const GUID masstagger_action::class_guid [static]


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

Generated on Fri Apr 18 13:56:52 2008 for foobar2000 SDK by  doxygen 1.5.5