SDKBrowsePresets Class Reference

#include <lib_browser.h>

Detailed Description

Browse presets.

Note

Has to be created with Alloc() and destroyed with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Public Member Functions
Bool	GetNext (SDKBrowserURL &url, Int32 &plugin_id)

Static Public Member Functions
static SDKBrowsePresets *	Alloc (Int32 db_index)
static void	Free (SDKBrowsePresets *browse_presets)

Private Member Functions
	SDKBrowsePresets ()
	~SDKBrowsePresets ()

Constructor & Destructor Documentation

SDKBrowsePresets()

SDKBrowsePresets ( )

private

~SDKBrowsePresets()

~SDKBrowsePresets ( )

private

Member Function Documentation

Alloc()

static SDKBrowsePresets* Alloc ( Int32  db_index )

static

Allocates a preset browser. Destroy the allocated preset browser with Free(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in]

db_index

The ID of the preset library to browse.

Returns

The allocated preset browser, or nullptr if the allocation failed.

Free()

static void Free ( SDKBrowsePresets *  browse_presets )

static

Destructs reset browsers allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in,out]

browse_presets

The preset browser to destruct. If the pointer is nullptr nothing happens. The pointer is assigned nullptr afterwards.

GetNext()

Bool GetNext	(	SDKBrowserURL &	url,
		Int32 &	plugin_id
	)

Retrieves the next preset.

Parameters

[out]	url	Assigned the URL of the preset.
[out]	plugin_id	Assigned the ID of the plugin that created the preset.

Returns

true if a new preset was retrieved, otherwise false.