preferences_branch Class Reference

Creates a preferences branch - an empty page that only serves as a parent for other pages and is hidden when no child pages exist. Instead of implementing this, simply use preferences_branch_factory class to declare a preferences branch with specified parameters. More...

#include <preferences_page.h>

Inheritance diagram for preferences_branch:

List of all members.

Public Types
typedef preferences_branch	t_interface_entrypoint
typedef preferences_branch	t_interface
typedef service_base	t_interface_parent
Public Member Functions
virtual const char *	get_name ()=0
	Retrieves name of the preferences branch.
virtual GUID	get_guid ()=0
	Retrieves GUID of the preferences branch. Use this GUID as parent GUID for pages/branches nested in this branch.
virtual GUID	get_parent_guid ()=0
	Retrieves GUID of parent page/branch of this branch. See preferences_page::guid_* constants for list of standard parent GUIDs. Can also be a GUID of another branch or a page.
Static Public Attributes
static const GUID	class_guid

---

Detailed Description

Creates a preferences branch - an empty page that only serves as a parent for other pages and is hidden when no child pages exist. Instead of implementing this, simply use preferences_branch_factory class to declare a preferences branch with specified parameters.

---

Member Typedef Documentation

typedef preferences_branch preferences_branch::t_interface_entrypoint

typedef preferences_branch preferences_branch::t_interface

Reimplemented from service_base.

Reimplemented in preferences_branch_v2.

typedef service_base preferences_branch::t_interface_parent

Reimplemented in preferences_branch_v2.

---

Member Function Documentation

virtual const char* preferences_branch::get_name

(

)

[pure virtual]

Retrieves name of the preferences branch.

Implemented in preferences_branch_impl.

virtual GUID preferences_branch::get_guid

(

)

[pure virtual]

Retrieves GUID of the preferences branch. Use this GUID as parent GUID for pages/branches nested in this branch.

Implemented in preferences_branch_impl.

virtual GUID preferences_branch::get_parent_guid

(

)

[pure virtual]

Retrieves GUID of parent page/branch of this branch. See preferences_page::guid_* constants for list of standard parent GUIDs. Can also be a GUID of another branch or a page.

Implemented in preferences_branch_impl.

---

Member Data Documentation

const GUID preferences_branch::class_guid [static]

Initial value:

{ 0x8146a883, 0xf146, 0x401b, { 0xba, 0xf6, 0x4f, 0xb2, 0xe3, 0x6, 0xf2, 0xeb } }

Reimplemented in preferences_branch_v2.

---

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

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