foobar2000 SDK  2015-01-14
Public Types | Public Member Functions
playlist_incoming_item_filter_v2abstract

#include <playlist.h>

+ Inheritance diagram for playlist_incoming_item_filter_v2:

Public Types

enum  { op_flag_no_filter = 1 << 0, op_flag_background = 1 << 1, op_flag_delay_ui = 1 << 2 }
 
- Public Types inherited from service_base
typedef service_base t_interface
 

Public Member Functions

 FB2K_MAKE_SERVICE_INTERFACE (playlist_incoming_item_filter_v2, playlist_incoming_item_filter)
 
virtual void process_dropped_files_async (interface IDataObject *p_dataobject, t_uint32 p_op_flags, HWND p_parentwnd, process_locations_notify_ptr p_notify)=0
 
virtual void process_locations_async (const pfc::list_base_const_t< const char * > &p_urls, t_uint32 p_op_flags, const char *p_restrict_mask_override, const char *p_exclude_mask_override, HWND p_parentwnd, process_locations_notify_ptr p_notify)=0
 
- Public Member Functions inherited from playlist_incoming_item_filter
virtual interface IDataObjectcreate_dataobject (const pfc::list_base_const_t< metadb_handle_ptr > &p_data)=0
 
pfc::com_ptr_t< interface IDataObjectcreate_dataobject_ex (metadb_handle_list_cref data)
 
 FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (playlist_incoming_item_filter)
 
virtual bool filter_items (metadb_handle_list_cref in, metadb_handle_list_ref out)=0
 
virtual bool process_dropped_files (interface IDataObject *pDataObject, pfc::list_base_t< metadb_handle_ptr > &p_out, bool p_filter, HWND p_parentwnd)=0
 
virtual bool process_dropped_files_check (interface IDataObject *pDataObject)=0
 
virtual bool process_dropped_files_check_ex (interface IDataObject *pDataObject, DWORD *p_effect)=0
 
virtual bool process_dropped_files_check_if_native (interface IDataObject *pDataObject)=0
 
virtual bool process_dropped_files_delayed (dropped_files_data &p_out, interface IDataObject *pDataObject)=0
 
bool process_location (const char *url, pfc::list_base_t< metadb_handle_ptr > &out, bool filter, const char *p_mask, const char *p_exclude, HWND p_parentwnd)
 
virtual bool process_locations (const pfc::list_base_const_t< const char * > &p_urls, pfc::list_base_t< metadb_handle_ptr > &p_out, bool p_filter, const char *p_restrict_mask_override, const char *p_exclude_mask_override, HWND p_parentwnd)=0
 
- Public Member Functions inherited from service_base
template<typename outPtr_t >
bool cast (outPtr_t &outPtr)
 
virtual int service_add_ref ()=0 throw ()
 
virtual bool service_query (service_ptr_t< service_base > &p_out, const GUID &p_guid)
 
template<class T >
bool service_query_t (service_ptr_t< T > &p_out)
 
virtual int service_release ()=0 throw ()
 

Additional Inherited Members

- Protected Member Functions inherited from service_base
 service_base ()
 
 ~service_base ()
 

Detailed Description

Since
0.9.3

Definition at line 783 of file playlist.h.

Member Enumeration Documentation

anonymous enum
Enumerator
op_flag_no_filter 

Set this to disable presorting (according to user settings) and duplicate removal in output list. Should be unset in most cases.

op_flag_background 

Set this flag to make the progress dialog not steal focus on creation.

op_flag_delay_ui 

Set this flag to delay the progress dialog becoming visible, so it does not appear at all during short operations. Also implies op_flag_background effect.

Definition at line 785 of file playlist.h.

785  {
787  op_flag_no_filter = 1 << 0,
789  op_flag_background = 1 << 1,
791  op_flag_delay_ui = 1 << 2,
792  };
Set this flag to make the progress dialog not steal focus on creation.
Definition: playlist.h:789
Set this to disable presorting (according to user settings) and duplicate removal in output list...
Definition: playlist.h:787
Set this flag to delay the progress dialog becoming visible, so it does not appear at all during shor...
Definition: playlist.h:791

Member Function Documentation

playlist_incoming_item_filter_v2::FB2K_MAKE_SERVICE_INTERFACE ( playlist_incoming_item_filter_v2  ,
playlist_incoming_item_filter   
)
virtual void playlist_incoming_item_filter_v2::process_dropped_files_async ( interface IDataObject p_dataobject,
t_uint32  p_op_flags,
HWND  p_parentwnd,
process_locations_notify_ptr  p_notify 
)
pure virtual

Converts an IDataObject to a list of metadb_handles. The function returns immediately; specified callback object receives results when the operation has completed.

Parameters
p_dataobjectIDataObject to process.
p_op_flagsCan be null, or one or more of op_flag_* enum values combined, altering behaviors of the operation.
p_parentwndParent window for spawned progress dialogs.
p_notifyCallback receiving notifications about success/abort of the operation as well as output item list.
virtual void playlist_incoming_item_filter_v2::process_locations_async ( const pfc::list_base_const_t< const char * > &  p_urls,
t_uint32  p_op_flags,
const char *  p_restrict_mask_override,
const char *  p_exclude_mask_override,
HWND  p_parentwnd,
process_locations_notify_ptr  p_notify 
)
pure virtual

Converts one or more paths to a list of metadb_handles. The function returns immediately; specified callback object receives results when the operation has completed.

Parameters
p_urlsList of paths to process.
p_op_flagsCan be null, or one or more of op_flag_* enum values combined, altering behaviors of the operation.
p_restrict_mask_overrideOverride of "restrict incoming items to" setting. Pass NULL to use the value from preferences.
p_exclude_mask_overrideOverride of "exclude file types" setting. Pass NULL to use value from preferences.
p_parentwndParent window for spawned progress dialogs.
p_notifyCallback receiving notifications about success/abort of the operation as well as output item list.

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