preferences_branch

#include <preferences_page.h>

Inheritance diagram for preferences_branch:

Public Member Functions
	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (preferences_branch)
virtual GUID	get_guid ()=0
virtual const char *	get_name ()=0
virtual GUID	get_parent_guid ()=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
Public Types inherited from service_base
typedef service_base	t_interface
Protected Member Functions inherited from service_base
	service_base ()
	~service_base ()

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.

Definition at line 39 of file preferences_page.h.

Member Function Documentation

preferences_branch::FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT

(

preferences_branch

)

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 const char* preferences_branch::get_name ( )

pure virtual

Retrieves name of the preferences 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.

---

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

• foobar2000/SDK/preferences_page.h