SDKBrowserPluginInterface Class Reference

#include <lib_browser.h>

SDKBrowserTab
enum	{   PreviewTab,   InfoTab,   PrivateTab0,   PrivateTab1,   PrivateTab2,   PrivateTab3,   PrivateTab4,   PrivateTab5,   PrivateTab6,   PrivateTab7 }

SDKBrowserItemType
enum	{   BasicItemType,   SpecificItemType,   HierarchicalItemType }

SDKBrowserIdentification
enum	{ SlowIdentification }

SDKBrowserOpen
enum	{ Merge }

Alloc
static SDKBrowserPluginRef	Alloc (SDKBrowserPluginInterfaceInfo *plugin_info)
static void	Free (SDKBrowserPluginRef &plugin)

Plugin ID
Int32	GetPluginID (String *plugin_name=0) const

Identify
Bool	Identify (const SDKBrowserURL &url, UChar *probe, Int32 size, UInt32 flags)

Types
String	GetTypeName (const SDKBrowserContentNodeRef node, const SDKBrowserURL *url, Int32 mode)
void	GetTypeNames (Int32 mode, maxon::BaseArray< String > &strings)

Preview Bitmap
SDKBrowserPreviewData *	OpenPreviewBitmap (BaseThread *thread, const SDKBrowserContentNodeRef node, const SDKBrowserURL *url, SDKBrowserPreviewInfo *info)
void	ClosePreviewBitmap (SDKBrowserPreviewData *data)
BaseBitmap *	GetPreviewBitmap (SDKBrowserPreviewData *data, Int32 w, Int32 h, Int32 quality)

Preview Dialog
SubDialog *	OpenPreviewDialog (SDKBrowserContentNodeRef node, Int32 tab_id)
Int32	ClosePreviewDialog (SDKBrowserContentNodeRef node, SubDialog *s)
Int32	UpdatePreviewDialog (SDKBrowserContentNodeRef node, SubDialog *s)

Open
Bool	Open (SDKBrowserContentNodeRef node, const SDKBrowserURL *url, Int32 flags)

Icon
SDKBrowserIcon *	GetIcon (const SDKBrowserURL &url, Int32 pref_wh=0)

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
PreviewTab	Preview tab.
InfoTab	Info tab.
PrivateTab0	Plugin specific tab 0.
PrivateTab1	Plugin specific tab 1.
PrivateTab2	Plugin specific tab 2.
PrivateTab3	Plugin specific tab 3.
PrivateTab4	Plugin specific tab 4.
PrivateTab5	Plugin specific tab 5.
PrivateTab6	Plugin specific tab 6.
PrivateTab7	Plugin specific tab 7.

anonymous enum

anonymous enum

Enumerator
BasicItemType	The basic item type (i.e. image, or sound file); this string is language dependent.
SpecificItemType	More specific item type, like "JPEG image file"; this string is language dependent.
HierarchicalItemType	Hierarchical item type.

anonymous enum

anonymous enum

Enumerator
SlowIdentification	You are allowed to try the best possible identification, even if it is slow.

anonymous enum

anonymous enum

Enumerator
Merge	Merge nodes.

Member Function Documentation

Alloc()

static SDKBrowserPluginRef Alloc ( SDKBrowserPluginInterfaceInfo *  plugin_info )

static

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

Parameters

[in]

plugin_info

The browser plugin interface information to use for the allocation.

Returns

The allocated browser plugin interface, or nullptr if the allocation failed.

Free()

static void Free ( SDKBrowserPluginRef &  plugin )

static

Destructs browser plugin interfaces allocated with Alloc(). Use AutoAlloc to automate the allocation and destruction based on scope.

Parameters

[in,out]

plugin

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

GetPluginID()

Int32 GetPluginID

(

String *

plugin_name = 0

)

const

Returns SDKBrowserPluginInterfaceInfo::GetPluginID(plugin_name) for the plugin.

Identify()

Bool Identify	(	const SDKBrowserURL &	url,
		UChar *	probe,
		Int32	size,
		UInt32	flags
	)

Returns SDKBrowserPluginInterfaceInfo::Identify(url, probe, size, flags) for the plugin.

GetTypeName()

String GetTypeName	(	const SDKBrowserContentNodeRef	node,
		const SDKBrowserURL *	url,
		Int32	mode
	)

Returns SDKBrowserPluginInterfaceInfo::GetTypeName(node, url, mode) for the plugin.

GetTypeNames()

void GetTypeNames	(	Int32	mode,
		maxon::BaseArray< String > &	strings
	)

Returns SDKBrowserPluginInterfaceInfo::GetTypeNames(mode, strings) for the plugin.

OpenPreviewBitmap()

SDKBrowserPreviewData* OpenPreviewBitmap	(	BaseThread *	thread,
		const SDKBrowserContentNodeRef	node,
		const SDKBrowserURL *	url,
		SDKBrowserPreviewInfo *	info
	)

Returns SDKBrowserPluginInterfaceInfo::OpenPreviewBitmap(thread, node, url, info) for the plugin.

ClosePreviewBitmap()

void ClosePreviewBitmap

(

SDKBrowserPreviewData *

data

)

Returns SDKBrowserPluginInterfaceInfo::ClosePreviewBitmap(data) for the plugin.

GetPreviewBitmap()

BaseBitmap* GetPreviewBitmap	(	SDKBrowserPreviewData *	data,
		Int32	w,
		Int32	h,
		Int32	quality
	)

Returns SDKBrowserPluginInterfaceInfo::GetPreviewBitmap(data, w, h, quality) for the plugin.

OpenPreviewDialog()

SubDialog* OpenPreviewDialog	(	SDKBrowserContentNodeRef	node,
		Int32	tab_id
	)

Returns SDKBrowserPluginInterfaceInfo::OpenPreviewDialog(node, tab_id) for the plugin.

ClosePreviewDialog()

Int32 ClosePreviewDialog	(	SDKBrowserContentNodeRef	node,
		SubDialog *	s
	)

Returns SDKBrowserPluginInterfaceInfo::ClosePreviewDialog(node, s) for the plugin.

UpdatePreviewDialog()

Int32 UpdatePreviewDialog	(	SDKBrowserContentNodeRef	node,
		SubDialog *	s
	)

Returns SDKBrowserPluginInterfaceInfo::UpdatePreviewDialog(node, s) for the plugin.

Open()

Bool Open	(	SDKBrowserContentNodeRef	node,
		const SDKBrowserURL *	url,
		Int32	flags
	)

Returns SDKBrowserPluginInterfaceInfo::UpdatePreviewDialog(node, url, flags) for the plugin.

GetIcon()

SDKBrowserIcon* GetIcon	(	const SDKBrowserURL &	url,
		Int32	pref_wh = 0
	)

Returns SDKBrowserPluginInterfaceInfo::GetIcon(url, pref_wh) for the plugin.