#include <preferences_page.h>

Inheritance diagram for preferences_branch_impl:

Public Member Functions
	preferences_branch_impl (const GUID &p_guid, const GUID &p_parent, const char *p_name, double p_sort_priority=0)

GUID	get_guid ()

const char *	get_name ()

GUID	get_parent_guid ()

double	get_sort_priority ()

Public Member Functions inherited from preferences_branch_v2
	FB2K_MAKE_SERVICE_INTERFACE (preferences_branch_v2, preferences_branch)

Public Member Functions inherited from preferences_branch
	FB2K_MAKE_SERVICE_INTERFACE_ENTRYPOINT (preferences_branch)

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

Private Attributes
const GUID	m_guid

const pfc::string8	m_name

const GUID	m_parent

const double	m_sort_priority

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

Definition at line 60 of file preferences_page.h.

Constructor & Destructor Documentation

preferences_branch_impl::preferences_branch_impl	(	const GUID &	p_guid,
		const GUID &	p_parent,
		const char *	p_name,
		double	p_sort_priority = `0`
	)

inline

Definition at line 62 of file preferences_page.h.

62 : m_guid(p_guid), m_parent(p_parent), m_name(p_name), m_sort_priority(p_sort_priority) {}

preferences_branch_impl::m_guid

const GUID m_guid

Definition: preferences_page.h:68

preferences_branch_impl::m_parent

const GUID m_parent

Definition: preferences_page.h:68

preferences_branch_impl::m_name

const pfc::string8 m_name

Definition: preferences_page.h:69

preferences_branch_impl::m_sort_priority

const double m_sort_priority

Definition: preferences_page.h:70

Member Function Documentation

GUID preferences_branch_impl::get_guid ( )

inlinevirtual

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

Implements preferences_branch.

Definition at line 64 of file preferences_page.h.

64 {return m_guid;}

preferences_branch_impl::m_guid

const GUID m_guid

Definition: preferences_page.h:68

const char* preferences_branch_impl::get_name ( )

inlinevirtual

Retrieves name of the preferences branch.

Implements preferences_branch.

Definition at line 63 of file preferences_page.h.

63 {return m_name;}

preferences_branch_impl::m_name

const pfc::string8 m_name

Definition: preferences_page.h:69

GUID preferences_branch_impl::get_parent_guid ( )

inlinevirtual

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.

Implements preferences_branch.

Definition at line 65 of file preferences_page.h.

65 {return m_parent;}

preferences_branch_impl::m_parent

const GUID m_parent

Definition: preferences_page.h:68

double preferences_branch_impl::get_sort_priority ( )

inlinevirtual

Allows custom sorting order of preferences pages. Return lower value for higher priority (lower resulting index in the list). When sorting priority of two items matches, alphabetic sorting is used. Return 0 to use default alphabetic sorting without overriding priority.

Reimplemented from preferences_branch_v2.

Definition at line 66 of file preferences_page.h.

66 {return m_sort_priority;}

preferences_branch_impl::m_sort_priority

const double m_sort_priority

Definition: preferences_page.h:70