autoplaylist_client_v2 Class Reference
Supported from 0.9.5.3 up. More...
#include <autoplaylist.h>
Public Types | |
| typedef autoplaylist_client_v2 | t_interface |
| typedef autoplaylist_client | t_interface_parent |
Public Member Functions | |
| virtual void | set_full_refresh_notify (completion_notify::ptr notify)=0 |
| virtual bool | show_ui_available ()=0 |
| Returns whether the show_ui() method is available / does anything useful with out implementation (not everyone implements show_ui). | |
| virtual void | get_display_name (pfc::string_base &out)=0 |
| Returns a human-readable autoplaylist implementer's label to display in playlist's context menu / description / etc. | |
Static Public Attributes | |
| static const GUID | class_guid = { 0xfaa716f7, 0xebb1, 0x473c, { 0xbc, 0xf1, 0xb0, 0x1b, 0x8c, 0x9f, 0x1b, 0x95 } } |
Detailed Description
Supported from 0.9.5.3 up.Member Typedef Documentation
Reimplemented from autoplaylist_client.
Reimplemented from autoplaylist_client.
Member Function Documentation
| virtual void autoplaylist_client_v2::set_full_refresh_notify | ( | completion_notify::ptr | notify | ) | [pure virtual] |
Sets a completion_notify object that the autoplaylist_client implementation should call when its filtering behaviors have changed so the whole playlist needs to be rebuilt.
completion_notify::on_completion() status parameter meaning:
0.9.5.3 : ignored.
0.9.5.4 and newer: set to 1 to indicate that your configuration has changed as well (for an example as a result of user edits) to get a get_configuration() call as well as cause the playlist to be rebuilt; set to zero otherwise - when the configuration hasn't changed but the playlist needs to be rebuilt as a result of some other event.
| virtual bool autoplaylist_client_v2::show_ui_available | ( | ) | [pure virtual] |
Returns whether the show_ui() method is available / does anything useful with out implementation (not everyone implements show_ui).
| virtual void autoplaylist_client_v2::get_display_name | ( | pfc::string_base & | out | ) | [pure virtual] |
Returns a human-readable autoplaylist implementer's label to display in playlist's context menu / description / etc.
Member Data Documentation
const GUID autoplaylist_client_v2::class_guid = { 0xfaa716f7, 0xebb1, 0x473c, { 0xbc, 0xf1, 0xb0, 0x1b, 0x8c, 0x9f, 0x1b, 0x95 } } [static] |
Reimplemented from autoplaylist_client.
The documentation for this class was generated from the following files:
- foobar2000/SDK/autoplaylist.h
- foobar2000/SDK/guids.cpp
