preferences_page Class Reference
Implementing this service will generate a page in preferences dialog. Use preferences_page_factory_t template to register. More...
#include <preferences_page.h>
Inheritance diagram for preferences_page:
Public Types | |
| typedef preferences_page | t_interface_entrypoint |
| typedef preferences_page | t_interface |
| typedef service_base | t_interface_parent |
Public Member Functions | |
| virtual HWND | create (HWND p_parent)=0 |
| Creates preferences page dialog window. It is safe to assume that two dialog instances will never coexist. Caller is responsible for embedding it into preferences dialog itself. | |
| virtual const char * | get_name ()=0 |
| Retrieves name of the prefernces page to be displayed in preferences tree (static string). | |
| virtual GUID | get_guid ()=0 |
| Retrieves GUID of the page. | |
| virtual GUID | get_parent_guid ()=0 |
| Retrieves GUID of parent page/branch of this page. See preferences_page::guid_* constants for list of standard parent GUIDs. Can also be a GUID of another page or a branch (see: preferences_branch). | |
| virtual bool | reset_query ()=0 |
| Queries whether this page supports "reset page" feature. | |
| virtual void | reset ()=0 |
| Activates "reset page" feature. It is safe to assume that the preferences page dialog does not exist at the point this is called (caller destroys it before calling reset and creates it again afterwards). | |
| virtual bool | get_help_url (pfc::string_base &p_out) |
| Retrieves help URL. Without overriding it, it will redirect to foobar2000 wiki. | |
Static Public Member Functions | |
| static void | get_help_url_helper (pfc::string_base &out, const char *category, const GUID &id, const char *name) |
Static Public Attributes | |
| static const GUID | guid_root |
| static const GUID | guid_hidden |
| static const GUID | guid_tools |
| static const GUID | guid_core |
| static const GUID | guid_display |
| static const GUID | guid_playback |
| static const GUID | guid_visualisations |
| static const GUID | guid_input |
| static const GUID | guid_tag_writing |
| static const GUID | guid_media_library |
| static const GUID | guid_tagging = { 0x563107c3, 0xfc7d, 0x4022, { 0xa8, 0x72, 0xa8, 0x2a, 0x2b, 0x3f, 0xd5, 0x25 } } |
| static const GUID | class_guid |
Detailed Description
Implementing this service will generate a page in preferences dialog. Use preferences_page_factory_t template to register.Member Typedef Documentation
Reimplemented in preferences_page_v2.
Member Function Documentation
| virtual HWND preferences_page::create | ( | HWND | p_parent | ) | [pure virtual] |
Creates preferences page dialog window. It is safe to assume that two dialog instances will never coexist. Caller is responsible for embedding it into preferences dialog itself.
| virtual const char* preferences_page::get_name | ( | ) | [pure virtual] |
Retrieves name of the prefernces page to be displayed in preferences tree (static string).
| virtual GUID preferences_page::get_guid | ( | ) | [pure virtual] |
Retrieves GUID of the page.
| virtual GUID preferences_page::get_parent_guid | ( | ) | [pure virtual] |
Retrieves GUID of parent page/branch of this page. See preferences_page::guid_* constants for list of standard parent GUIDs. Can also be a GUID of another page or a branch (see: preferences_branch).
| virtual bool preferences_page::reset_query | ( | ) | [pure virtual] |
Queries whether this page supports "reset page" feature.
| virtual void preferences_page::reset | ( | ) | [pure virtual] |
Activates "reset page" feature. It is safe to assume that the preferences page dialog does not exist at the point this is called (caller destroys it before calling reset and creates it again afterwards).
| virtual bool preferences_page::get_help_url | ( | pfc::string_base & | p_out | ) | [virtual] |
Retrieves help URL. Without overriding it, it will redirect to foobar2000 wiki.
| static void preferences_page::get_help_url_helper | ( | pfc::string_base & | out, | |
| const char * | category, | |||
| const GUID & | id, | |||
| const char * | name | |||
| ) | [static] |
Member Data Documentation
const GUID preferences_page::guid_root [static] |
Initial value:
{ 0xb9218d23, 0xf73d, 0x4b61, { 0xa1, 0xd9, 0xbf, 0xd4, 0x20, 0xcd, 0xac, 0x77 } }
const GUID preferences_page::guid_hidden [static] |
Initial value:
{ 0x2f0e2232, 0xa5fd, 0x43e4, { 0xb6, 0xab, 0x38, 0x39, 0xb8, 0xd1, 0xa7, 0x7 } }
const GUID preferences_page::guid_tools [static] |
Initial value:
{ 0x627c0767, 0x793, 0x44f8, { 0x80, 0x87, 0xbe, 0x49, 0x34, 0x31, 0x12, 0x82 } }
const GUID preferences_page::guid_core [static] |
Initial value:
{ 0x2e8e9647, 0x4174, 0x41b2, { 0x9e, 0xc4, 0x91, 0xb, 0xe1, 0x28, 0x8, 0x2e } }
const GUID preferences_page::guid_display [static] |
Initial value:
{ 0x6aaa67b6, 0x732f, 0x4967, { 0x89, 0x9a, 0x18, 0xc5, 0xf8, 0xc7, 0x0, 0x17 } }
const GUID preferences_page::guid_playback [static] |
Initial value:
{ 0x67508677, 0xcfcc, 0x4a1c, { 0x92, 0x1c, 0x49, 0xb3, 0x9c, 0xc5, 0xb9, 0x86 } }
const GUID preferences_page::guid_visualisations [static] |
Initial value:
{ 0x494326c8, 0x88ff, 0x4265, { 0xb2, 0xb2, 0xe6, 0x47, 0xb, 0xee, 0x13, 0xb3 } }
const GUID preferences_page::guid_input [static] |
Initial value:
{ 0xfc01b529, 0x4bd7, 0x47cd, { 0xba, 0xf7, 0x2f, 0xb6, 0x32, 0xf0, 0xdb, 0xb6 } }
const GUID preferences_page::guid_tag_writing [static] |
Initial value:
{ 0x7d0334e5, 0xadd7, 0x4ff5, { 0x9d, 0xb8, 0xa6, 0x18, 0xb4, 0x82, 0x40, 0x28 } }
const GUID preferences_page::guid_media_library [static] |
Initial value:
{ 0x2d269fa9, 0x6f78, 0x4cec, { 0x9f, 0x1f, 0xa, 0x17, 0x6e, 0xfc, 0xe7, 0x7a } }
const GUID preferences_page::guid_tagging = { 0x563107c3, 0xfc7d, 0x4022, { 0xa8, 0x72, 0xa8, 0x2a, 0x2b, 0x3f, 0xd5, 0x25 } } [static] |
const GUID preferences_page::class_guid [static] |
Initial value:
{ 0x7255e8d0, 0x3fcf, 0x4781, { 0xb9, 0x3b, 0xd0, 0x6c, 0xb8, 0x8d, 0xfa, 0xfa } }
Reimplemented in preferences_page_v2.
The documentation for this class was generated from the following files:
- foobar2000/SDK/preferences_page.h
- foobar2000/SDK/guids.cpp
