preferences_page

#include <preferences_page.h>

Inheritance diagram for preferences_page:

Public Member Functions
virtual HWND	create (HWND p_parent)=0
	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (preferences_page)
virtual GUID	get_guid ()=0
virtual bool	get_help_url (pfc::string_base &p_out)
virtual const char *	get_name ()=0
virtual GUID	get_parent_guid ()=0
virtual void	reset ()=0
virtual bool	reset_query ()=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 ()

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_core
static const GUID	guid_display
static const GUID	guid_hidden
static const GUID	guid_input
static const GUID	guid_media_library
static const GUID	guid_playback
static const GUID	guid_root
static const GUID	guid_tag_writing
static const GUID	guid_tagging = { 0x563107c3, 0xfc7d, 0x4022, { 0xa8, 0x72, 0xa8, 0x2a, 0x2b, 0x3f, 0xd5, 0x25 } }
static const GUID	guid_tools
static const GUID	guid_visualisations

Additional Inherited Members
Public Types inherited from service_base
typedef service_base	t_interface
Protected Member Functions inherited from service_base
	service_base ()
	~service_base ()

Detailed Description

Implementing this service will generate a page in preferences dialog. Use preferences_page_factory_t template to register.
In 1.0 and newer you should always derive from preferences_page_v3 rather than from preferences_page directly.

Definition at line 3 of file preferences_page.h.

Member Function Documentation

virtual HWND preferences_page::create ( HWND  p_parent )

pure virtual

Obsolete.

Implemented in preferences_page_v3.

preferences_page::FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT

(

preferences_page

)

virtual GUID preferences_page::get_guid ( )

pure virtual

Retrieves GUID of the page.

Implemented in preferences_page_myimpl.

bool preferences_page::get_help_url ( pfc::string_base &  p_out )

virtual

Retrieves help URL. Without overriding it, it will redirect to foobar2000 wiki.

Definition at line 7 of file preferences_page.cpp.

                                                          {
    get_help_url_helper(p_out,"preferences",get_guid(), get_name());
    return true;
}

void preferences_page::get_help_url_helper ( pfc::string_base &  out, const char *  category, const GUID &  id, const char *  name  )

static

Definition at line 3 of file preferences_page.cpp.

                                                                                                                          {
    out.reset();
    out << "http://help.foobar2000.org/" << core_version_info::g_get_version_string() << "/" << category << "/" << pfc::print_guid(id) << "/" << name;
}

virtual const char* preferences_page::get_name ( )

pure virtual

Retrieves name of the prefernces page to be displayed in preferences tree (static string).

Implemented in preferences_page_myimpl.

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).

Implemented in preferences_page_myimpl.

virtual void preferences_page::reset ( )

pure virtual

Obsolete.

Implemented in preferences_page_v3.

virtual bool preferences_page::reset_query ( )

pure virtual

Obsolete.

Implemented in preferences_page_v3.

Field Documentation

FOOGUIDDECL const GUID preferences_page::guid_core

static

Initial value:

=
{ 0x2e8e9647, 0x4174, 0x41b2, { 0x9e, 0xc4, 0x91, 0xb, 0xe1, 0x28, 0x8, 0x2e } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_display

static

Initial value:

=
{ 0x6aaa67b6, 0x732f, 0x4967, { 0x89, 0x9a, 0x18, 0xc5, 0xf8, 0xc7, 0x0, 0x17 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_hidden

static

Initial value:

=
{ 0x2f0e2232, 0xa5fd, 0x43e4, { 0xb6, 0xab, 0x38, 0x39, 0xb8, 0xd1, 0xa7, 0x7 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_input

static

Initial value:

=
{ 0xfc01b529, 0x4bd7, 0x47cd, { 0xba, 0xf7, 0x2f, 0xb6, 0x32, 0xf0, 0xdb, 0xb6 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_media_library

static

Initial value:

=
{ 0x2d269fa9, 0x6f78, 0x4cec, { 0x9f, 0x1f, 0xa, 0x17, 0x6e, 0xfc, 0xe7, 0x7a } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_playback

static

Initial value:

=
{ 0x67508677, 0xcfcc, 0x4a1c, { 0x92, 0x1c, 0x49, 0xb3, 0x9c, 0xc5, 0xb9, 0x86 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_root

static

Initial value:

=
{ 0xb9218d23, 0xf73d, 0x4b61, { 0xa1, 0xd9, 0xbf, 0xd4, 0x20, 0xcd, 0xac, 0x77 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_tag_writing

static

Initial value:

=
{ 0x7d0334e5, 0xadd7, 0x4ff5, { 0x9d, 0xb8, 0xa6, 0x18, 0xb4, 0x82, 0x40, 0x28 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_tagging = { 0x563107c3, 0xfc7d, 0x4022, { 0xa8, 0x72, 0xa8, 0x2a, 0x2b, 0x3f, 0xd5, 0x25 } }

static

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_tools

static

Initial value:

=
{ 0x627c0767, 0x793, 0x44f8, { 0x80, 0x87, 0xbe, 0x49, 0x34, 0x31, 0x12, 0x82 } }

Definition at line 22 of file preferences_page.h.

FOOGUIDDECL const GUID preferences_page::guid_visualisations

static

Initial value:

=
{ 0x494326c8, 0x88ff, 0x4265, { 0xb2, 0xb2, 0xe6, 0x47, 0xb, 0xee, 0x13, 0xb3 } }

Definition at line 22 of file preferences_page.h.

---

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

• foobar2000/SDK/preferences_page.h
• foobar2000/SDK/guids.cpp
• foobar2000/SDK/preferences_page.cpp